Index

DKDatastoreDefOD

Purpose:

DKDatastoreDefOD is a subclass of dkDatastoreDef which provides the actual functions to access and manipulate Content Manager datastore metadata, such as the creation and deletion of index-classes, attributes, listing them, and so forth.

Class summary:

class DKEXPORT DKDatastoreDefOD: public dkDatastoreDef
{  
public:
     DKDatastoreDefOD(dkDatastore* ds);
     DKDatastoreDefOD(dkDatastore* ds, PAppGrpSchemaOD* agSchema, PFolderSchemaOD* fldSchema);
     ~DKDatastoreDefOD();
 
     dkEntityDef* createEntity();
     dkEntityDef* getEntity(const char* entityName);
     dkCollection* listEntities();
     DKString* listEntityNames(long& arraySize);
     dkCollection* listSearchableEntities(int type);
     dkCollection* listEntityAttrs(const char* entityName);
     DKString* listEntityAttrNames(const char* entityName, long& arraySize);
     void add(dkEntityDef* entityObj);
     void del(dkEntityDef* entityObj);
     dkDatastoreAdmin* datastoreAdmin();
     dkCollection* listAttrs();
     DKString* listAttrNames(long& arraySize);
     dkAttrDef* createAttr();
     void addAttr(dkAttrDef* attrObj);
     void delAttr(dkAttrDef* attrObj);
     long getNumFolders();
     dkCollection* listSearchTemplateFields(const char* folder);
     dkCollection* listSearchTemplates();
     dkCollection* listFolders();
};

Members:

Constructors and destructor
DKDatastoreAdminOD provides three constructors.
DKDatastoreDefOD(dkDatastore* ds);
DKDatastoreDefOD(dkDatastore* ds, PAppGrpSchemaOD* agSchema, PFolderSchemaOD* fldSchema);
~DKDatastoreDefOD();
 
 

Member functions

createEntity
Creates a DKAppGrpDefOD object.
   dkEntityDef* createEntity();
 

getEntity
Gets the dkEntityDef object for the given entity name from the persistent datastore.
   Exceptions:
 
DKException -- If the datastore is not connected to the server.
 
dkEntityDef* getEntity(const char* entityName);

listEntities
Gets a list of entities from the persistent datastore.
   Exceptions: 
DKException -- If the datastore is not connected to the server.
 
dkCollection* listEntities();
 

listEntityNames
Gets a list of entity names from the persistent datastore.
   Exceptions:DKException -- If the datastore is not connected to the server.
 
 
DKString* listEntityNames(long& arraySize);

listSearchableEntities
Gets a list of folders/applgrps from the persistent datastore.
   Exceptions:
DKException -- If the datastore is not connected to the server.
 
 
dkCollection* listSearchableEntities(int type);

listEntityAttrs
Gets a list of attributes for a given entity name.
   Exceptions:
 
DKException -- If the entity (OD folder or application group) name does not exist. 
 
DKException -- If the datastore is not connected to the server.
 
 
dkCollection* listEntityAttrs(const char* entityName);

listEntityAttrNames
Gets a list of attribute names for a given entity name.
   Exceptions:
 
DKException -- If the index-class name does not exist. 
 
 
DKString* listEntityAttrNames(const char* entityName, long& arraySize);
 
 

add
This function is not supported.
 
void add(dkEntityDef* entityObj);
 
 

del
This function is not supported.
   
void del(dkEntityDef* entityObj);
 
 

datastoreAdmin
Get a datastore administration object for a datastore.
   
dkDatastoreAdmin* datastoreAdmin();
 
 

createAttr
Creates a new dkAttrDef.
   
dkAttrDef* createAttr();
 
 

listAttrs
This function is not supported.
   
dkCollection* listAttrs();
 
 

listAttrNames
This function is not supported.
   
DKString* listAttrNames(long& arraySize);
 
 

addAttr
This function is not supported.
   
void addAttr(dkAttrDef* attrObj);
 
 

delAttr
This function is not supported.
   
void delAttr(dkAttrDef* attrObj);
 
 

listSearchTemplates
This function is not supported.
   
dkCollection* listSearchTemplateFields(const char* folder);
 
 

getNumFolders
Retrieves the number of OnDemand folders.
   
long getNumFolders();
 
 

listSearchTemplates
Retrieves the folders from the persistent datastore.
   
dkCollection* listSearchTemplates();
 
 
 
 

listFolders
Retrieves the folders from the persistent datastore.
   
dkCollection* listFolders(); 
 
 

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