Index

DKDatastoreDefFed

Purpose:

DKDatastoreDefFed is a subclass of dkDatastoreDef which provides the actual functions to access and manipulate federated datastore meta data, such as the creation and deletion of schema-maps, federated attributes, listing them, and so forth. This class contains DKDatastoreAdminFed class which implements datastore administrative functions to manage federated user IDs, user groups, and passwords.

Class summary:

class DKDatastoreDefFed : public dkDatastoreDef
{
 public:
   DKDatastoreDefFed(dkDatastore* ds);
   virtual ~DKDatastoreDefFed();
   
   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 dkDatastoreAdmin* datastoreAdmin ();
   virtual void add (dkEntityDef* entityDef);
   virtual void del (dkEntityDef* entityDef);
   DKString* listTextEntityNames(long& arraySize);
   DKString* listParmEntityNames(long& arraySize);
   DKString* listEntityNames(const char* nativeServerName, long& arraySize);
   DKString* listNativeEntityNames(const char* fedEntityName, 
                                   const char* serverName, long& arraySize);
   void update (dkEntityDef* entityObj);
   void retrieve (dkEntityDef* entityObj);
   dkSearchTemplate* createSearchTemplate();
   dkSearchTemplate* getSearchTemplate(const char* templateName);
   dkCollection*     listSearchTemplates();
   DKString* listSearchTemplateNames(long& arraySize);
};

Members:

Constructors and destructor
Constructs a new DKDatastoreDefFed object with a given datastore.
DKDatastoreDefFed(dkDatastore* ds);
virtual ~DKDatastoreDefFed();
 

Member functions

createEntity
Creates a DKEntityDef object and returns it.
virtual dkEntityDef* createEntity ();

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

listEntities
Gets the list of mapped federated entities defined in this datastore.
virtual dkCollection* listEntities ();

listEntityNames
The first form gets a list of entity names from the persistent datastore. The second form gets a list of entity names for the specified native server name.
   virtual DKString* listEntityNames (long& arraySize);
   DKString* listEntityNames(const char* nativeServerName, long& arraySize);

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

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

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

add
Adds this given federated schema definition object to the persistent datastore. That is, it adds this group to the federated server.
virtual void add (dkEntityDef* entityDef);

del
Deletes this given federated schema definition object from the persistent federated datastore. It deletes a federated schema from this federated server.
virtual void del (dkEntityDef* entityDef);

listTextEntityNames
Gets a list of text search entity names from the persistent datastore.
DKString* listTextEntityNames(long& arraySize);

listParmEntityNames
Gets a list of parametric-search-entity names from the persistent datastore.
DKString* listParmEntityNames(long& arraySize);

listNativeEntityNames
Gets a list of native entity names for the specified federated entity name.
DKString* listNativeEntityNames(const char* fedEntityName, const char* serverName, long& arraySize);

update
Updates this given federated schema definition object to the persistent federated datastore. It updates a federated schema to this federated server.
void update (dkEntityDef* entityObj);

retrieve
Updates this given federated schema-definition object to the persistent-federated datastore. It updates a federated schema to this federated server.
void retrieve (dkEntityDef* entityObj);

createSearchTemplate
Creates a new search template folder object.
dkSearchTemplate* createSearchTemplate();

getSearchTemplate
Gets the search template object for the given name from persistent datastore.
dkSearchTemplate* getSearchTemplate(const char* templateName);

listSearchTemplates
Gets a list of defined search-template folders from this federated server.
dkCollection* listSearchTemplates();

listSearchTemplateNames
Gets a list of defined search template folders from this federated server.
DKString* listSearchTemplateNames(long& arraySize);

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