|
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.DKDatastoreV4
DKDatastoreV4 is the VI400 implementation of dkDatastore. It provides Documents, Parts, and Folders storage and retrieval mechanisms. It also provides other document processing capabilities supported by the VI400.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantV4 |
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.DKMessageIdV4 |
copyright, DK_V4_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreV4()
Constructs and initializes the datastore. |
|
DKDatastoreV4(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 the given ddo to this datastore. |
java.lang.String |
checkedOutUserid(dkDataObject dobj)
List the userid who checked out the document or folder |
void |
checkIn(dkDataObject dobj)
Check in(un-lock) a document or folder item from datastore |
void |
checkOut(dkDataObject dobj)
Check out(lock) a document or folder item from datastore |
void |
commit()
commit is not supported by this datastore type |
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)
Creates a query object. |
dkQuery |
createQuery(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Creates a query object. |
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 object |
void |
deleteObject(dkDataObject ddo)
Deletes the specified ddo from this datastore. |
void |
destroy()
datastore destroy - datastore cleanup if needed |
void |
disconnect()
Disconnects from a datastore. |
java.lang.Object |
evaluate(DKCQExpr qe)
evaluates the query. |
java.lang.Object |
evaluate(dkQuery query)
evaluates the query. |
java.lang.Object |
evaluate(java.lang.String command,
short commandLangType,
DKNVPair[] params)
evaluates the query. |
dkResultSetCursor |
execute(DKCQExpr cqe)
executes a query expression and returns a result set cursor |
dkResultSetCursor |
execute(dkQuery query)
executes the query. |
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 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)
Gets the 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 |
boolean |
isCheckedOut(dkDataObject dobj)
Check whether a document or folder item is checked out from datastore |
boolean |
isConnected()
Checks to see if the datastore is connected. |
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 object names |
java.lang.String[] |
listMappingNames()
Gets the list of the register mappings for this datastore |
java.lang.Object |
listSchema()
Deprecated. Replaced by listEntities |
java.lang.Object |
listSchemaAttributes(java.lang.String schemaEntry)
Deprecated. Replaced by listEntityAttrs |
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 the mapping definition to this datastore Mapping is done by entities. |
void |
removeExtension(java.lang.String extensionName)
Remove an existing extension object |
dkXDO |
retrieveFormOverlay(java.lang.String objid)
Retrieves the form overlay object |
void |
retrieveObject(dkDataObject ddo)
Retrieves the ddo from this datastore. |
void |
rollback()
Rollback is not supported by this datastore type |
void |
setOption(int option,
java.lang.Object value)
Sets a datastore option. |
void |
startTransaction()
startTransaction is not supported by this datastore type |
DKHandle |
transactionConnection()
Gets the transaction handle for a datastore - not supported by this datastore type |
DKCQExpr |
translate(DKCQExpr cqe)
Translate a query expression into a native query expression processable by this datastore. |
void |
unlockCheckedOut(dkDataObject dobj)
Unlock the checked-out document or folder item |
void |
unRegisterMapping(java.lang.String mappingName)
Unregisters the mapping information from this datastore |
void |
updateObject(dkDataObject ddo)
Updates the specified ddo in this datastore. |
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, changePassword, 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.dkDatastoreIntV4 |
addFolderItem, removeFolderItem |
Methods inherited from interface com.ibm.mm.sdk.common.dkDatastore |
addObject, addObject, addObjects, addObjects, addObjects, changePassword, 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 DKDatastoreV4() throws DKException, java.lang.Exception
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic DKDatastoreV4(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
- The connect string used for connection. This
is used to provide additional connection options.DKException
- if error detectedjava.lang.Exception
- if error detectedpublic void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkDatastore
disconnect
in class dkAbstractDatastore
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in interface dkDatastore
getOption
in class dkAbstractDatastore
option
- the option identifierDKException
- if error detectedjava.lang.Exception
- if error detectedpublic void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in interface dkDatastore
setOption
in class dkAbstractDatastore
option
- the option identifiervalue
- the option valueDKException
- if error detectedjava.lang.Exception
- if error detectedpublic 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 stringcommandLangType
- a query typeparams
- additional query option in name/value pairDKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.Object evaluate(dkQuery query) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
query
- a dkQuery objectDKException
- if error detectedjava.lang.Exception
- if error detectedpublic 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 error detectedjava.lang.Exception
- if error detectedpublic 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 stringcommandLangType
- a query typeparams
- additional query option in name/value pairDKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
query
- a dkQuery objectDKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkResultSetCursor execute(DKCQExpr cqe) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
cqe
- a common query expression objectpublic void executeWithCallback(dkQuery query, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
query
- a dkQuery objectcallbackObj
- a dkCallback objectDKException
- if error detectedjava.lang.Exception
- if error detectedpublic 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 stringcommandLangType
- a query typeparams
- additional query option in name/value paircallbackObj
- a dkCallback objectDKException
- if error detectedjava.lang.Exception
- if error detectedpublic 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
- if error detectedjava.lang.Exception
- if error detectedpublic 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 stringcommandLangType
- a query typeparams
- additional query option in name/value pairDKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkQuery createQuery(DKCQExpr qe) throws DKException, java.lang.Exception
createQuery
in interface dkDatastore
createQuery
in class dkAbstractDatastore
qe
- a common query expression objectDKException
- if error detectedjava.lang.Exception
- if error detectedpublic void addObject(dkDataObject ddo) throws DKException, java.lang.Exception
addObject
in interface dkDatastore
addObject
in class dkAbstractDatastore
ddo
- the ddo to be added to this datastoreDKException
- if error detectedjava.lang.Exception
- if error detected#add()
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
- if error detectedjava.lang.Exception
- if error detecteddel()
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
- if error detectedjava.lang.Exception
- if error detected#retrieve()
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
- if error detectedjava.lang.Exception
- if error detected#update()
public void moveObject(dkDataObject ddo, java.lang.String entityName) throws DKException, java.lang.Exception
moveObject
in interface dkDatastoreIntV4
ddo
- the data-object to be move in this datastoreentityName
- new entity name to move this data-object topublic void startTransaction() throws DKException, java.lang.Exception
startTransaction
in interface dkDatastoreIntV4
startTransaction
in class dkAbstractDatastore
DKException
- alwaysjava.lang.Exception
- alwayspublic void commit() throws DKException, java.lang.Exception
commit
in interface dkDatastore
commit
in class dkAbstractDatastore
DKException
- alwaysjava.lang.Exception
- alwayspublic void rollback() throws DKException, java.lang.Exception
rollback
in interface dkDatastore
rollback
in class dkAbstractDatastore
DKException
- alwaysjava.lang.Exception
- alwayspublic boolean isConnected() throws java.lang.Exception
isConnected
in interface dkDatastore
isConnected
in class dkAbstractDatastore
java.lang.Exception
- if error detectedpublic java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastore
datastoreName
in class dkAbstractDatastore
java.lang.Exception
- if error detectedpublic java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastore
datastoreType
in class dkAbstractDatastore
java.lang.Exception
- if error detectedpublic DKHandle connection() throws java.lang.Exception
connection
in interface dkDatastore
connection
in class dkAbstractDatastore
java.lang.Exception
- if error detectedpublic 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 dkDatastoreIntV4
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.String userName() throws java.lang.Exception
userName
in interface dkDatastore
userName
in class dkAbstractDatastore
java.lang.Exception
- if error detectedpublic dkCollection listDataSources() throws DKException, java.lang.Exception
listDataSources
in interface dkDatastore
listDataSources
in class dkAbstractDatastore
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
listDataSourceNames
in interface dkDatastore
listDataSourceNames
in class dkAbstractDatastore
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.Object listServers() throws DKException, java.lang.Exception
listServers
in interface dkDatastore
listServers
in class dkAbstractDatastore
DKException
- if error detectedjava.lang.Exception
- if error detectedlistDataSources()
public java.lang.Object listSchema() throws DKUsageError
listSchema
in interface dkDatastore
listSchema
in class dkAbstractDatastore
DKUsageError
- if error detectedlistEntities()
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 error detectedDKDatastoreAccessError
- if error detectedlistEntityAttrs(java.lang.String)
public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastore
listEntities
in class dkAbstractDatastore
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in interface dkDatastore
listEntityNames
in class dkAbstractDatastore
DKException
- if error occursjava.lang.Exception
- if error detectedpublic dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in interface dkDatastore
listEntityAttrs
in class dkAbstractDatastore
entityName
- the name of entity to retrieve attributes forDKException
- if the entity name does not existjava.lang.Exception
- if error detectedpublic java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in interface dkDatastore
listEntityAttrNames
in class dkAbstractDatastore
entityName
- the name of entity to retrieve attribute names forDKException
- if the entity name does not existjava.lang.Exception
- if error detectedpublic dkDatastoreDef datastoreDef()
datastoreDef
in interface dkDatastore
datastoreDef
in class dkAbstractDatastore
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:
Currently, only "SCHEMA" option is supported, others may be
added later.DKException
- if error detectedjava.lang.Exception
- if error detectedunRegisterMapping(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 informationDKException
- if error detectedjava.lang.Exception
- if error detectedregisterMapping(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 detectedjava.lang.Exception
- if error detectedregisterMapping(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
- the name of the mapping informationDKException
- if error detectedjava.lang.Exception
- if error detectedregisterMapping(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
- the name of the extension object.DKException
- if error detectedjava.lang.Exception
- if error detectedpublic void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in interface dkDatastore
addExtension
in class dkAbstractDatastore
extensionName
- the name of new extension objectextensionObj
- the extension object to be setDKException
- if error detectedjava.lang.Exception
- if error detectedpublic void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
removeExtension
in interface dkDatastore
removeExtension
in class dkAbstractDatastore
extensionName
- the name of extension object to be removedDKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkDatastore
listExtensionNames
in class dkAbstractDatastore
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic 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 to createFlags
- 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 detectedjava.lang.Exception
- if error detectedpublic void destroy() throws DKException, java.lang.Exception
destroy
in interface dkDatastore
destroy
in class dkAbstractDatastore
public boolean isCheckedOut(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
isCheckedOut
in interface dkDatastoreIntV4
dobj
- data object (document or folder item)public java.lang.String checkedOutUserid(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
checkedOutUserid
in interface dkDatastoreIntV4
dobj
- data object (document or folder item)public void unlockCheckedOut(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
unlockCheckedOut
in interface dkDatastoreIntV4
dobj
- data object (document or folder item)public void checkOut(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
checkOut
in interface dkDatastoreIntV4
dobj
- the dkDataObject(document or folder item) to be checked outDKUsageError
- if error detectedDKDatastoreAccessError
- if error detectedpublic void checkIn(dkDataObject dobj) throws DKUsageError, DKDatastoreAccessError
checkIn
in interface dkDatastoreIntV4
dobj
- the dkDataObject(document or folder item) to be checked inDKUsageError
- if error detectedDKDatastoreAccessError
- if error detectedpublic dkXDO retrieveFormOverlay(java.lang.String objid) throws DKException, java.lang.Exception
retrieveFormOverlay
in interface dkDatastoreIntV4
id
- the id string to retrieve the objectpublic DKCQExpr translate(DKCQExpr cqe) throws DKException, java.lang.Exception
cqe
- the input compound query expression
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |