Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKDatastoreDD

java.lang.Object
  |
  +--com.ibm.mm.sdk.server.dkAbstractDatastore
        |
        +--com.ibm.mm.sdk.server.DKDatastoreDD
All Implemented Interfaces:
DKConstant, DKConstantDD, dkDatastore, dkDatastoreIntDD, DKMessageId, DKMessageIdDD, dkQueryEvaluator, dkQueryManager, java.io.Serializable

public class DKDatastoreDD
extends dkAbstractDatastore
implements dkDatastoreIntDD, DKConstantDD, DKMessageIdDD, java.io.Serializable

This class can be used to access a Domino.Doc datastore, which is called a "library". Documents are the "smallest" entity stored in a Domino.Doc library. A DD library has entities which have subEntities: A library has Rooms, which have Cabinets, which have Binders, which have Documents. DD attributes are stored in DD Profiles. Cabinets, Binders, and Documents have profiles.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDD
copyright, DK_ACTYPE_DD, DK_DD_APPEND, DK_DD_ATTR, DK_DD_BINDER, DK_DD_BLOB, DK_DD_CABINET, DK_DD_CREATE, DK_DD_CREATE_DATE, DK_DD_DATASTORE_EXT, DK_DD_DEFAULT_MIMETYPE, DK_DD_DLL_NAME, DK_DD_DOC_TYPE, DK_DD_DOCUMENT, DK_DD_DS_API_NAME, DK_DD_DSTYPE, DK_DD_FIELD, DK_DD_FILENAME, DK_DD_KEYWORD, DK_DD_LIBRARY, DK_DD_OPT_CONTENT, DK_DD_OPT_CONTENT_ATTRONLY, DK_DD_OPT_CONTENT_NO, DK_DD_OPT_CONTENT_YES, DK_DD_OPT_LIMIT, DK_DD_OPT_NO_LIMIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES, DK_DD_OPT_SEARCH_OPTION, DK_DD_OPT_SEARCH_OPTION_STEMS, DK_DD_OPT_SEARCH_OPTION_THESAURUS, DK_DD_OPT_SORT_ORDER, DK_DD_OPT_SORT_ORDER_DATE_ASC, DK_DD_OPT_SORT_ORDER_DATE_DES, DK_DD_OPT_SORT_ORDER_SCORES, DK_DD_OVERWRITE, DK_DD_PID_DOC_EXT, DK_DD_PID_DOC_ID, DK_DD_PID_DOC_ID_CNT, DK_DD_PROFILE, DK_DD_ROOM, DK_DD_SERVER_TYPE, DK_DD_TITLE, DK_DD_UNKNOWN
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDD
copyright, DK_DD_MSG_MSGID_DOMDOC, DK_DD_MSG_MSGID_GOVERNOR, DK_DD_MSG_MSGID_NO_ATTR_OBJ, DK_DD_MSG_MSGID_NO_BINDER_OBJ, DK_DD_MSG_MSGID_NO_CABINET_OBJ, DK_DD_MSG_MSGID_NO_DOCUMENT_OBJ, DK_DD_MSG_MSGID_NO_MESSAGE, DK_DD_MSG_MSGID_NO_ROOM_OBJ, DK_DD_MSG_MSGID_NO_SUCCESS, DK_DD_MSG_MSGID_NUL_PARAM
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatastoreDD()
           
DKDatastoreDD(java.lang.String configuration)
           
 
Method Summary
 void addExtension(java.lang.String extensionName, dkExtension extensionObj)
          Adds a new extension object.
 void addObject(dkDataObject ddo)
          Not supported in this release.
 void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd)
          Not supported in this release
 void commit()
          Not supported in this release
 void connect(java.lang.String datastore_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string)
          Connects to a Domino.Doc datastore.
 DKHandle connection()
          Gets the connection handle for a datastore
 DKDDO copyDDO(DKDDO ddo, DKDDO pNewDDO)
           
 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 qExpr)
          Creates a parametric query object
 dkQuery createQuery(java.lang.String command, short commandLangType, DKNVPair[] params)
          Creates a parametric query object.
 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)
          Not supported in this release.
 void destroy()
          destroy() method is in the Domino.Doc connector for consistency with the DL connector.
 void disconnect()
          Disconnects from a Domino.Doc datastore.
 java.lang.Object evaluate(DKCQExpr queryExpression)
          Execute a DKCQexpr (query expression)
 java.lang.Object evaluate(dkQuery query)
          Retrieve a collection of documents resulting from running the query contained in the dkQuery.
 java.lang.Object evaluate(java.lang.String command, short commandLangType, DKNVPair[] params)
          Retrieve a collection of documents resulting from running the query contained in the query string.
 dkResultSetCursor execute(DKCQExpr qe)
          executes the query.
 dkResultSetCursor execute(dkQuery query)
          executes the query.
 dkResultSetCursor execute(java.lang.String command, short commandLangType, DKNVPair[] params)
          Retrieve a collection of documents resulting from running the query contained in the query string.
 void executeWithCallback(DKCQExpr qe, dkCallback callbackObj)
          execute the query with callback function.
 void executeWithCallback(dkQuery query, 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 defined datastore option.
 DKHandle handle(java.lang.String type)
          Gets a datastore handle
 boolean isConnected()
          Checks to see if the Domino.Doc connection was successful.
 java.lang.String[] listDataSourceNames()
          Not supported for Domino.Doc...
 dkCollection listDataSources()
          Not supported for Domino.Doc...
 dkCollection listEntities()
          Gets a list of Rooms from a DomDoc library
 java.lang.String[] listEntityAttrNames(java.lang.String entityName)
          listEntityAttrNames for a Domino.Doc datastore returns null, because there are no profile objects for a library.
 dkCollection listEntityAttrs(java.lang.String entityName)
          listEntityAttrs for a Domino.Doc datastore returns a list Document attributes for a given cabinet.
 java.lang.String[] listEntityNames()
          Gets a list of Rooms' names from a DomDoc library
 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
 dkCollection listSearchableEntities()
          Gets a list of Cabinets from a DomDoc library
 java.lang.String[] listSearchableEntityNames()
          Gets a list of Cabinets' names from a DomDoc library
 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 rollback()
          Not supported in this release
 void setOption(int option, java.lang.Object value)
          Sets an option which will influence behavior of called methods.
 java.lang.String translate(DKCQExpr cqe)
          Translate a compound, query expression into a native query
 void unRegisterMapping(java.lang.String mappingName)
          Unregisters mapping information for this datastore
 void updateObject(dkDataObject ddo)
          Not supported in this release.
 java.lang.String userName()
          Gets the user name for this datastore object
 
Methods inherited from class com.ibm.mm.sdk.server.dkAbstractDatastore
addObject, addObject, addObjects, addObjects, addObjects, clearCache, clearCache, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, evaluate, execute, executeWithCallback, listAvailableServices, listSchema, listSchemaAttributes, listSearchTemplateNames, listSearchTemplates, listServers, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, serviceMgr, startTransaction, updateObject, updateObject, updateObjects, updateObjects, updateObjects
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkDatastore
addObject, addObject, addObjects, addObjects, addObjects, clearCache, clearCache, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, evaluate, execute, executeWithCallback, listAvailableServices, listSchema, listSchemaAttributes, listSearchTemplateNames, listSearchTemplates, listServers, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, serviceMgr, startTransaction, updateObject, updateObject, updateObjects, updateObjects, updateObjects
 

Constructor Detail

DKDatastoreDD

public DKDatastoreDD()
              throws DKException,
                     java.lang.Exception

DKDatastoreDD

public DKDatastoreDD(java.lang.String configuration)
              throws DKException,
                     java.lang.Exception
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 Domino.Doc datastore.
Specified by:
connect in interface dkDatastore
Overrides:
connect in class dkAbstractDatastore
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 - is ignored for a Domino.Doc connection
Throws:
DKException -  
java.lang.Exception -  

disconnect

public void disconnect()
                throws DKException,
                       java.lang.Exception
Disconnects from a Domino.Doc datastore.
Specified by:
disconnect in interface dkDatastore
Overrides:
disconnect in class dkAbstractDatastore
Throws:
DKException -  
java.lang.Exception -  

getOption

public java.lang.Object getOption(int option)
                           throws DKException,
                                  java.lang.Exception
Gets defined datastore option.
Specified by:
getOption in interface dkDatastore
Overrides:
getOption in class dkAbstractDatastore
Parameters:
option - an int identifier.
Returns:
the value for the given option.
See Also:
DKConstantDD

setOption

public void setOption(int option,
                      java.lang.Object value)
               throws DKException,
                      java.lang.Exception
Sets an option which will influence behavior of called methods.
Specified by:
setOption in interface dkDatastore
Overrides:
setOption in class dkAbstractDatastore
Parameters:
option - is the int which identifies the option you are setting.
value - is the option value.
See Also:
DKConstantDD, DKConstant

evaluate

public java.lang.Object evaluate(java.lang.String command,
                                 short commandLangType,
                                 DKNVPair[] params)
                          throws DKException,
                                 java.lang.Exception
Retrieve a collection of documents resulting from running the query contained in the query string. The query string is sent to Domino.Doc as is. The query options, set previously with setOption, are used. This method calles the execute method.
Specified by:
evaluate in interface dkDatastore
Overrides:
evaluate in class dkAbstractDatastore
Parameters:
command - is formatted as follows:

"ENTITY=<"cabinetTitle"> QUERY=<"lotusQueryString">"

ENTITY=must be the first word in the query string if you want to limit the query to searching just one cabinet. If the ENTITY parameter and value is missing, then the entire library is searched. Cabinet titles must be enclosed in double quotes, e.g., "Diane Cabinet". QUERY= is required. It is a Lotus Query String. Refer to the FTSearch method in Lotus Notes for information about the syntax of the .

commandLang - is ignored.
params - is optional. These are the same options set with the setOption method of this class.
Returns:
a DKResult object.
Throws:
DKException -  
java.lang.Exception -  
See Also:
DKResult, setOption(int, java.lang.Object), execute(String, short, DKNVPair[])

evaluate

public java.lang.Object evaluate(dkQuery query)
                          throws DKException,
                                 java.lang.Exception
Retrieve a collection of documents resulting from running the query contained in the dkQuery. The query string is sent to Domino.Doc as is. The query options, set previously with setOption, are used.

see evaluate( String ) method for rules regarding the query string.

This method calles the execute method.

Specified by:
evaluate in interface dkDatastore
Overrides:
evaluate in class dkAbstractDatastore
Parameters:
commandLang - is ignored.
params - is optional. These are the same options set with the setOption method of this class.
Returns:
a DKResult object.
Throws:
DKException -  
java.lang.Exception -  
See Also:
DKResult, setOption(int, java.lang.Object), execute(String, short, DKNVPair[])

evaluate

public java.lang.Object evaluate(DKCQExpr queryExpression)
                          throws DKException,
                                 java.lang.Exception
Execute a DKCQexpr (query expression)
Specified by:
evaluate in interface dkDatastore
Overrides:
evaluate in class dkAbstractDatastore
Parameters:
queryExpression - is a container for various query sub-objects.
See Also:
DKCQExpr

execute

public dkResultSetCursor execute(java.lang.String command,
                                 short commandLangType,
                                 DKNVPair[] params)
                          throws DKException,
                                 java.lang.Exception
Retrieve a collection of documents resulting from running the query contained in the query string. The query string is sent to Domino.Doc as is. The query options, set previously with setOption, are used.
Specified by:
execute in interface dkDatastore
Overrides:
execute in class dkAbstractDatastore
Parameters:
command - is a Lotus query string. Refer to the FTSearch method in Lotus Notes for information about the syntax of the search string.
commandLang - is ignored.
params - is optional. These are the same options set with the setOption method of this class.
See Also:
setOption(int, java.lang.Object)

execute

public dkResultSetCursor execute(dkQuery query)
                          throws DKException,
                                 java.lang.Exception
executes the query.
Specified by:
execute in interface dkDatastore
Overrides:
execute in class dkAbstractDatastore
Parameters:
query - a query object
Returns:
resultSetCursor which represents a datastore cursor.
See Also:
dkQuery

execute

public dkResultSetCursor execute(DKCQExpr qe)
                          throws DKException,
                                 java.lang.Exception
executes the query.
Specified by:
execute in interface dkDatastore
Overrides:
execute in class dkAbstractDatastore
Parameters:
qe - a common query expression object
Returns:
resultSetCursor which represents a datastore cursor.
Throws:
DKException -  
java.lang.Exception -  

executeWithCallback

public void executeWithCallback(dkQuery query,
                                dkCallback callbackObj)
                         throws DKException,
                                java.lang.Exception
execute the query with callback function.
Specified by:
executeWithCallback in interface dkDatastore
Overrides:
executeWithCallback in class dkAbstractDatastore
Parameters:
qo - a query object
callbackObj - a dkCallback object
Throws:
DKException -  
java.lang.Exception -  

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.
Specified by:
executeWithCallback in interface dkDatastore
Overrides:
executeWithCallback in class dkAbstractDatastore
Parameters:
command - a query string
commandLang - a query type
params - additional query option in name/value pair
callbackObj - a dkCallback object
Throws:
DKException -  
java.lang.Exception -  

executeWithCallback

public void executeWithCallback(DKCQExpr qe,
                                dkCallback callbackObj)
                         throws DKException,
                                java.lang.Exception
execute the query with callback function.
Specified by:
executeWithCallback in interface dkDatastore
Overrides:
executeWithCallback in class dkAbstractDatastore
Parameters:
qe - a common query expression object
callbackObj - a dkCallback object
Throws:
DKException -  
java.lang.Exception -  

createQuery

public dkQuery createQuery(java.lang.String command,
                           short commandLangType,
                           DKNVPair[] params)
                    throws DKException,
                           java.lang.Exception
Creates a parametric query object.
Specified by:
createQuery in interface dkDatastore
Overrides:
createQuery in class dkAbstractDatastore
Parameters:
command - a query string suitable for Lotus. See Lotus Notes FTSearch method. An example can be found in the TEvaluateDD sample program.
commandLang - a query type. This should be DK_CM_PARAMETRIC_QL_TYPE. Any other type will cause an exception to be thrown.
params - additional query option in name/value pair.
Returns:
a DKParametricQuery object
See Also:
DKParametricQuery

createQuery

public dkQuery createQuery(DKCQExpr qExpr)
                    throws DKException,
                           java.lang.Exception
Creates a parametric query object

This method can handle parametric queries only. It will generate a DKParametricQuery which contains a Lotus Notes query. If some the translation from query expression to Lotus Notes query string has a problem, then an exception is thrown.

Specified by:
createQuery in interface dkDatastore
Overrides:
createQuery in class dkAbstractDatastore
Parameters:
qe - a common query expression object.
See Also:
DKParametricQuery

retrieveObject

public void retrieveObject(dkDataObject ddo)
                    throws DKException,
                           java.lang.Exception
Retrieves this ddo from this datastore.
Specified by:
retrieveObject in interface dkDatastore
Overrides:
retrieveObject in class dkAbstractDatastore
Parameters:
ddo - the ddo to be retrieved from this datastore
Throws:
DKException -  
java.lang.Exception -  

isConnected

public boolean isConnected()
                    throws java.lang.Exception
Checks to see if the Domino.Doc connection was successful.
Specified by:
isConnected in interface dkDatastore
Overrides:
isConnected in class dkAbstractDatastore
Returns:
true if connected
Throws:
DKException -  
java.lang.Exception -  

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.
Specified by:
datastoreName in interface dkDatastore
Overrides:
datastoreName in class dkAbstractDatastore
Returns:
datastore name
Throws:
DKException -  
java.lang.Exception -  

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the datastore type for this datastore object
Specified by:
datastoreType in interface dkDatastore
Overrides:
datastoreType in class dkAbstractDatastore
Returns:
datastore type
Throws:
DKException -  
java.lang.Exception -  

connection

public DKHandle connection()
                    throws java.lang.Exception
Gets the connection handle for a datastore
Specified by:
connection in interface dkDatastore
Overrides:
connection in class dkAbstractDatastore
Returns:
connection handle
Throws:
DKException -  
java.lang.Exception -  

handle

public DKHandle handle(java.lang.String type)
                throws java.lang.Exception
Gets a datastore handle
Specified by:
handle in interface dkDatastore
Overrides:
handle in class dkAbstractDatastore
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
Specified by:
userName in interface dkDatastore
Overrides:
userName in class dkAbstractDatastore
Returns:
user name
Throws:
DKException -  
java.lang.Exception -  

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
Gets a list of Rooms from a DomDoc library
Specified by:
listEntities in interface dkDatastore
Overrides:
listEntities in class dkAbstractDatastore
Returns:
a collection of DKRoomDefDD objects
Throws:
DKException -  
java.lang.Exception -  

listEntityNames

public java.lang.String[] listEntityNames()
                                   throws DKException,
                                          java.lang.Exception
Gets a list of Rooms' names from a DomDoc library
Specified by:
listEntityNames in interface dkDatastore
Overrides:
listEntityNames in class dkAbstractDatastore
Returns:
an array of entity names
Throws:
DKException -  
java.lang.Exception -  

listSearchableEntities

public dkCollection listSearchableEntities()
                                    throws DKException,
                                           java.lang.Exception
Gets a list of Cabinets from a DomDoc library
Specified by:
listSearchableEntities in interface dkDatastore
Overrides:
listSearchableEntities in class dkAbstractDatastore
Returns:
a collection of DKCabinetDefDD objects
Throws:
DKException -  
java.lang.Exception -  

listSearchableEntityNames

public java.lang.String[] listSearchableEntityNames()
                                             throws DKException,
                                                    java.lang.Exception
Gets a list of Cabinets' names from a DomDoc library
Specified by:
listSearchableEntityNames in interface dkDatastore
Overrides:
listSearchableEntityNames in class dkAbstractDatastore
Returns:
an array of entity names
Throws:
DKException -  
java.lang.Exception -  

listEntityAttrs

public dkCollection listEntityAttrs(java.lang.String entityName)
                             throws DKException,
                                    java.lang.Exception
listEntityAttrs for a Domino.Doc datastore returns a list Document attributes for a given cabinet.
Specified by:
listEntityAttrs in interface dkDatastore
Overrides:
listEntityAttrs in class dkAbstractDatastore
Parameters:
entityName - name of a cabinet
Returns:
a dkCollection of dkAttrDef objects
Throws:
DKException -  
java.lang.Exception -  

listEntityAttrNames

public java.lang.String[] listEntityAttrNames(java.lang.String entityName)
                                       throws DKException,
                                              java.lang.Exception
listEntityAttrNames for a Domino.Doc datastore returns null, because there are no profile objects for a library.
Specified by:
listEntityAttrNames in interface dkDatastore
Overrides:
listEntityAttrNames in class dkAbstractDatastore
Parameters:
entityName - name of entity to retrieve attribute names for
Returns:
an array of attribute names
Throws:
DKException -  
java.lang.Exception -  

datastoreDef

public dkDatastoreDef datastoreDef()
                            throws DKException,
                                   java.lang.Exception
Get datastore definition
Specified by:
datastoreDef in interface dkDatastore
Overrides:
datastoreDef in class dkAbstractDatastore
Returns:
the meta-data (dkDatastoreDef) of this datastore
Throws:
DKException -  
java.lang.Exception -  

registerMapping

public java.lang.String registerMapping(DKNVPair sourceMap)
                                 throws DKException,
                                        java.lang.Exception
Registers mapping information to this datastore
Specified by:
registerMapping in interface dkDatastore
Overrides:
registerMapping in class dkAbstractDatastore
Parameters:
sourceMap - source name and mapping
Returns:
the mapping name for the mapping information
Throws:
DKException -  
java.lang.Exception -  

unRegisterMapping

public void unRegisterMapping(java.lang.String mappingName)
                       throws DKException,
                              java.lang.Exception
Unregisters mapping information for this datastore
Specified by:
unRegisterMapping in interface dkDatastore
Overrides:
unRegisterMapping in class dkAbstractDatastore
Parameters:
mappingName - name of the mapping information
Throws:
DKException -  
java.lang.Exception -  

listMappingNames

public java.lang.String[] listMappingNames()
                                    throws DKException,
                                           java.lang.Exception
Gets the list of the register mappings for this datastore
Specified by:
listMappingNames in interface dkDatastore
Overrides:
listMappingNames in class dkAbstractDatastore
Returns:
an array of register mapping objects' names
Throws:
DKException -  
java.lang.Exception -  

getMapping

public dkSchemaMapping getMapping(java.lang.String mappingName)
                           throws DKException,
                                  java.lang.Exception
Get mapping information for this datastore
Specified by:
getMapping in interface dkDatastore
Overrides:
getMapping in class dkAbstractDatastore
Parameters:
mappingName - name of the mapping information
Returns:
the schema mapping object
Throws:
DKException -  
java.lang.Exception -  

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
Gets the extension object from a given extenstion name.
Specified by:
getExtension in interface dkDatastore
Overrides:
getExtension in class dkAbstractDatastore
Parameters:
extensionName - name of the extension object.
Returns:
extension object.
Throws:
DKException -  
java.lang.Exception -  

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Adds a new extension object.
Specified by:
addExtension in interface dkDatastore
Overrides:
addExtension in class dkAbstractDatastore
Parameters:
extensionName - name of new extension object
extensionObj - the extension object to be set
Throws:
DKException -  
java.lang.Exception -  

removeExtension

public void removeExtension(java.lang.String extensionName)
                     throws DKException,
                            java.lang.Exception
Remove an existing extension object
Specified by:
removeExtension in interface dkDatastore
Overrides:
removeExtension in class dkAbstractDatastore
Parameters:
extensionName - name of extension object to be removed
Throws:
DKException -  
java.lang.Exception -  

listExtensionNames

public java.lang.String[] listExtensionNames()
                                      throws DKException,
                                             java.lang.Exception
Gets the list of extension objects' names
Specified by:
listExtensionNames in interface dkDatastore
Overrides:
listExtensionNames in class dkAbstractDatastore
Returns:
an array of extension objects' names
Throws:
DKException -  
java.lang.Exception -  

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.
Specified by:
createDDO in interface dkDatastore
Overrides:
createDDO in class dkAbstractDatastore
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
Throws:
DKException -  
java.lang.Exception -  

listDataSources

public dkCollection listDataSources()
                             throws DKException,
                                    java.lang.Exception
Not supported for Domino.Doc... List the available datastore sources that can be used to connect with.
Specified by:
listDataSources in interface dkDatastore
Overrides:
listDataSources in class dkAbstractDatastore
Returns:
a collection of server defs
Throws:
DKException -  
java.lang.Exception -  

listDataSourceNames

public java.lang.String[] listDataSourceNames()
                                       throws DKException,
                                              java.lang.Exception
Not supported for Domino.Doc... List the available datastore source names that can be used to connect with. Domino.Doc doesn't do this.
Specified by:
listDataSourceNames in interface dkDatastore
Overrides:
listDataSourceNames in class dkAbstractDatastore
Returns:
an array of server names
Throws:
DKException -  
java.lang.Exception -  

addObject

public void addObject(dkDataObject ddo)
               throws DKException,
                      java.lang.Exception
Not supported in this release.
Specified by:
addObject in interface dkDatastore
Overrides:
addObject in class dkAbstractDatastore
Parameters:
ddo - the document to be added to this datastore
Throws:
DKException - This method throws a DKUsageError
java.lang.Exception -  

deleteObject

public void deleteObject(dkDataObject ddo)
                  throws DKException,
                         java.lang.Exception
Not supported in this release.
Specified by:
deleteObject in interface dkDatastore
Overrides:
deleteObject in class dkAbstractDatastore
Parameters:
ddo - the ddo to be deleted from this datastore
Throws:
DKException -  
java.lang.Exception -  

updateObject

public void updateObject(dkDataObject ddo)
                  throws DKException,
                         java.lang.Exception
Not supported in this release.
Specified by:
updateObject in interface dkDatastore
Overrides:
updateObject in class dkAbstractDatastore
Parameters:
ddo - the ddo to be updated in this datastore
Throws:
DKException -  
java.lang.Exception -  

commit

public void commit()
            throws DKException,
                   java.lang.Exception
Not supported in this release
Specified by:
commit in interface dkDatastore
Overrides:
commit in class dkAbstractDatastore
Throws:
DKException -  
java.lang.Exception -  

rollback

public void rollback()
              throws DKException,
                     java.lang.Exception
Not supported in this release
Specified by:
rollback in interface dkDatastore
Overrides:
rollback in class dkAbstractDatastore
Throws:
DKException -  
java.lang.Exception -  

changePassword

public void changePassword(java.lang.String userId,
                           java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Not supported in this release
Specified by:
changePassword in interface dkDatastore
Overrides:
changePassword in class dkAbstractDatastore
Throws:
DKException -  
java.lang.Exception -  

translate

public java.lang.String translate(DKCQExpr cqe)
                           throws DKException,
                                  java.lang.Exception
Translate a compound, query expression into a native query
Parameters:
cqe - the input compound query expression
Returns:
a translated query expression or null if the expression is invalid

destroy

public void destroy()
             throws DKException,
                    java.lang.Exception
destroy() method is in the Domino.Doc connector for consistency with the DL connector. It doesn't do anything.
Specified by:
destroy in interface dkDatastore
Overrides:
destroy in class dkAbstractDatastore

copyDDO

public DKDDO copyDDO(DKDDO ddo,
                     DKDDO pNewDDO)
              throws DKException,
                     java.lang.Exception

EIP Java APIs

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