|
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.DKDatastoreDL
DKDatastoreDL is the specific version of dkDatastore to implement an IBM Content Manager (Version 7.1 and earlier) datastore. For an IBM Content Manager Version 8 and later datastore, use DKDatastoreICM.
This class provides document, part and folder storage and retrieval mechanisms, as well as search and other document processing capabilities supported by earlier Content Manager.
The execute() and evaluate() methods of DKDatastoreDL take parametric query strings expressed in parametric query language type. The syntax of this query string is described below. DKParametricQuery object accepts queries in this syntax; the DKParametricQuery object delegates the low level query processing tasks to DKDatastoreDL.
By itself, earlier Content Manager only supports parametric queries. Integration with other search engines, such as SearchManager/Text Search Engine or Image Search/QBIC, gives Content Manager the capability to index texts and images and collectively process combined queries. Combined query processing is performed by the DKCombinedQuery class, with the help of the associated datastore classes (DKDatastoreDL, TS, or QBIC, for example).
Content Manager Parametric Query String
The syntax for the query string used in earlier Content Manager parametric queries is as follows:
SEARCH=(INDEX_CLASS=index_class_name, MAX_RESULTS=maximum_results, COND=(conditional_expression) ; ... );option_expression...where the option_expression has the form:
OPTION=(CONTENT=yes_no_attronly, TYPE_QUERY=type_of_query,] TYPE_FILTER=doc_and_or_folder WIPSTATUS=work_in_process_filter, SUSPEND=suspension_status_filter )
DBCS (double-byte character set) attribute names are in SBCS (single-byte character set) single quotes; DBCS (double-byte character set) attribute values can also be specified in SBCS double quotes. All other characters are SBCS.
The parameters include the following:
Logical operators are NOT (or ^), AND (or &), and OR (or |). Relational operators are EQ (or ==), LEQ (or <=), GEQ (or >=), LT (or <), GT (or >), NEQ (or <>), IN, NOTIN, LIKE, NOTLIKE, BETWEEN, and NOTBETWEEN. These last two operators take a pair of attribute values as a range.
An example of a conditional expression is:
(DLSEARCH_Date >= "1990") AND (DLSEARCH_Date <= "1993") AND (DLSEARCH_Volume BETWEEN 1 3)
Attribute names with spaces must be enclosed within single quotes; this also includes DBCS characters. For example:
('last name' == "Smith") AND ('first name' <> "Joe")
Attribute values with DBCS characters must be enclosed within double quotes.
The sequence of INDEX_CLASS, MAX_RESULTS, and COND can be repeated for other index classes to formulate a parametric query using multiple criteria. Each sequence should be separated by a semicolon.
If the user wishes to search for a single quote in a string, the single quote character is specified as follows:
If the user wishes to search for a double quote in a string, the double quote character can be specified in two ways.
For example, content value YES would cause the resulting document or folder DDOs to have their PID, object type, properties and all attributes set. This option also causes the DKParts attribute to be set to a collection of parts with no content. Similarly, the DKFolder attribute is also set to a collection of DDOs with NO content. If the CONTENT value is ATTRONLY, the resulting document or folder DDOs PID, object type, properties, and all attributes are set. If the CONTENT value is NO, the resulting document or folder DDOs PID, object type, and properties are set. The part or DDO content can be retrieved explicitly when needed.
Searches for items removed from a workflow
Searches for compled items in a workflow
Searches for items in a workflow
Searches for items not in a workflow
Searches for items regardless of their work-in-process status. Using this value is equivalent to using all the other values simultaneously. If you specify this value, you cannot specify any other values.
Searches for suspended items
Searches for items that are not suspended
Searches for items regardless of their work-in-process status. Using this value is equivalent to using all the other values simultaneously. If you specify this value, you cannot specify any other values.
Query String Example
Here is a query string to search the index class DLSAMPLE:
SEARCH=(INDEX_CLASS=DLSAMPLE, MAX_RESULTS=5,COND=(DLSEARCH_DocType <> NULL)); OPTION=(CONTENT=NO; TYPE_QUERY=DYNAMIC)
Data Type Conversion
The following table displays the default data type conversions when you
transfer data between an earlier Content Manager server and the EIP APIs and
class library.
EIP type | Content Manager data type |
DKString | VSTRING |
DKString | FSTRING |
short | SHORT |
long | LONG |
DKString | DECIMAL |
DKDate | DATE |
DKTime | TIME |
DKTimestamp | TIMESTAMP |
DKBlob | BLOB (parts) |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL |
For details, see the class or interface |
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.DKMessageIdDL |
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreDL()
Constructs the datastore and initializes the datastore. |
|
DKDatastoreDL(java.lang.String configuration)
Constructs the datastore and initializes the datastore. |
Method Summary | |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Adds a new extension object. |
void |
addObject(dkDataObject ddo)
Adds this data-object to the Content Manager datastore. |
void |
changePassword(java.lang.String userId,
java.lang.String oldPwd,
java.lang.String newPwd)
Changes the library server user password. |
java.lang.String |
checkedOutUserid(dkDataObject dobj)
Lists the user ID who has checked out the document or folder. |
void |
checkIn(dkDataObject dobj)
Checks in a document or folder item from datastore. |
void |
checkOut(dkDataObject dobj)
Checks out a document or folder item from the datastore. |
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 Content Manager 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 Content Manager datastore. |
dkQuery |
createQuery(DKCQExpr qe)
Creates a query object using a DKCQExpr query expression. |
dkQuery |
createQuery(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Creates a query object. |
DKWorkFlowServiceDL |
createWorkFlowService()
Gets the Content Manager work flow service. |
dkDatastoreDef |
datastoreDef()
Gets the datastore definition. |
java.lang.String |
datastoreName()
Gets the name of this datastore object. |
java.lang.String |
datastoreType()
Gets the datastore type for this datastore. |
void |
deleteObject(dkDataObject ddo)
Deletes this data-object from the Content Manger datastore. |
void |
destroy()
Destroys the datastore object. |
void |
disconnect()
Disconnects from a Content Manager datastore. |
java.lang.Object |
evaluate(DKCQExpr qe)
Evaluates the query using a DKCQExpr query expression. |
java.lang.Object |
evaluate(dkQuery query)
Evaluates the query using a dkQuery object. |
java.lang.Object |
evaluate(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Evaluates the query. |
dkResultSetCursor |
execute(DKCQExpr cqe)
Runs a query expression and returns a result set cursor. |
dkResultSetCursor |
execute(dkQuery query)
Runs the query. |
dkResultSetCursor |
execute(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Runs the query. |
void |
executeWithCallback(DKCQExpr qe,
dkCallback callbackObj)
Runs the query with callback function using a DKCQExpr query expression. |
void |
executeWithCallback(dkQuery query,
dkCallback callbackObj)
Runs the query with callback function using a dkQuery object. |
void |
executeWithCallback(java.lang.String command,
short commandLangType,
DKNVPair[] params,
dkCallback callbackObj)
Runs 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)
Gets a mapping information from this datastore. |
java.lang.Object |
getOption(int option)
Gets a datastore option. |
DKHandle |
handle(java.lang.String type)
Gets a datastore handle. |
void |
invokeSearchEngine(java.lang.String searchEngine,
java.lang.String searchIndex)
Invokes a user exit to process search index request. |
boolean |
isCheckedOut(dkDataObject dobj)
Checks whether a document or folder is checked out from datastore. |
boolean |
isConnected()
Checks to see if the datastore is connected. |
java.lang.String[] |
listAttrNames()
Gets a list of attribute names defined in the current datastore. |
dkCollection |
listAttrs()
Gets a list of attributes defined in the current datastore. |
java.lang.String[] |
listDataSourceNames()
Lists the available datastore server names that can be used to connect with. |
dkCollection |
listDataSources()
Lists the available datastores 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 the names of the extension objects. |
java.lang.String[] |
listMappingNames()
Gets the list of the registered mappings from this datastore. |
java.lang.String[] |
listRefFolders(dkDataObject ddo)
Lists the reference folders for a given document or folder. |
java.lang.Object |
listSchema()
Deprecated. Replace by listEntities. |
java.lang.Object |
listSchemaAttributes(java.lang.String schemaEntry)
Deprecated. Replace by listEntityAttributes |
java.lang.Object |
listServers()
Deprecated. Replace by listDataSources. |
void |
moveObject(dkDataObject ddo,
java.lang.String entityName)
Moves the data-object from one index class to another in this datastore. |
java.lang.String |
registerMapping(DKNVPair sourceMap)
Registers a mapping definition to this datastore. |
void |
removeExtension(java.lang.String extensionName)
Removes an existing extension object. |
dkXDO |
retrieveFormOverlay(java.lang.String objid)
Retrieves the form overlay object. |
void |
retrieveObject(dkDataObject ddo)
Retrieves the data-object from the Content Manager datastore. |
void |
rollback()
Rollbacks a datastore transaction. |
void |
setOption(int option,
java.lang.Object value)
Sets a datastore option. |
void |
startTransaction()
Starts a transaction. |
DKHandle |
transactionConnection()
Gets the transaction handle for a datastore. |
DKCQExpr |
translate(DKCQExpr cqe)
Translates a query expression into a native query expression processable by this datastore. |
void |
unlockCheckedOut(dkDataObject dobj)
Unlocks a checked-out document or folder item. |
void |
unRegisterMapping(java.lang.String mappingName)
Unregisters mapping information from this datastore. |
void |
updateObject(dkDataObject ddo)
Updates the data-object in this datastore. |
java.lang.String |
userName()
Gets the user name for this datastore. |
void |
wakeUpService(java.lang.String searchEngine)
Deprecated. Replace by invokeSearchEngine. |
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, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, serviceMgr, 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.dkDatastoreIntDL |
addFolderItem, removeFolderItem |
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, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, serviceMgr, updateObject, updateObject, updateObjects, updateObjects, updateObjects |
Constructor Detail |
public DKDatastoreDL() throws DKException, java.lang.Exception
DKException
- if a problem is encountered.public DKDatastoreDL(java.lang.String configuration) throws DKException, java.lang.Exception
configuration
- configuration string used for initialization.
Valid configuration name/value pairs separated by semi colons.
DKException
- if a problem is encountered.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
- the connect string used for connection. This
is used to provide additional connection options.DKException
- if the connections fails.public void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkDatastore
disconnect
in class dkAbstractDatastore
DKException
- if a problem is encountered.public java.lang.Object getOption(int option) throws DKException, java.lang.Exception
The valid options and values are as follows:
Restriction: for media objects, only the following values
are valid:
DK_DL_RETRIEVAL_GET_IT
DK_DL_RETRIEVAL_STAGE_IT
DK_DL_RETRIEVAL_STAGE_IT_PREFETCH
The valid values for media objects are:
getOption
in interface dkDatastore
getOption
in class dkAbstractDatastore
option
- the option identifierpublic void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
The valid options and values are as follows:
Restriction: for media objects, only the following values
are valid:
DK_DL_RETRIEVAL_GET_IT
DK_DL_RETRIEVAL_STAGE_IT
DK_DL_RETRIEVAL_STAGE_IT_PREFETCH
The valid values for media objects are:
setOption
in interface dkDatastore
setOption
in class dkAbstractDatastore
option
- the option identifiervalue
- the option valuepublic 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
- a query string.commandLang
- a query type.params
- additional query option in the form of a name/value pair.DKException
- if a problem is encountered.public java.lang.Object evaluate(dkQuery query) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
query
- a query objectDKException
- if a problem is encountered.public java.lang.Object evaluate(DKCQExpr qe) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
qe
- a common query expression objectDKException
- if a problem is encountered.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
- a query string.commandLang
- a query type.params
- additional query option in the form of aname/value pair.DKException
- if a problem is encountered.public dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
query
- a query object.DKException
- if a problem is encountered.public dkResultSetCursor execute(DKCQExpr cqe) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
cqe
- a common query expression objectDKException
- if a problem is encountered.public void executeWithCallback(dkQuery query, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
qo
- a query object.callbackObj
- a dkCallback object.DKException
- if a problem is encountered.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 string.commandLang
- a query type.params
- additional query option in the form of a name/value pair.callbackObj
- a dkCallback object.DKException
- if a problem is encountered.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 object.callbackObj
- a dkCallback object.DKException
- if a problem is encountered.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.commandLang
- a query type.params
- additional query option in the form of a name/value pair.DKException
- if a problem is encountered.public dkQuery createQuery(DKCQExpr qe) throws DKException, java.lang.Exception
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
qe
- a common query expression object.DKException
- if a problem is encountered.public void addObject(dkDataObject ddo) throws DKException, java.lang.Exception
addObject
in interface dkDatastore
addObject
in class dkAbstractDatastore
ddo
- the data-object to be added to this datastore.DKException
- if a problem is encountered.DKDDO.add()
public void deleteObject(dkDataObject ddo) throws DKException, java.lang.Exception
deleteObject
in interface dkDatastore
deleteObject
in class dkAbstractDatastore
ddo
- the data-object to be deleted from this datastore.DKException
- if a problem is encountered.DKDDO.del()
public void retrieveObject(dkDataObject ddo) throws DKException, java.lang.Exception
retrieveObject
in interface dkDatastore
retrieveObject
in class dkAbstractDatastore
ddo
- the data-object to be retrieved from this datastore.DKException
- if a problem is encountered.DKDDO.retrieve()
public void updateObject(dkDataObject ddo) throws DKException, java.lang.Exception
updateObject
in interface dkDatastore
updateObject
in class dkAbstractDatastore
ddo
- the data-object to be updated in this datastore.DKException
- if a problem is encountered.DKDDO.update()
public void moveObject(dkDataObject ddo, java.lang.String entityName) throws DKException, java.lang.Exception
moveObject
in interface dkDatastoreIntDL
ddo
- the data-object to be move in this datastore.entityName
- new entity name to move this data-object to.DKException
- if a problem is encountered.public void startTransaction() throws DKException, java.lang.Exception
startTransaction
in interface dkDatastoreIntDL
startTransaction
in class dkAbstractDatastore
DKException
- if a problem is encountered.public void commit() throws DKException, java.lang.Exception
commit
in interface dkDatastore
commit
in class dkAbstractDatastore
DKException
- if a problem is encountered.public void rollback() throws DKException, java.lang.Exception
rollback
in interface dkDatastore
rollback
in class dkAbstractDatastore
DKException
- if a problem is encountered.public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkDatastore
isConnected
in class dkAbstractDatastore
public java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastore
datastoreName
in class dkAbstractDatastore
public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastore
datastoreType
in class dkAbstractDatastore
public DKHandle connection() throws java.lang.Exception
connection
in interface dkDatastore
connection
in class dkAbstractDatastore
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 DKHandle transactionConnection() throws DKException, java.lang.Exception
transactionConnection
in interface dkDatastoreIntDL
public java.lang.String userName() throws java.lang.Exception
userName
in interface dkDatastore
userName
in class dkAbstractDatastore
public dkCollection listDataSources() throws DKException, java.lang.Exception
listDataSources
in interface dkDatastore
listDataSources
in class dkAbstractDatastore
DKException
- if a problem is encountered.public java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
listDataSourceNames
in interface dkDatastore
listDataSourceNames
in class dkAbstractDatastore
DKException
- if a problem is encountered.public java.lang.Object listServers() throws DKException, java.lang.Exception
listServers
in interface dkDatastore
listServers
in class dkAbstractDatastore
DKException
- if a problem is encountered.listDataSources()
public java.lang.Object listSchema() throws DKUsageError
listSchema
in interface dkDatastore
listSchema
in class dkAbstractDatastore
DKUsageError
- if a problem is encountered.listEntities()
public java.lang.Object listSchemaAttributes(java.lang.String schemaEntry) throws DKUsageError, DKDatastoreAccessError
listSchemaAttributes
in interface dkDatastore
listSchemaAttributes
in class dkAbstractDatastore
schemaEntry
- the name of the schema.DKUsageError
- if a problem is encountered in the call.DKUsageError
- if a problem is encountered accessing the
datastore.listEntityAttrs(java.lang.String)
public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastore
listEntities
in class dkAbstractDatastore
DKException
- if error occurs.public java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in interface dkDatastore
listEntityNames
in class dkAbstractDatastore
DKException
- if error occurs.public dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in interface dkDatastore
listEntityAttrs
in class dkAbstractDatastore
entityName
- name of entity to retrieve attributes for.DKException
- if the entity name does not exist.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 for.DKException
- if the entity name does not exist.public dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in interface dkDatastoreIntDL
DKException
- if the entity name does not exist.public java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in interface dkDatastoreIntDL
DKException
- if the entity name does not exist.public void wakeUpService(java.lang.String searchEngine) throws DKException, java.lang.Exception
wakeUpService
in interface dkDatastoreIntDL
searchEngine
- search engine name (SM).invokeSearchEngine(String,String)
public void invokeSearchEngine(java.lang.String searchEngine, java.lang.String searchIndex) throws DKException, java.lang.Exception
invokeSearchEngine
in interface dkDatastoreIntDL
searchEngine
- search engine name (ie SM or QBIC).searchIndex
- search index (ie TM-TMINDEX or
QBICDB-QBICCAT-QBICSRV).public dkDatastoreDef datastoreDef()
datastoreDef
in interface dkDatastore
datastoreDef
in class dkAbstractDatastore
public DKWorkFlowServiceDL createWorkFlowService() throws DKException, java.lang.Exception
createWorkFlowService
in interface dkDatastoreIntDL
public java.lang.String registerMapping(DKNVPair sourceMap) throws DKException, java.lang.Exception
registerMapping
in interface dkDatastore
registerMapping
in class dkAbstractDatastore
sourceMap
- source name and mapping, a DKNVPair class with the following
possible values:
DKException
- if error occurs.unRegisterMapping(java.lang.String)
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 information.DKException
- if error occurs.registerMapping(com.ibm.mm.sdk.common.DKNVPair)
public java.lang.String[] listMappingNames() throws DKException, java.lang.Exception
listMappingNames
in interface dkDatastore
listMappingNames
in class dkAbstractDatastore
DKException
- if error occurs.registerMapping(com.ibm.mm.sdk.common.DKNVPair)
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 information.DKException
- if error occurs.registerMapping(com.ibm.mm.sdk.common.DKNVPair)
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
- if error occurs.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 object.extensionObj
- the extension object to be set.DKException
- if error occurs.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 removed.DKException
- if error occurs.public java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkDatastore
listExtensionNames
in class dkAbstractDatastore
DKException
- if error occurs.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 create.Flags
- to indicate various options to specify
more detailed characteristics of the DDO to create.
Valid values are: DK_CM_DOCUMENT - to create a
document DDO, DK_CM_FOLDER - to create a folder
DDO. If no flag is supplied (Flags equals zero)
the default will be DK_CM_DOCUMENT.DKException
- if error occurs.public void destroy() throws DKException, java.lang.Exception
destroy
in interface dkDatastore
destroy
in class dkAbstractDatastore
DKException
- if error occurs.public boolean isCheckedOut(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
isCheckedOut
in interface dkDatastoreIntDL
dobj
- data object (document or folder item).DKUsageError
- if an error occurs in the call.DKDatastoreAccessError
- if an error occurs at the datastore.public java.lang.String checkedOutUserid(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
checkedOutUserid
in interface dkDatastoreIntDL
dobj
- data object (document or folder item).DKUsageError
- if an error occurs in the call.DKDatastoreAccessError
- if an error occurs at the datastore.public void unlockCheckedOut(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
unlockCheckedOut
in interface dkDatastoreIntDL
dobj
- data object (document or folder item).DKUsageError
- if an error occurs in the call.DKDatastoreAccessError
- if an error occurs at the datastore.public void checkOut(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
checkOut
in interface dkDatastoreIntDL
dobj
- data object (document or folder item).DKUsageError
- if an error occurs in the call.DKDatastoreAccessError
- if an error occurs at the datastore.public void checkIn(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
checkIn
in interface dkDatastoreIntDL
dobj
- data object (document or folder item).DKUsageError
- if an error occurs in the call.DKDatastoreAccessError
- if an error occurs at the datastore.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
userId
- the library server user ID.oldPwd
- the old password.newPwd
- the new password.DKException
- if an error occurs.public dkXDO retrieveFormOverlay(java.lang.String objid) throws DKException, java.lang.Exception
retrieveFormOverlay
in interface dkDatastoreIntDL
id
- the ID string to retrieve the object.DKException
- if an error occurs.public java.lang.String[] listRefFolders(dkDataObject ddo) throws DKException, java.lang.Exception
listRefFolders
in interface dkDatastoreIntDL
ddo
- the data-object to find folder references for.DKException
- if an error occurs.public DKCQExpr translate(DKCQExpr cqe) throws DKException, java.lang.Exception
cqe
- the input compound query expression.DKException
- if an error occurs.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |