|
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.common.dkAbstractDatastoreDef | +--com.ibm.mm.sdk.common.DKDatastoreDefTS
This class defines methods to access datastore information
as well as to create, list, and delete its entities
It maintains a collection of dkEntityDefs
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 | |
DKDatastoreDefTS(dkDatastore ds)
Constructs a DKDatastoreDefTS |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds the given entity object to persitent datastore |
dkEntityDef |
createEntity()
Creates a new dkEntityDef and return it. |
DKSearchIndexDefTS |
createSearchIndex()
Creates a new DKSearchIndexDefTS and return it. |
dkDatastoreAdmin |
datastoreAdmin()
Get a datastore administration object for a datastore |
void |
del(dkEntityDef entityObj)
Deletes the given entity object from persistent datastore |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name from persistent datastore. |
DKSearchIndexDefTS |
getSearchIndex(java.lang.String searchIndexName)
Gets the DKSearchIndexDefTS object for the given search index name from persistent datastore. |
dkCollection |
listEntities()
Gets a list of entities from persisten datastore |
java.lang.String[] |
listEntityNames()
Gets a list of entity names from persistent datastore |
dkCollection |
listSearchIndexes()
Gets a list of search indexes from persisten datastore |
java.lang.String[] |
listSearchIndexNames()
Gets a list of search index names from persistent datastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreDefTS(dkDatastore ds)
ds
- datastoreMethod Detail |
public dkEntityDef createEntity() throws DKException, java.lang.Exception
createEntity
in class dkAbstractDatastoreDef
public DKSearchIndexDefTS createSearchIndex() throws DKException, java.lang.Exception
public dkEntityDef getEntity(java.lang.String entityName) throws DKException, java.lang.Exception
getEntity
in class dkAbstractDatastoreDef
entityName
- name of entity to retrieveDKException
- if the entity name is not existpublic DKSearchIndexDefTS getSearchIndex(java.lang.String searchIndexName) throws DKException, java.lang.Exception
searchIndexName
- name of search index to retrieveDKException
- if the search index name is not existpublic dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
DKException
- if error occurspublic dkCollection listSearchIndexes() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
DKException
- if error occurspublic java.lang.String[] listSearchIndexNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic void add(dkEntityDef entityObj) throws DKException, java.lang.Exception
add
in class dkAbstractDatastoreDef
entityObj
- entity object to be added.DKException
- if the entity object is invalid or error occurs
in the server.public void del(dkEntityDef entityObj) throws DKException, java.lang.Exception
del
in class dkAbstractDatastoreDef
entityObj
- the entity object to be deleted.DKException
- if the entityObj is invalid or does not exist
in the server.public dkDatastoreAdmin datastoreAdmin() throws DKException, java.lang.Exception
datastoreAdmin
in class dkAbstractDatastoreDef
com.ibm.mm.sdk.common.dkAbstractDatastoreDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |