Index

DKCabinetDefDD

Purpose:

The DKCabinetDefDD class defines methods to get Domino.Doc Cabinet information. Access to these objects is through DKRoomDefDD, listSubEntities method. Domino.Doc rooms have cabinets, which contain binders. This class also:

Any method not supported by Domino.Doc in this release will throw a DKMSG_NOTIMP DKUsageError

Class summary:

class DKCabinetDefDD : public DKEntityDefDD
{
  public:
    DKCabinetDefDD();
    DKCabinetDefDD(dkDatastore* ds);
    DKCabinetDefDD( void* libHandle
                  , DKString title
                  , long nbrBinders
                  , dkDatastore* ds );
 
    ~DKCabinetDefDD();
 
    dkAttrDef*     createAttr();
    dkAttrDef*     getAttr(const char* attrName);
    DKBoolean      isSearchable();
    dkCollection*  listAttrs();
    DKString*      listAttrNames(long& arraySize);
    dkEntityDef*   createSubEntity();
    dkEntityDef*   getSubEntity(const char* subEntityName);
    DKBoolean      hasSubEntities();
    dkCollection*  listSubEntities();
    DKString*      listSubEntityNames();
    DKString       toString();
};

Members:

Constructors and destructor
The first constructor constructs a new DKDocumentDef class without owner datastore object. The second constructor constructs a new DKDocumentDef class with owner datastore object. The third constructor constructs a cabinet definition with all known information.
    DKCabinetDefDD();
    DKCabinetDefDD(dkDatastore* ds);
    DKCabinetDefDD( void* libHandle
                  , DKString title
                  , long nbrBinders
                  , dkDatastore* ds );
 
    ~DKCabinetDefDD();
 

Member functions

createAttr
Returns a DKAttrDefDD object with nothing in it.
    dkAttrDef* createAttr();
 

getAttr
Returns a DKAttrDefDD object for a field name. All the profiles for this cabinet are used to search for an attrName by name.
    dkAttrDef* getAttr(const char* attrName);
 

isSearchable
Checks if this cabinet can be searched for documents.
    DKBoolean isSearchable();
 

listAttrs
Gets a list of field names. Returns a collection of DKAttrDefDD objects. Since these are document attributes, not cabinet attributes, there will be no knowledge of the attribute's owner in the returned DKAttrDefDD objects.
    dkCollection*  listAttrs();
 

listAttrNames
Gets a list of attributes. If listAttrs was invoked previously, then the results of that list will be used to derive the list of names. If listAttrs was not invoked previously, then that method will be called and used to derive the list of names. The input arraySize parameter is used to create a new array of DKStrings.
    DKString* listAttrNames(long& arraySize);
 

createSubEntity
Creates a dkEntityDefDD for a binder and returns it.
    dkEntityDef* createSubEntity();
 

getSubEntity
Retrieves a binder from the cabinet. The input subEntityName is a binder title.
    dkEntityDef*   getSubEntity(const char* subEntityName);
 

hasSubEntities
Checks if this cabinet has any binders.
    DKBoolean hasSubEntities();
 

listSubEntities
Gets a list of binders for this cabinet.
    dkCollection*  listSubEntities();
 

listSubEntityNames
Gets a list of binder names.
    DKString* listSubEntityNames();
 

toString
Gets a string representation of this class. (Suitable for debugging purposes.)
    DKString toString();
 

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.