Index

DKDatastoreDefV4

Purpose:

Provides methods to access meta data of the VisualInfo for AS/400 datastore, as well as to create, list, and delete its entities. To access this object, use the DatastoreV4.datastoreDef() method.

Class summary:

class DKDatastoreDefV4 : public dkDatastoreDef
{
  public:
   DKDatastoreDefV4(dkDatastore *ds);
   virtual ~DKDatastoreDefV4();
   virtual dkEntityDef* createEntity();
   virtual dkEntityDef* getEntity(const char* entityName);
   virtual dkCollection* listEntities();
   virtual DKString* listEntityNames(long& arraySize);
   virtual dkCollection* listEntityAttrs(const char* entityName);
   virtual DKString* listEntityAttrNames(const char* entityName,
                                         long& arraySize);
   virtual void add(dkEntityDef* entityDef);
   virtual void del(dkEntityDef* entityDef);
   virtual dkDatastoreAdmin* datastoreAdmin();
   virtual dkAttrDef* createAttr();
   virtual dkCollection* listAttrs();
   virtual DKString* listAttrNames(long& arraySize);
   virtual void addAttr(dkAttrDef* attrDef);
   virtual void delAttr(dkAttrDef* attrDef);
};

Members:

Constructors and destructor
   DKDatastoreDefV4(dkDatastore *ds);
   virtual ~DKDatastoreDefV4();
 

Member functions

createEntity
Creates a proper new entity for this datastore. Returns a dkEntityDef object.
   virtual dkEntityDef* createEntity();
 

getEntity
Gets the dkEntityDef object for the given entity name from the datastore definition.
   virtual dkEntityDef* getEntity(const char* entityName);
 

listEntities
Gets the list of entities defined in this datastore. Returns a collection of dkEntityDef objects.
   virtual dkCollection* listEntities();
 

listEntityNames
Gets the list of entity names defined in this datastore. Returns an array of entity names.
   virtual DKString* listEntityNames(long& arraySize);
 

listEntityAttrs
Gets the list of attributes for a given entity name.
   virtual dkCollection* listEntityAttrs(const char* entityName);
 

listEntityAttrNames
Gets the list of attribute names for a given entity name.
   virtual DKString* listEntityAttrNames(const char* entityName,
                                         long& arraySize);
 

add
Adds the definition of the given entity to the persistent datastore.
   virtual void add(dkEntityDef* entityDef);
 

del
Deletes the definition of the given entity from the persistent datastore.
 virtual void del(dkEntityDef* entityDef);

datastoreAdmin
Gets a datastore administration object from a datastore. This object implements administration functions, for example, creating or deleting users.
   virtual dkDatastoreAdmin* datastoreAdmin();
 

createAttr
Creates new dkAttrDef and returns it to the caller.
   virtual dkAttrDef* createAttr();
 

listAttrs
Gets a list of attributes.
   virtual dkCollection* listAttrs();
 

listAttrNames
Gets a list of attribute names.
   virtual DKString* listAttrNames(long& arraySize);
 

addAttr
Adds the given attribute object to persitent datastore.
   virtual void addAttr(dkAttrDef* attrDef);
 

delAttr
Deletes the given attribute object from persistent datastore.
   virtual void delAttr(dkAttrDef* attrDef);
 

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