Index

DKRoomDefDD

Purpose:

The DKRoomDefDD class defines methods to get Domino.Doc Room information. Access to these objects is through the DKDatastoreDD, listEntities method. Domino.Doc libraries have rooms, which contain cabinets. This class also performs the following functions:

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

Class summary:

class DKRoomDefDD : public DKEntityDefDD
{
  public:
    DKRoomDefDD();
    DKRoomDefDD(dkDatastore* ds);
    DKRoomDefDD( void* libHandle
                  , DKString title
                  , long nbrCabinets
                  , dkDatastore* ds );
 
    ~DKRoomDefDD();
 
    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(long& arraySize);
    DKString toString();
};

Members:

Constructors and destructor
The first constructor constructs a new DKRoomDef class without owner datastore object. The second constructor constructs a new DKRoomDef class with owner datastore object. The third constructor constructs a new DKRoomDefDD with relevant data.
    DKRoomDefDD();
    DKRoomDefDD(dkDatastore* ds);
    DKRoomDefDD( void* libHandle
                  , DKString title
                  , long nbrCabinets
                  , dkDatastore* ds );
 
    ~DKRoomDefDD();
 

Member functions

createAttr
Rooms do not need attributes, so createAttr is not needed and returns null.
    dkAttrDef* createAttr();
 

getAttr
Rooms do not need attributes, so getAttr is not needed and returns null.
    dkAttrDef* getAttr(const char* attrName);
 

isSearchable
Binders are not searchable, so isSearchable always returns false.
    DKBoolean isSearchable();

listAttrs
Rooms do not need attributes, so listAttrs is not needed and returns null.
    dkCollection*  listAttrs();
 

listAttrNames
Rooms do not need attributes, so listAttrNames is not needed and returns null.
    DKString* listAttrNames(long& arraySize);
 

createSubEntity
Creates an entity definition object for a cabinet.
    dkEntityDef* createSubEntity();
 

getSubEntity
Retrieves a cabinet from this room.
    dkEntityDef* getSubEntity(const char* subEntityName);
 

hasSubEntites
Checks if this room has any cabinets in it.
    DKBoolean hasSubEntities();
 

listSubEntities
Gets a list of cabinets for this room.
    dkCollection*  listSubEntities();
 

listSubEntityNames
Gets a list of sub entity names.
    DKString* listSubEntityNames(long& arraySize);
 

toString
Gets a string representation of this object. The string is suitable for debugging purposes.
    DKString toString();
 

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