|
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.DKDatastoreOD
DKDatastoreOD is the OnDemand implementation of dkDatastore. It provides Document, Part, and Folder storage and retrieval mechanisms for working with OnDemand content servers.
Field Summary | |
static long |
dll_count
|
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD |
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.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreOD()
Constructs and initializes the datastore. |
|
DKDatastoreOD(java.lang.String configuration)
Constructs 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. |
void |
callbackIsDone()
|
void |
changePassword(java.lang.String userId,
java.lang.String oldPwd,
java.lang.String newPwd)
Changes the user password. |
void |
commit()
Commit is not supported for this datastore. |
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 content 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()
Destroys the datastore. |
void |
disconnect()
Disconnects from the datastore. |
java.lang.Object |
evaluate(DKCQExpr qe)
Evaluates the query. |
java.lang.Object |
evaluate(dkQuery query)
Evaluates the query. |
java.lang.Object |
evaluate(dkSearchTemplate st)
Evaluates the query. |
java.lang.Object |
evaluate(dkSearchTemplate st,
DKNVPair[] params)
Evaluates the query. |
java.lang.Object |
evaluate(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Evaluates the query. |
dkResultSetCursor |
execute(DKCQExpr cqe)
Executes the query. |
dkResultSetCursor |
execute(DKCQExpr cqe,
com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread)
|
dkResultSetCursor |
execute(dkQuery query)
Executes the query. |
dkResultSetCursor |
execute(dkQuery query,
com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread)
|
dkResultSetCursor |
execute(dkSearchTemplate st)
Executes the query. |
dkResultSetCursor |
execute(dkSearchTemplate st,
DKNVPair[] params,
DKNVPair[] options)
Executes the query. |
dkResultSetCursor |
execute(dkSearchTemplate st,
DKNVPair[] params,
DKNVPair[] options,
com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread)
|
dkResultSetCursor |
execute(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Executes the query. |
dkResultSetCursor |
execute(java.lang.String command,
short commandLangType,
DKNVPair[] params,
com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread)
|
void |
executeWithCallback(DKCQExpr qe,
dkCallback callbackObj)
Executes the query with a callback function. |
void |
executeWithCallback(dkQuery query,
dkCallback callbackObj)
Executes the query with a callback function. |
void |
executeWithCallback(dkSearchTemplate st,
dkCallback callbackObj)
execute the query with callback function. |
void |
executeWithCallback(dkSearchTemplate st,
DKNVPair[] params,
dkCallback callbackObj)
|
void |
executeWithCallback(java.lang.String command,
short commandLangType,
DKNVPair[] params,
dkCallback callbackObj)
Executes the query with a callback function. |
int |
getCallbkCnt()
|
int |
getEntityType()
|
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. |
java.lang.String |
getProperty(java.lang.String key)
|
int |
getRefreshInterval()
|
DKHandle |
handle(java.lang.String type)
Gets a datastore handle. |
boolean |
isConnected()
Checks to see if the datastore is connected. |
java.lang.String[] |
listDataSourceNames()
Lists the available datastore source names that can be used to connect with. |
dkCollection |
listDataSources()
Lists the available datastore sources that can be used to connect with. |
dkCollection |
listEntities()
Gets a list of entities from a 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 a 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. Replace by listEntities |
java.lang.Object |
listSchemaAttributes(java.lang.String schemaEntry)
Deprecated. Replace by listEntityAttributes |
dkCollection |
listSearchableEntities(int type)
Gets a list of folders/applgrps from a persistent datastore. |
dkCollection |
listSearchTemplates()
Gets a list of folders from a persistent datastore. |
java.lang.Object |
listServers()
Deprecated. Replace by listDataSources |
void |
refreshServer()
|
java.lang.String |
registerMapping(DKNVPair sourceMap)
Registers the mapping definition to this datastore. |
void |
removeExtension(java.lang.String extensionName)
Remove an existing extension object |
void |
retrieveObject(dkDataObject ddo)
Retrieves the specified DDO from this datastore. |
void |
rollback()
Rollback is not supported for this datastore. |
void |
setDateData(dkDataObject ddo,
short index,
java.lang.String val,
int yyyy,
int mm,
int dd)
Sets the date attribute for a data item for a DDO. |
void |
setOption(int option,
java.lang.Object value)
Sets a datastore option. |
void |
setStringData(dkDataObject ddo,
short index,
java.lang.String val,
short attrtype_native)
Sets an attribute value for a DDO. |
void |
startRefreshThread()
|
void |
startTransaction()
startTransaction is not supported for this datastore. |
void |
stopRefreshThread()
|
DKCQExpr |
translate(DKCQExpr cqe)
Translates a query expression into a native query expression processable by this datastore. |
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, clearCache, clearCache, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, listAvailableServices, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, 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.dkDatastore |
addObject, addObject, addObjects, addObjects, addObjects, clearCache, clearCache, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, listAvailableServices, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, serviceMgr, updateObject, updateObject, updateObjects, updateObjects, updateObjects |
Field Detail |
public static long dll_count
Constructor Detail |
public DKDatastoreOD() throws DKException, java.lang.Exception
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic DKDatastoreOD(java.lang.String configuration) throws DKException, java.lang.Exception
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedMethod 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
Use connection_string
to pass parameters to
the OnDemand content server as a connection string.
The parameters and the syntax you can use in the connection string include:
DSJUSEREXIT=userExitOption;
- to
specify an OnDemand user exit
NPWD=newPassword;
- to change the
password
ODPORT=portNumber;
- to specify a
port to use for the connection other than the default port
ODCONNECT=type;
- to specify the
connection Protocol; use T for TCPIP, L for LOCAL, or
S for IPX/SPX
ODLOCAL=directory;
- to specify
where the local file system server resides
CACHEAGS=1;
- to get all the application
groups at logon
time
STAYCONNECT=1;
- to retain the connection
ENTITY_TYPE=TEMPLATES;
- to switch to the
OnDemand folder mode
REFRESH=n;
- to refresh the OD connection
every n seconds
An example of a connection string:
"ODPORT=1009;ODCONNECT=T;CACHEAGS=1;STAYCONNECT=1"
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 an error is detectedjava.lang.Exception
- if an error is detectedpublic void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkDatastore
disconnect
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic 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 user ID whose password you want to changeoldPwd
- the current passwordnewPwd
- the new password you wantDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in interface dkDatastore
getOption
in class dkAbstractDatastore
option
- the option identifier for the option you wantDKException
- if an error is detectedjava.lang.Exception
- if an error is 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 identifier you want to setvalue
- the option valueDKException
- if an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is detectedpublic java.lang.Object evaluate(dkSearchTemplate st) throws DKException, java.lang.Exception
evaluate
in interface dkDatastore
evaluate
in class dkAbstractDatastore
st
- an OD folder objectDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic java.lang.Object evaluate(dkSearchTemplate st, DKNVPair[] params) throws DKException, java.lang.Exception
evaluate
in interface dkDatastoreIntOD
st
- an OD folder objectparams
- additional query option in name/value pairDKException
- if an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is detectedpublic dkResultSetCursor execute(java.lang.String command, short commandLangType, DKNVPair[] params, com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread) throws DKException, java.lang.Exception
public dkResultSetCursor execute(dkSearchTemplate st) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
folder
- params
- additional query option in name/value pairDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic dkResultSetCursor execute(dkSearchTemplate st, DKNVPair[] params, DKNVPair[] options) throws DKException, java.lang.Exception
folder
- params
- additional query parameters in name/value pairoptions
- additional query options in name/value pairDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic dkResultSetCursor execute(dkSearchTemplate st, DKNVPair[] params, DKNVPair[] options, com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread) throws DKException, java.lang.Exception
public dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
query
- a dkQuery objectDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic dkResultSetCursor execute(dkQuery query, com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread) throws DKException, java.lang.Exception
public dkResultSetCursor execute(DKCQExpr cqe) throws DKException, java.lang.Exception
execute
in interface dkDatastore
execute
in class dkAbstractDatastore
qe
- a common query expression objectDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic dkResultSetCursor execute(DKCQExpr cqe, com.ibm.mm.sdk.server.PCallbackThreadOD callbackThread) throws DKException, java.lang.Exception
public 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 objectpublic void executeWithCallback(dkSearchTemplate st, dkCallback callbackObj) throws DKException, java.lang.Exception
dkDatastore
Note: Default behavior will call dkDatastore.executeWithCallback(DKCQExpr,dkCallback)
executeWithCallback
in interface dkDatastore
executeWithCallback
in class dkAbstractDatastore
com.ibm.mm.sdk.common.dkDatastore
st
- a search template objectcallbackObj
- a dkCallback objectpublic void executeWithCallback(dkSearchTemplate st, DKNVPair[] params, dkCallback callbackObj) throws DKException, java.lang.Exception
executeWithCallback
in interface dkDatastoreIntOD
public DKCQExpr translate(DKCQExpr cqe) throws DKException, java.lang.Exception
cqe
- the input compound query expressionpublic 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is detecteddel()
public void setDateData(dkDataObject ddo, short index, java.lang.String val, int yyyy, int mm, int dd) throws DKException, java.lang.Exception
ddo
- the DDOindex
- the index of the data item (data ID)yyyy
- the yearmm
- the monthdd
- the dayrDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic void setStringData(dkDataObject ddo, short index, java.lang.String val, short attrtype_native) throws DKException, java.lang.Exception
ddo
- the DDO to contain this attributeindex
- the index of the data item (data ID)val
- the attribute valueattrtype
- the attribute typeDKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is detected#update()
public void startTransaction() throws DKException, java.lang.Exception
startTransaction
in interface dkDatastoreIntOD
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 an error is detectedpublic java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastore
datastoreName
in class dkAbstractDatastore
java.lang.Exception
- if an error is detectedpublic java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastore
datastoreType
in class dkAbstractDatastore
java.lang.Exception
- if an error is detectedpublic DKHandle connection() throws java.lang.Exception
connection
in interface dkDatastore
connection
in class dkAbstractDatastore
java.lang.Exception
- if an error is 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 java.lang.String userName() throws java.lang.Exception
userName
in interface dkDatastore
userName
in class dkAbstractDatastore
java.lang.Exception
- if an error is detectedpublic dkCollection listDataSources() throws DKException, java.lang.Exception
listDataSources
in interface dkDatastore
listDataSources
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
listDataSourceNames
in interface dkDatastore
listDataSourceNames
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic java.lang.Object listServers() throws DKException, java.lang.Exception
listServers
in interface dkDatastore
listServers
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedlistDataSources()
public java.lang.Object listSchema() throws DKUsageError
listSchema
in interface dkDatastore
listSchema
in class dkAbstractDatastore
DKUsageError
- if an error is 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 an error is detectedDKDatastoreAccessError
- if an error is detectedlistEntityAttrs(java.lang.String)
public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastore
listEntities
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedpublic dkCollection listSearchTemplates() throws DKException, java.lang.Exception
listSearchTemplates
in interface dkDatastore
listSearchTemplates
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic dkCollection listSearchableEntities(int type) throws DKException, java.lang.Exception
DKException
- if an error is detectedjava.lang.Exception
- if an error is 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 an error is 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 an error is 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:
DKException
- if an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is 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 an error is detectedjava.lang.Exception
- if an error is detectedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkDatastore
listExtensionNames
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is 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.
For OD, this parameter must be set to DK_CM_DOCUMENT.DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic void destroy() throws DKException, java.lang.Exception
destroy
in interface dkDatastore
destroy
in class dkAbstractDatastore
DKException
- if an error is detectedjava.lang.Exception
- if an error is detectedpublic int getCallbkCnt()
public void callbackIsDone()
public java.lang.String getProperty(java.lang.String key)
public int getEntityType()
public int getRefreshInterval()
public void startRefreshThread()
public void stopRefreshThread()
public void refreshServer()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |