Index

DKDatastoreDefDD

Purpose:

This class stores the Domino.Doc datastore meta data and provides methods to access this data.

Class summary:

class DKDatastoreDefDD : public dkDatastoreDef
{
  public:
   DKDatastoreDefDD(dkDatastore *ds);
   virtual ~DKDatastoreDefDD();
 
   virtual dkEntityDef* createEntity();
   virtual dkEntityDef* getEntity(const char* entityName);
   virtual dkCollection* listEntities();
   virtual DKString* listEntityNames(long& arraySize);
   virtual dkCollection* listSearchableEntities();
   virtual DKString* listSearchableEntityNames(long& arraySize);
   dkCollection* searchDocuments( DKString query
                                , DKString cabinetTitle = "" );
   virtual dkCollection* listRooms();
   virtual dkCollection* listCabinets(DKString roomTitle);
   virtual dkCollection* listBinders(DKString cabinetTitle);
   virtual dkCollection* listDocuments(DKString cabinetTitle
                                      ,DKString binderTitle);
   virtual dkCollection* listDocumentProfiles( DKString cabinetTitle );
};

Members:

Constructors and destructor
Constructs and initializes a Domino.Doc datastore definition.
   DKDatastoreDefDD(dkDatastore *ds);
   virtual ~DKDatastoreDefDD();
 

Member functions

createEntity
Creates an entity definition for a room. Returns a new dkEntityDef object.
   virtual dkEntityDef* createEntity();
 

getEntity
Gets a room from a Domino.Doc library.
   virtual dkEntityDef* getEntity(const char* entityName);
 

listEntities
Creates and retrieves a collection of subEntities of this datastore and returns a collection of dkEntityDefs for rooms.
   virtual dkCollection* listEntities();
 

listEntityNames
Gets an array of room names.

Parameters
arraySize -- Used to build the new returned array.

   virtual DKString* listEntityNames(long& arraySize);
 

listSearchableEntities
Creates and retrieves a collection of searchable entities. Returns a collection of dkEntityDefs for cabinets.
   virtual dkCollection* listSearchableEntities();
 

listSearchableEntityNames
Gets an array of cabinet names.

Parameters
arraySize -- Used to build the new returned array.

   virtual DKString* listSearchableEntityNames(long& arraySize);
 

searchDocuments
Searches a Domino.Doc cabinet or library for documents.
   dkCollection* searchDocuments( DKString query
                                , DKString cabinetTitle = "" );
 

listRooms
Gets a list of Rooms from a Domino.Doc library. (Rooms are a subEntity of a Domino.Doc library.)
   virtual dkCollection* listRooms();
 

listCabinets
Gets a list of cabinets from a Domino.Doc library. Cabinets can be searched to get document collections.
   virtual dkCollection* listCabinets(DKString roomTitle);
 

listBinders
Gets a list of binders from a Domino.Doc library.
   virtual dkCollection* listBinders(DKString cabinetTitle);
 

listDocuments
Gets a list of documents from a Domino.Doc library.
   virtual dkCollection* listDocuments(DKString cabinetTitle
                                      ,DKString binderTitle);
 

listDocumentProfiles
Gets a list of document profiles from a Domino.Doc library.
   virtual dkCollection* listDocumentProfiles( DKString 
                                               cabinetTitle );
 

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