|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
dkDatastore: the following methods are additions or modifications of the existing method in the current implementation of dkDatastore
Method Summary | |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Adds a new extension object. |
void |
addObject(dkDataObject ddo)
Adds this ddo to this datastore. |
void |
addObject(dkDataObject ddo,
DKNVPair[] options)
Adds this ddo to this datastore. |
void |
addObject(dkDataObject ddo,
int option)
Adds this ddo to this datastore. |
void |
addObjects(dkCollection ddoCollection)
Adds this collection of ddos to this datastore. |
void |
addObjects(dkCollection ddoCollection,
DKNVPair[] options)
Adds this collection of ddos to this datastore. |
void |
addObjects(dkCollection ddoCollection,
int option)
Adds this collection of ddos to this datastore. |
void |
changePassword(java.lang.String userId,
java.lang.String oldPwd,
java.lang.String newPwd)
Deprecated. Replace by dkUserManagement.changePassword |
void |
clearCache()
Clear datastore cache |
void |
clearCache(int option)
Clear datastore cache |
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 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)
Deprecated. No replacement |
dkQuery |
createQuery(java.lang.String command,
short commandLangType,
DKNVPair[] params)
Deprecated. No replacement |
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)
Deletes this ddo from this datastore. |
void |
deleteObject(dkDataObject ddo,
DKNVPair[] options)
Deletes this ddo from this datastore. |
void |
deleteObject(dkDataObject ddo,
int option)
Deletes this ddo from this datastore. |
void |
deleteObjects(dkCollection ddoCollection)
Deletes this collection of ddos from this datastore. |
void |
deleteObjects(dkCollection ddoCollection,
DKNVPair[] options)
Deletes this collection of ddos from this datastore. |
void |
deleteObjects(dkCollection ddoCollection,
int option)
Deletes this collection of ddos from this datastore. |
void |
destroy()
datastore destroy - datastore cleanup if needed |
void |
disconnect()
Disconnects to a datastore. |
java.lang.Object |
evaluate(DKCQExpr qe)
evaluates the query. |
java.lang.Object |
evaluate(dkQuery query)
Deprecated. Use other evaluate methods |
java.lang.Object |
evaluate(dkSearchTemplate st)
evaluates the search template. |
java.lang.Object |
evaluate(java.lang.String command,
short commandLangType,
DKNVPair[] params)
evaluates the query. |
dkResultSetCursor |
execute(DKCQExpr qe)
executes the query. |
dkResultSetCursor |
execute(dkQuery query)
Deprecated. Use other execute methods |
dkResultSetCursor |
execute(dkSearchTemplate st)
executes the search template. |
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 qo,
dkCallback callbackObj)
Deprecated. Use other executeWithCallback methods |
void |
executeWithCallback(dkSearchTemplate st,
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 a datastore option. |
DKHandle |
handle(java.lang.String type)
Gets a datastore handle |
boolean |
isConnected()
Checks to see if the datastore is connected. |
java.lang.String[] |
listAvailableServices()
List available services |
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 objects' 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()
Gets a list of searchable entities from persistent datastore |
java.lang.String[] |
listSearchableEntityNames()
Gets a list of searchable entity names from persistent datastore |
java.lang.String[] |
listSearchTemplateNames()
Gets a list of search template names from persistent datastore |
dkCollection |
listSearchTemplates()
Gets a list of search templates from persistent datastore |
java.lang.Object |
listServers()
Deprecated. Replace by listDataSources |
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 |
retrieveObject(dkDataObject ddo,
DKNVPair[] options)
Retrieves this ddo from this datastore. |
void |
retrieveObject(dkDataObject ddo,
int option)
Retrieves this ddo from this datastore. |
void |
retrieveObjects(dkCollection ddoCollection)
Retrieves this collection of ddos from this datastore. |
void |
retrieveObjects(dkCollection ddoCollection,
DKNVPair[] options)
Retrieves this ddo from this datastore. |
void |
retrieveObjects(dkCollection ddoCollection,
int option)
Retrieves this collection of ddos from this datastore. |
void |
rollback()
Rollback a datastore transaction |
dkServiceMgr |
serviceMgr()
Gets a service manager |
void |
setOption(int option,
java.lang.Object value)
Sets a datastore option. |
void |
startTransaction()
Starts a transaction |
void |
unRegisterMapping(java.lang.String mappingName)
Unregisters mapping information for this datastore |
void |
updateObject(dkDataObject ddo)
Updates this ddo in this datastore. |
void |
updateObject(dkDataObject ddo,
DKNVPair[] options)
Updates this ddo in this datastore. |
void |
updateObject(dkDataObject ddo,
int option)
Updates this ddo in this datastore. |
void |
updateObjects(dkCollection ddoCollection)
Updates this collection of ddos in this datastore. |
void |
updateObjects(dkCollection ddoCollection,
DKNVPair[] options)
Updates this collection of ddos in this datastore. |
void |
updateObjects(dkCollection ddoCollection,
int option)
Updates this collection of ddos in this datastore. |
java.lang.String |
userName()
Gets the user name for this datastore object |
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
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.public void disconnect() throws DKException, java.lang.Exception
public java.lang.Object getOption(int option) throws DKException, java.lang.Exception
option
- the option identifierpublic void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
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 dkQueryEvaluator
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value pairpublic java.lang.Object evaluate(dkQuery query) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
qo
- a query objectpublic java.lang.Object evaluate(DKCQExpr qe) throws DKException, java.lang.Exception
qe
- a common query expression objectpublic java.lang.Object evaluate(dkSearchTemplate st) throws DKException, java.lang.Exception
Note: Default behavior will call dkDatastore.evaluate(DKCQExpr)
st
- a search template objectpublic dkResultSetCursor execute(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value pairpublic dkResultSetCursor execute(dkQuery query) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
qo
- a query objectpublic dkResultSetCursor execute(DKCQExpr qe) throws DKException, java.lang.Exception
qe
- a common query expression objectpublic dkResultSetCursor execute(dkSearchTemplate st) throws DKException, java.lang.Exception
Note: Default behavior will call dkDatastore.execute(DKCQExpr)
st
- a search template objectpublic void executeWithCallback(dkQuery qo, dkCallback callbackObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
qo
- a query objectcallbackObj
- a dkCallback objectpublic void executeWithCallback(java.lang.String command, short commandLangType, DKNVPair[] params, dkCallback callbackObj) throws DKException, java.lang.Exception
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value paircallbackObj
- a dkCallback objectpublic void executeWithCallback(DKCQExpr qe, dkCallback callbackObj) throws DKException, java.lang.Exception
qe
- a common query expression objectcallbackObj
- a dkCallback objectpublic void executeWithCallback(dkSearchTemplate st, dkCallback callbackObj) throws DKException, java.lang.Exception
Note: Default behavior will call dkDatastore.executeWithCallback(DKCQExpr,dkCallback)
st
- a search template objectcallbackObj
- a dkCallback objectpublic dkQuery createQuery(java.lang.String command, short commandLangType, DKNVPair[] params) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
createQuery
in interface dkQueryManager
command
- a query stringcommandLang
- a query typeparams
- additional query option in name/value pairpublic dkQuery createQuery(DKCQExpr qe) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
qe
- a common query expression objectpublic void addObject(dkDataObject ddo) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be added to this datastorepublic void addObject(dkDataObject ddo, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be added to this datastoreoption
- option for addpublic void addObject(dkDataObject ddo, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be added to this datastoreoptions
- options for addpublic void addObjects(dkCollection ddoCollection) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be added to this datastorepublic void addObjects(dkCollection ddoCollection, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be added to this datastoreoption
- option for addpublic void addObjects(dkCollection ddoCollection, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be added to this datastoreoptions
- options for addpublic void deleteObject(dkDataObject ddo) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be deleted from this datastorepublic void deleteObject(dkDataObject ddo, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be deleted from this datastoreoption
- option for deletepublic void deleteObject(dkDataObject ddo, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be deleted from this datastoreoption
- option for deletepublic void deleteObjects(dkCollection ddoCollection) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be deleted from
this datastorepublic void deleteObjects(dkCollection ddoCollection, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be deleted from
this datastoreoption
- option for deletepublic void deleteObjects(dkCollection ddoCollection, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be deleted from
this datastoreoption
- option for deletepublic void retrieveObject(dkDataObject ddo) throws DKException, java.lang.Exception
ddo
- the ddo to be retrieved from this datastorepublic void retrieveObject(dkDataObject ddo, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be retrieved from this datastoreoption
- option for retrievepublic void retrieveObject(dkDataObject ddo, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be retrieved from this datastoreoptions
- options for retrievepublic void retrieveObjects(dkCollection ddoCollection) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be retrieved from
this datastorepublic void retrieveObjects(dkCollection ddoCollection, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be retrieved from
this datastoreoption
- option for retrievepublic void retrieveObjects(dkCollection ddoCollection, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be retrieved from this datastoreoptions
- options for retrievepublic void updateObject(dkDataObject ddo) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be updated in this datastorepublic void updateObject(dkDataObject ddo, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be updated in this datastoreoption
- option for updatepublic void updateObject(dkDataObject ddo, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- the ddo to be updated in this datastoreoptions
- options for updatepublic void updateObjects(dkCollection ddoCollection) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be updated
in this datastorepublic void updateObjects(dkCollection ddoCollection, int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be updated
in this datastoreoption
- option for updatepublic void updateObjects(dkCollection ddoCollection, DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddoCollection
- the collection of ddos to be updated
in this datastoreoptions
- options for updatepublic void startTransaction() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public void commit() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public void rollback() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public boolean isConnected() throws java.lang.Exception
public java.lang.String datastoreName() throws java.lang.Exception
public java.lang.String datastoreType() throws java.lang.Exception
public DKHandle connection() throws java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public DKHandle handle(java.lang.String type) throws java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
type
- type of datastore handle wantedpublic java.lang.String userName() throws java.lang.Exception
public dkCollection listDataSources() throws DKException, java.lang.Exception
public java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
public java.lang.Object listServers() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listDataSources()
public java.lang.Object listSchema() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listEntities()
public java.lang.Object listSchemaAttributes(java.lang.String schemaEntry) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
schemaEntry
- the name of the schema.listEntityAttrs(java.lang.String)
public dkCollection listEntities() throws DKException, java.lang.Exception
DKException
- if error occurspublic dkCollection listSearchableEntities() throws DKException, java.lang.Exception
Note: Default behavior will call dkDatastore.listEntities()
DKException
- if error occurspublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listSearchableEntityNames() throws DKException, java.lang.Exception
Note: Default behavior will call dkDatastore.listEntityNames()
DKException
- if error occurspublic dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
entityName
- name of entity to retrieve attributes forDKException
- if the entity name does not existpublic java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
entityName
- name of entity to retrieve attribute names forDKException
- if the entity name does not existpublic dkCollection listSearchTemplates() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if error occurspublic java.lang.String[] listSearchTemplateNames() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if error occurspublic dkDatastoreDef datastoreDef() throws DKException, java.lang.Exception
public java.lang.String registerMapping(DKNVPair sourceMap) throws DKException, java.lang.Exception
sourceMap
- source name and mappingpublic void unRegisterMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
mappingName
- name of the mapping informationpublic java.lang.String[] listMappingNames() throws DKException, java.lang.Exception
public dkSchemaMapping getMapping(java.lang.String mappingName) throws DKException, java.lang.Exception
mappingName
- name of the mapping informationpublic dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
extensionName
- name of the extension object.public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
extensionName
- name of new extension objectextensionObj
- the extension object to be setpublic void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
extensionName
- name of extension object to be removedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
public DKDDO createDDO(java.lang.String objectType, int Flags) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
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.public void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
userId
- - useridoldPwd
- - old passwordnewPwd
- - new passworddkUserManagement.changePassword(
java.lang.String, java.lang.String,java.lang.String)
public void destroy() throws DKException, java.lang.Exception
public void clearCache() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public void clearCache(int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
option
- - clear cache option for selective clearing of cachepublic dkServiceMgr serviceMgr() throws DKException, java.lang.Exception
public java.lang.String[] listAvailableServices() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |