|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.server.dkAbstractDatastore | +--com.ibm.mm.sdk.server.DKDatastoreDD
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.
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 |
public DKDatastoreDD() throws DKException, java.lang.Exception
public DKDatastoreDD(java.lang.String configuration) throws DKException, java.lang.Exception
Method Detail |
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
connect
in interface dkDatastore
connect
in class dkAbstractDatastore
datastore_name
- the datastore name used for connectionuser_name
- the user name used for connectionauthentication
- the authentication used for connectionconnect_string
- is ignored for a Domino.Doc connectionDKException
- java.lang.Exception
- public void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkDatastore
disconnect
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in interface dkDatastore
getOption
in class dkAbstractDatastore
option
- an int identifier.DKConstantDD
public void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in interface dkDatastore
setOption
in class dkAbstractDatastore
option
- is the int which identifies the option you are setting.value
- is the option value.DKConstantDD
,
DKConstant
public java.lang.Object evaluate(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
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.DKException
- java.lang.Exception
- DKResult
,
setOption(int, java.lang.Object)
,
execute(String, short, DKNVPair[])
public java.lang.Object evaluate(dkQuery query) throws DKException, java.lang.Exception
see evaluate( String ) method for rules regarding the query string.
This method calles the execute method.
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
commandLang
- is ignored.params
- is optional. These are the same options
set with the setOption method of this class.DKException
- java.lang.Exception
- DKResult
,
setOption(int, java.lang.Object)
,
execute(String, short, DKNVPair[])
public java.lang.Object evaluate(DKCQExpr queryExpression) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
queryExpression
- is a container for various query sub-objects.DKCQExpr
public dkResultSetCursor execute(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
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.setOption(int, java.lang.Object)
public dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
query
- a query objectdkQuery
public dkResultSetCursor execute(DKCQExpr qe) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
qe
- a common query expression objectDKException
- java.lang.Exception
- public void executeWithCallback(dkQuery query, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
qo
- a query objectcallbackObj
- a dkCallback objectDKException
- java.lang.Exception
- public void executeWithCallback(java.lang.String command, short commandLangType, DKNVPair[] params, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value paircallbackObj
- a dkCallback objectDKException
- java.lang.Exception
- public void executeWithCallback(DKCQExpr qe, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
qe
- a common query expression objectcallbackObj
- a dkCallback objectDKException
- java.lang.Exception
- public dkQuery createQuery(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
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.DKParametricQuery
public dkQuery createQuery(DKCQExpr qExpr) throws DKException, java.lang.Exception
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.
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
qe
- a common query expression object.DKParametricQuery
public void retrieveObject(dkDataObject ddo) throws DKException, java.lang.Exception
retrieveObject
in interface dkDatastore
retrieveObject
in class dkAbstractDatastore
ddo
- the ddo to be retrieved from this datastoreDKException
- java.lang.Exception
- public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkDatastore
isConnected
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastore
datastoreName
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastore
datastoreType
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public DKHandle connection() throws java.lang.Exception
connection
in interface dkDatastore
connection
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public DKHandle handle(java.lang.String type) throws java.lang.Exception
handle
in interface dkDatastore
handle
in class dkAbstractDatastore
type
- type of datastore handle wantedpublic java.lang.String userName() throws java.lang.Exception
userName
in interface dkDatastore
userName
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastore
listEntities
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in interface dkDatastore
listEntityNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public dkCollection listSearchableEntities() throws DKException, java.lang.Exception
listSearchableEntities
in interface dkDatastore
listSearchableEntities
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String[] listSearchableEntityNames() throws DKException, java.lang.Exception
listSearchableEntityNames
in interface dkDatastore
listSearchableEntityNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in interface dkDatastore
listEntityAttrs
in class dkAbstractDatastore
entityName
- name of a cabinetDKException
- java.lang.Exception
- public java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in interface dkDatastore
listEntityAttrNames
in class dkAbstractDatastore
entityName
- name of entity to retrieve attribute names forDKException
- java.lang.Exception
- public dkDatastoreDef datastoreDef() throws DKException, java.lang.Exception
datastoreDef
in interface dkDatastore
datastoreDef
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String registerMapping(DKNVPair sourceMap) throws DKException, java.lang.Exception
registerMapping
in interface dkDatastore
registerMapping
in class dkAbstractDatastore
sourceMap
- source name and mappingDKException
- java.lang.Exception
- public void unRegisterMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
unRegisterMapping
in interface dkDatastore
unRegisterMapping
in class dkAbstractDatastore
mappingName
- name of the mapping informationDKException
- java.lang.Exception
- public java.lang.String[] listMappingNames() throws DKException, java.lang.Exception
listMappingNames
in interface dkDatastore
listMappingNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public dkSchemaMapping getMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
getMapping
in interface dkDatastore
getMapping
in class dkAbstractDatastore
mappingName
- name of the mapping informationDKException
- java.lang.Exception
- public dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in interface dkDatastore
getExtension
in class dkAbstractDatastore
extensionName
- name of the extension object.DKException
- java.lang.Exception
- public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in interface dkDatastore
addExtension
in class dkAbstractDatastore
extensionName
- name of new extension objectextensionObj
- the extension object to be setDKException
- java.lang.Exception
- public void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
removeExtension
in interface dkDatastore
removeExtension
in class dkAbstractDatastore
extensionName
- name of extension object to be removedDKException
- java.lang.Exception
- public java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkDatastore
listExtensionNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public DKDDO createDDO(java.lang.String objectType, int Flags) throws DKException, java.lang.Exception
createDDO
in interface dkDatastore
createDDO
in class dkAbstractDatastore
objectType
- the object type you want to createFlags
- 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.DKException
- java.lang.Exception
- public dkCollection listDataSources() throws DKException, java.lang.Exception
listDataSources
in interface dkDatastore
listDataSources
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
listDataSourceNames
in interface dkDatastore
listDataSourceNames
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public void addObject(dkDataObject ddo) throws DKException, java.lang.Exception
addObject
in interface dkDatastore
addObject
in class dkAbstractDatastore
ddo
- the document to be added to this datastoreDKException
- This method throws a DKUsageErrorjava.lang.Exception
- public void deleteObject(dkDataObject ddo) throws DKException, java.lang.Exception
deleteObject
in interface dkDatastore
deleteObject
in class dkAbstractDatastore
ddo
- the ddo to be deleted from this datastoreDKException
- java.lang.Exception
- public void updateObject(dkDataObject ddo) throws DKException, java.lang.Exception
updateObject
in interface dkDatastore
updateObject
in class dkAbstractDatastore
ddo
- the ddo to be updated in this datastoreDKException
- java.lang.Exception
- public void commit() throws DKException, java.lang.Exception
commit
in interface dkDatastore
commit
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public void rollback() throws DKException, java.lang.Exception
rollback
in interface dkDatastore
rollback
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
changePassword
in interface dkDatastore
changePassword
in class dkAbstractDatastore
DKException
- java.lang.Exception
- public java.lang.String translate(DKCQExpr cqe) throws DKException, java.lang.Exception
cqe
- the input compound query expressionpublic void destroy() throws DKException, java.lang.Exception
destroy
in interface dkDatastore
destroy
in class dkAbstractDatastore
public DKDDO copyDDO(DKDDO ddo, DKDDO pNewDDO) throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |