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:
DKDatastoreDefOD(dkDatastore* ds); DKDatastoreDefOD(dkDatastore* ds, PAppGrpSchemaOD* agSchema, PFolderSchemaOD* fldSchema); ~DKDatastoreDefOD();
dkEntityDef* createEntity();
Exceptions: DKException -- If the datastore is not connected to the server. dkEntityDef* getEntity(const char* entityName);
Exceptions: DKException -- If the datastore is not connected to the server. dkCollection* listEntities();
Exceptions:DKException -- If the datastore is not connected to the server. DKString* listEntityNames(long& arraySize);
Exceptions: DKException -- If the datastore is not connected to the server. dkCollection* listSearchableEntities(int type);
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);
Exceptions: DKException -- If the index-class name does not exist. DKString* listEntityAttrNames(const char* entityName, long& arraySize);
void add(dkEntityDef* entityObj);
void del(dkEntityDef* entityObj);
dkDatastoreAdmin* datastoreAdmin();
dkAttrDef* createAttr();
dkCollection* listAttrs();
DKString* listAttrNames(long& arraySize);
void addAttr(dkAttrDef* attrObj);
void delAttr(dkAttrDef* attrObj);
dkCollection* listSearchTemplateFields(const char* folder);
long getNumFolders();
dkCollection* listSearchTemplates();
dkCollection* listFolders();
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.