Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkDatastore

All Superinterfaces:
dkQueryEvaluator, dkQueryManager
All Known Subinterfaces:
dkDatastoreIntDB2, dkDatastoreIntDD, dkDatastoreIntDES, dkDatastoreIntDJ, dkDatastoreIntDL, dkDatastoreIntIC, dkDatastoreIntICM, dkDatastoreIntIP, dkDatastoreIntJDBC, dkDatastoreIntOD, dkDatastoreIntQBIC, dkDatastoreIntTS, dkDatastoreIntV4
All Known Implementing Classes:
dkAbstractDatastore

public interface dkDatastore
extends dkQueryManager

dkDatastore: the following methods are additions or modifications of the existing method in the current implementation of dkDatastore


Method Summary
 void addExtension(java.lang.String extensionName, dkExtension extensionObj)
          Adds a new extension object.
 void addObject(dkDataObject ddo)
          Adds this ddo to this datastore.
 void addObject(dkDataObject ddo, DKNVPair[] options)
          Adds this ddo to this datastore.
 void addObject(dkDataObject ddo, int option)
          Adds this ddo to this datastore.
 void addObjects(dkCollection ddoCollection)
          Adds this collection of ddos to this datastore.
 void addObjects(dkCollection ddoCollection, DKNVPair[] options)
          Adds this collection of ddos to this datastore.
 void addObjects(dkCollection ddoCollection, int option)
          Adds this collection of ddos to this datastore.
 void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd)
          Deprecated. Replace by dkUserManagement.changePassword
 void clearCache()
          Clear datastore cache
 void clearCache(int option)
          Clear datastore cache
 void commit()
          Commits a datastore transaction
 void connect(java.lang.String datastore_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string)
          Connects to a datastore.
 DKHandle connection()
          Gets the connection handle for a datastore
 DKDDO createDDO(java.lang.String objectType, int Flags)
          Creates a new DDO with object type, properties and attributes set for a given backend server.
 dkQuery createQuery(DKCQExpr qe)
          Deprecated. No replacement
 dkQuery createQuery(java.lang.String command, short commandLangType, DKNVPair[] params)
          Deprecated. No replacement
 dkDatastoreDef datastoreDef()
          Get datastore definition
 java.lang.String datastoreName()
          Gets the name of this datastore object.
 java.lang.String datastoreType()
          Gets the datastore type for this datastore object
 void deleteObject(dkDataObject ddo)
          Deletes this ddo from this datastore.
 void deleteObject(dkDataObject ddo, DKNVPair[] options)
          Deletes this ddo from this datastore.
 void deleteObject(dkDataObject ddo, int option)
          Deletes this ddo from this datastore.
 void deleteObjects(dkCollection ddoCollection)
          Deletes this collection of ddos from this datastore.
 void deleteObjects(dkCollection ddoCollection, DKNVPair[] options)
          Deletes this collection of ddos from this datastore.
 void deleteObjects(dkCollection ddoCollection, int option)
          Deletes this collection of ddos from this datastore.
 void destroy()
          datastore destroy - datastore cleanup if needed
 void disconnect()
          Disconnects to a datastore.
 java.lang.Object evaluate(DKCQExpr qe)
          evaluates the query.
 java.lang.Object evaluate(dkQuery query)
          Deprecated. Use other evaluate methods
 java.lang.Object evaluate(dkSearchTemplate st)
          evaluates the search template.
 java.lang.Object evaluate(java.lang.String command, short commandLangType, DKNVPair[] params)
          evaluates the query.
 dkResultSetCursor execute(DKCQExpr qe)
          executes the query.
 dkResultSetCursor execute(dkQuery query)
          Deprecated. Use other execute methods
 dkResultSetCursor execute(dkSearchTemplate st)
          executes the search template.
 dkResultSetCursor execute(java.lang.String command, short commandLangType, DKNVPair[] params)
          executes the query.
 void executeWithCallback(DKCQExpr qe, dkCallback callbackObj)
          execute the query with callback function.
 void executeWithCallback(dkQuery qo, dkCallback callbackObj)
          Deprecated. Use other executeWithCallback methods
 void executeWithCallback(dkSearchTemplate st, dkCallback callbackObj)
          execute the query with callback function.
 void executeWithCallback(java.lang.String command, short commandLangType, DKNVPair[] params, dkCallback callbackObj)
          execute the query with callback function.
 dkExtension getExtension(java.lang.String extensionName)
          Gets the extension object from a given extenstion name.
 dkSchemaMapping getMapping(java.lang.String mappingName)
          Get mapping information for this datastore
 java.lang.Object getOption(int option)
          Gets a datastore option.
 DKHandle handle(java.lang.String type)
          Gets a datastore handle
 boolean isConnected()
          Checks to see if the datastore is connected.
 java.lang.String[] listAvailableServices()
          List available services
 java.lang.String[] listDataSourceNames()
          List the available datastore source names that can be used to connect with.
 dkCollection listDataSources()
          List the available datastore sources that can be used to connect with.
 dkCollection listEntities()
          Gets a list of entities from persistent datastore
 java.lang.String[] listEntityAttrNames(java.lang.String entityName)
          Gets a list of attribute names for a given entity name.
 dkCollection listEntityAttrs(java.lang.String entityName)
          Gets a list of attributes for a given entity name.
 java.lang.String[] listEntityNames()
          Gets a list of entity names from persistent datastore
 java.lang.String[] listExtensionNames()
          Gets the list of extension objects' names
 java.lang.String[] listMappingNames()
          Gets the list of the register mappings for this datastore
 java.lang.Object listSchema()
          Deprecated. Replace by listEntities
 java.lang.Object listSchemaAttributes(java.lang.String schemaEntry)
          Deprecated. Replace by listEntityAttributes
 dkCollection listSearchableEntities()
          Gets a list of searchable entities from persistent datastore
 java.lang.String[] listSearchableEntityNames()
          Gets a list of searchable entity names from persistent datastore
 java.lang.String[] listSearchTemplateNames()
          Gets a list of search template names from persistent datastore
 dkCollection listSearchTemplates()
          Gets a list of search templates from persistent datastore
 java.lang.Object listServers()
          Deprecated. Replace by listDataSources
 java.lang.String registerMapping(DKNVPair sourceMap)
          Registers mapping information to this datastore
 void removeExtension(java.lang.String extensionName)
          Remove an existing extension object
 void retrieveObject(dkDataObject ddo)
          Retrieves this ddo from this datastore.
 void retrieveObject(dkDataObject ddo, DKNVPair[] options)
          Retrieves this ddo from this datastore.
 void retrieveObject(dkDataObject ddo, int option)
          Retrieves this ddo from this datastore.
 void retrieveObjects(dkCollection ddoCollection)
          Retrieves this collection of ddos from this datastore.
 void retrieveObjects(dkCollection ddoCollection, DKNVPair[] options)
          Retrieves this ddo from this datastore.
 void retrieveObjects(dkCollection ddoCollection, int option)
          Retrieves this collection of ddos from this datastore.
 void rollback()
          Rollback a datastore transaction
 dkServiceMgr serviceMgr()
          Gets a service manager
 void setOption(int option, java.lang.Object value)
          Sets a datastore option.
 void startTransaction()
          Starts a transaction
 void unRegisterMapping(java.lang.String mappingName)
          Unregisters mapping information for this datastore
 void updateObject(dkDataObject ddo)
          Updates this ddo in this datastore.
 void updateObject(dkDataObject ddo, DKNVPair[] options)
          Updates this ddo in this datastore.
 void updateObject(dkDataObject ddo, int option)
          Updates this ddo in this datastore.
 void updateObjects(dkCollection ddoCollection)
          Updates this collection of ddos in this datastore.
 void updateObjects(dkCollection ddoCollection, DKNVPair[] options)
          Updates this collection of ddos in this datastore.
 void updateObjects(dkCollection ddoCollection, int option)
          Updates this collection of ddos in this datastore.
 java.lang.String userName()
          Gets the user name for this datastore object
 

Method Detail

connect

public void connect(java.lang.String datastore_name,
                    java.lang.String user_name,
                    java.lang.String authentication,
                    java.lang.String connect_string)
             throws DKException,
                    java.lang.Exception
Connects to a datastore.
Parameters:
datastore_name - the datastore name used for connection
user_name - the user name used for connection
authentication - the authentication used for connection
connect_string - the connect string used for connection. This is used to provide additional connection options.

disconnect

public void disconnect()
                throws DKException,
                       java.lang.Exception
Disconnects to a datastore.

getOption

public java.lang.Object getOption(int option)
                           throws DKException,
                                  java.lang.Exception
Gets a datastore option.
Parameters:
option - the option identifier
Returns:
an option value

setOption

public void setOption(int option,
                      java.lang.Object value)
               throws DKException,
                      java.lang.Exception
Sets a datastore option.
Parameters:
option - the option identifier
value - the option value

evaluate

public java.lang.Object evaluate(java.lang.String command,
                                 short commandLangType,
                                 DKNVPair[] params)
                          throws DKException,
                                 java.lang.Exception
evaluates the query.
Specified by:
evaluate in interface dkQueryEvaluator
Parameters:
command - a query string
commandLang - a query type
params - additional query option in name/value pair
Returns:
a collection of the results

evaluate

public java.lang.Object evaluate(dkQuery query)
                          throws DKException,
                                 java.lang.Exception
Deprecated. Use other evaluate methods

evaluates the query.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
qo - a query object
Returns:
a collection of the results

evaluate

public java.lang.Object evaluate(DKCQExpr qe)
                          throws DKException,
                                 java.lang.Exception
evaluates the query.
Parameters:
qe - a common query expression object
Returns:
a collection of the results

evaluate

public java.lang.Object evaluate(dkSearchTemplate st)
                          throws DKException,
                                 java.lang.Exception
evaluates the search template.

Note: Default behavior will call dkDatastore.evaluate(DKCQExpr)

Parameters:
st - a search template object
Returns:
a collection of the results

execute

public dkResultSetCursor execute(java.lang.String command,
                                 short commandLangType,
                                 DKNVPair[] params)
                          throws DKException,
                                 java.lang.Exception
executes the query.
Parameters:
command - a query string
commandLang - a query type
params - additional query option in name/value pair
Returns:
resultSetCursor which represents a datastore cursor.

execute

public dkResultSetCursor execute(dkQuery query)
                          throws DKException,
                                 java.lang.Exception
Deprecated. Use other execute methods

executes the query.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
qo - a query object
Returns:
resultSetCursor which represents a datastore cursor.

execute

public dkResultSetCursor execute(DKCQExpr qe)
                          throws DKException,
                                 java.lang.Exception
executes the query.
Parameters:
qe - a common query expression object
Returns:
resultSetCursor which represents a datastore cursor.

execute

public dkResultSetCursor execute(dkSearchTemplate st)
                          throws DKException,
                                 java.lang.Exception
executes the search template.

Note: Default behavior will call dkDatastore.execute(DKCQExpr)

Parameters:
st - a search template object
Returns:
resultSetCursor which represents a datastore cursor.

executeWithCallback

public void executeWithCallback(dkQuery qo,
                                dkCallback callbackObj)
                         throws DKException,
                                java.lang.Exception
Deprecated. Use other executeWithCallback methods

execute the query with callback function.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
qo - a query object
callbackObj - a dkCallback object

executeWithCallback

public void executeWithCallback(java.lang.String command,
                                short commandLangType,
                                DKNVPair[] params,
                                dkCallback callbackObj)
                         throws DKException,
                                java.lang.Exception
execute the query with callback function.
Parameters:
command - a query string
commandLang - a query type
params - additional query option in name/value pair
callbackObj - a dkCallback object

executeWithCallback

public void executeWithCallback(DKCQExpr qe,
                                dkCallback callbackObj)
                         throws DKException,
                                java.lang.Exception
execute the query with callback function.
Parameters:
qe - a common query expression object
callbackObj - a dkCallback object

executeWithCallback

public void executeWithCallback(dkSearchTemplate st,
                                dkCallback callbackObj)
                         throws DKException,
                                java.lang.Exception
execute the query with callback function.

Note: Default behavior will call dkDatastore.executeWithCallback(DKCQExpr,dkCallback)

Parameters:
st - a search template object
callbackObj - a dkCallback object

createQuery

public dkQuery createQuery(java.lang.String command,
                           short commandLangType,
                           DKNVPair[] params)
                    throws DKException,
                           java.lang.Exception
Deprecated. No replacement

Creates a query object.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createQuery in interface dkQueryManager
Parameters:
command - a query string
commandLang - a query type
params - additional query option in name/value pair
Returns:
a query object

createQuery

public dkQuery createQuery(DKCQExpr qe)
                    throws DKException,
                           java.lang.Exception
Deprecated. No replacement

Creates a query object.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
qe - a common query expression object

addObject

public void addObject(dkDataObject ddo)
               throws DKException,
                      java.lang.Exception
Adds this ddo to this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be added to this datastore

addObject

public void addObject(dkDataObject ddo,
                      int option)
               throws DKException,
                      java.lang.Exception
Adds this ddo to this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be added to this datastore
option - option for add

addObject

public void addObject(dkDataObject ddo,
                      DKNVPair[] options)
               throws DKException,
                      java.lang.Exception
Adds this ddo to this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be added to this datastore
options - options for add

addObjects

public void addObjects(dkCollection ddoCollection)
                throws DKException,
                       java.lang.Exception
Adds this collection of ddos to this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be added to this datastore

addObjects

public void addObjects(dkCollection ddoCollection,
                       int option)
                throws DKException,
                       java.lang.Exception
Adds this collection of ddos to this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be added to this datastore
option - option for add

addObjects

public void addObjects(dkCollection ddoCollection,
                       DKNVPair[] options)
                throws DKException,
                       java.lang.Exception
Adds this collection of ddos to this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be added to this datastore
options - options for add

deleteObject

public void deleteObject(dkDataObject ddo)
                  throws DKException,
                         java.lang.Exception
Deletes this ddo from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be deleted from this datastore

deleteObject

public void deleteObject(dkDataObject ddo,
                         int option)
                  throws DKException,
                         java.lang.Exception
Deletes this ddo from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be deleted from this datastore
option - option for delete

deleteObject

public void deleteObject(dkDataObject ddo,
                         DKNVPair[] options)
                  throws DKException,
                         java.lang.Exception
Deletes this ddo from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be deleted from this datastore
option - option for delete

deleteObjects

public void deleteObjects(dkCollection ddoCollection)
                   throws DKException,
                          java.lang.Exception
Deletes this collection of ddos from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be deleted from this datastore

deleteObjects

public void deleteObjects(dkCollection ddoCollection,
                          int option)
                   throws DKException,
                          java.lang.Exception
Deletes this collection of ddos from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be deleted from this datastore
option - option for delete

deleteObjects

public void deleteObjects(dkCollection ddoCollection,
                          DKNVPair[] options)
                   throws DKException,
                          java.lang.Exception
Deletes this collection of ddos from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be deleted from this datastore
option - option for delete

retrieveObject

public void retrieveObject(dkDataObject ddo)
                    throws DKException,
                           java.lang.Exception
Retrieves this ddo from this datastore.
Parameters:
ddo - the ddo to be retrieved from this datastore

retrieveObject

public void retrieveObject(dkDataObject ddo,
                           int option)
                    throws DKException,
                           java.lang.Exception
Retrieves this ddo from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be retrieved from this datastore
option - option for retrieve

retrieveObject

public void retrieveObject(dkDataObject ddo,
                           DKNVPair[] options)
                    throws DKException,
                           java.lang.Exception
Retrieves this ddo from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be retrieved from this datastore
options - options for retrieve

retrieveObjects

public void retrieveObjects(dkCollection ddoCollection)
                     throws DKException,
                            java.lang.Exception
Retrieves this collection of ddos from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be retrieved from this datastore

retrieveObjects

public void retrieveObjects(dkCollection ddoCollection,
                            int option)
                     throws DKException,
                            java.lang.Exception
Retrieves this collection of ddos from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be retrieved from this datastore
option - option for retrieve

retrieveObjects

public void retrieveObjects(dkCollection ddoCollection,
                            DKNVPair[] options)
                     throws DKException,
                            java.lang.Exception
Retrieves this ddo from this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be retrieved from this datastore
options - options for retrieve

updateObject

public void updateObject(dkDataObject ddo)
                  throws DKException,
                         java.lang.Exception
Updates this ddo in this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be updated in this datastore

updateObject

public void updateObject(dkDataObject ddo,
                         int option)
                  throws DKException,
                         java.lang.Exception
Updates this ddo in this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be updated in this datastore
option - option for update

updateObject

public void updateObject(dkDataObject ddo,
                         DKNVPair[] options)
                  throws DKException,
                         java.lang.Exception
Updates this ddo in this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddo - the ddo to be updated in this datastore
options - options for update

updateObjects

public void updateObjects(dkCollection ddoCollection)
                   throws DKException,
                          java.lang.Exception
Updates this collection of ddos in this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be updated in this datastore

updateObjects

public void updateObjects(dkCollection ddoCollection,
                          int option)
                   throws DKException,
                          java.lang.Exception
Updates this collection of ddos in this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be updated in this datastore
option - option for update

updateObjects

public void updateObjects(dkCollection ddoCollection,
                          DKNVPair[] options)
                   throws DKException,
                          java.lang.Exception
Updates this collection of ddos in this datastore.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
ddoCollection - the collection of ddos to be updated in this datastore
options - options for update

startTransaction

public void startTransaction()
                      throws DKException,
                             java.lang.Exception
Starts a transaction

Note:DKUsageError exception thrown if method is not implemented


commit

public void commit()
            throws DKException,
                   java.lang.Exception
Commits a datastore transaction

Note:DKUsageError exception thrown if method is not implemented


rollback

public void rollback()
              throws DKException,
                     java.lang.Exception
Rollback a datastore transaction

Note:DKUsageError exception thrown if method is not implemented


isConnected

public boolean isConnected()
                    throws java.lang.Exception
Checks to see if the datastore is connected.
Returns:
true if connected

datastoreName

public java.lang.String datastoreName()
                               throws java.lang.Exception
Gets the name of this datastore object. Usually it represents a datastore source's server name.
Returns:
datastore name

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the datastore type for this datastore object
Returns:
datastore type

connection

public DKHandle connection()
                    throws java.lang.Exception
Gets the connection handle for a datastore

Note:DKUsageError exception thrown if method is not implemented

Returns:
connection handle

handle

public DKHandle handle(java.lang.String type)
                throws java.lang.Exception
Gets a datastore handle

Note:DKUsageError exception thrown if method is not implemented

Parameters:
type - type of datastore handle wanted
Returns:
a datastore handle

userName

public java.lang.String userName()
                          throws java.lang.Exception
Gets the user name for this datastore object
Returns:
user name

listDataSources

public dkCollection listDataSources()
                             throws DKException,
                                    java.lang.Exception
List the available datastore sources that can be used to connect with.
Returns:
a collection of server defs

listDataSourceNames

public java.lang.String[] listDataSourceNames()
                                       throws DKException,
                                              java.lang.Exception
List the available datastore source names that can be used to connect with.
Returns:
an array of server names

listServers

public java.lang.Object listServers()
                             throws DKException,
                                    java.lang.Exception
Deprecated. Replace by listDataSources

List the available datastore sources that can be used to connect with.

Note:DKUsageError exception thrown if method is not implemented

Returns:
a collection of server definitions
See Also:
listDataSources()

listSchema

public java.lang.Object listSchema()
                            throws DKException,
                                   java.lang.Exception
Deprecated. Replace by listEntities

List the entities that belong to this datastore

Note:DKUsageError exception thrown if method is not implemented

Returns:
an object that contains the schema
See Also:
listEntities()

listSchemaAttributes

public java.lang.Object listSchemaAttributes(java.lang.String schemaEntry)
                                      throws DKException,
                                             java.lang.Exception
Deprecated. Replace by listEntityAttributes

List the attributes that belong to a schema.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
schemaEntry - the name of the schema.
Returns:
an object that contains the attributes that belong to this schema
See Also:
listEntityAttrs(java.lang.String)

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
Gets a list of entities from persistent datastore
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listSearchableEntities

public dkCollection listSearchableEntities()
                                    throws DKException,
                                           java.lang.Exception
Gets a list of searchable entities from persistent datastore

Note: Default behavior will call dkDatastore.listEntities()

Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listEntityNames

public java.lang.String[] listEntityNames()
                                   throws DKException,
                                          java.lang.Exception
Gets a list of entity names from persistent datastore
Returns:
an array of entity names
Throws:
DKException - if error occurs

listSearchableEntityNames

public java.lang.String[] listSearchableEntityNames()
                                             throws DKException,
                                                    java.lang.Exception
Gets a list of searchable entity names from persistent datastore

Note: Default behavior will call dkDatastore.listEntityNames()

Returns:
an array of entity names
Throws:
DKException - if error occurs

listEntityAttrs

public dkCollection listEntityAttrs(java.lang.String entityName)
                             throws DKException,
                                    java.lang.Exception
Gets a list of attributes for a given entity name.
Parameters:
entityName - name of entity to retrieve attributes for
Returns:
a dkCollection of dkAttrDef objects
Throws:
DKException - if the entity name does not exist

listEntityAttrNames

public java.lang.String[] listEntityAttrNames(java.lang.String entityName)
                                       throws DKException,
                                              java.lang.Exception
Gets a list of attribute names for a given entity name.
Parameters:
entityName - name of entity to retrieve attribute names for
Returns:
an array of attribute names
Throws:
DKException - if the entity name does not exist

listSearchTemplates

public dkCollection listSearchTemplates()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of search templates from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Returns:
a collection of search templates
Throws:
DKException - if error occurs

listSearchTemplateNames

public java.lang.String[] listSearchTemplateNames()
                                           throws DKException,
                                                  java.lang.Exception
Gets a list of search template names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Returns:
an array of entity names
Throws:
DKException - if error occurs

datastoreDef

public dkDatastoreDef datastoreDef()
                            throws DKException,
                                   java.lang.Exception
Get datastore definition
Returns:
the meta-data (dkDatastoreDef) of this datastore

registerMapping

public java.lang.String registerMapping(DKNVPair sourceMap)
                                 throws DKException,
                                        java.lang.Exception
Registers mapping information to this datastore
Parameters:
sourceMap - source name and mapping
Returns:
the mapping name for the mapping information

unRegisterMapping

public void unRegisterMapping(java.lang.String mappingName)
                       throws DKException,
                              java.lang.Exception
Unregisters mapping information for this datastore
Parameters:
mappingName - name of the mapping information

listMappingNames

public java.lang.String[] listMappingNames()
                                    throws DKException,
                                           java.lang.Exception
Gets the list of the register mappings for this datastore
Returns:
an array of register mapping objects' names

getMapping

public dkSchemaMapping getMapping(java.lang.String mappingName)
                           throws DKException,
                                  java.lang.Exception
Get mapping information for this datastore
Parameters:
mappingName - name of the mapping information
Returns:
the schema mapping object

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
Gets the extension object from a given extenstion name.
Parameters:
extensionName - name of the extension object.
Returns:
extension object.

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Adds a new extension object.
Parameters:
extensionName - name of new extension object
extensionObj - the extension object to be set

removeExtension

public void removeExtension(java.lang.String extensionName)
                     throws DKException,
                            java.lang.Exception
Remove an existing extension object
Parameters:
extensionName - name of extension object to be removed

listExtensionNames

public java.lang.String[] listExtensionNames()
                                      throws DKException,
                                             java.lang.Exception
Gets the list of extension objects' names
Returns:
an array of extension objects' names

createDDO

public DKDDO createDDO(java.lang.String objectType,
                       int Flags)
                throws DKException,
                       java.lang.Exception
Creates a new DDO with object type, properties and attributes set for a given backend server.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
objectType - the object type you want to create
Flags - to indicate various options to specify more detail characteristics of the DDO to create. For example, it may be a directive to create a document DDO, a folder, etc.
Returns:
a new DDO of the given object type with all the properties and attributes set, so that the user only need to set the attribute values

changePassword

public void changePassword(java.lang.String userId,
                           java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Deprecated. Replace by dkUserManagement.changePassword

Allows a user to change password if authorized

Note:DKUsageError exception thrown if method is not implemented

Parameters:
userId - - userid
oldPwd - - old password
newPwd - - new password
See Also:
dkUserManagement.changePassword( java.lang.String, java.lang.String,java.lang.String)

destroy

public void destroy()
             throws DKException,
                    java.lang.Exception
datastore destroy - datastore cleanup if needed

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented


clearCache

public void clearCache(int option)
                throws DKException,
                       java.lang.Exception
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented

Parameters:
option - - clear cache option for selective clearing of cache

serviceMgr

public dkServiceMgr serviceMgr()
                        throws DKException,
                               java.lang.Exception
Gets a service manager
Returns:
the service manager

listAvailableServices

public java.lang.String[] listAvailableServices()
                                         throws DKException,
                                                java.lang.Exception
List available services

Note:DKUsageError exception thrown if method is not implemented

Returns:
a list of service ids

EIP Java APIs

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