|
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.DKDatastoreDefDL
This class defines methods to access datastore def information in DL.
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 | |
DKDatastoreDefDL(dkDatastore ds)
Constructs a DKDatastoreDefDL |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds the given entity object to persitent datastore |
void |
addAttr(dkAttrDef attrObj)
Adds the given attribute object to persitent datastore |
dkAttrDef |
createAttr()
Creates new dkAttrDef and returns it to caller. |
dkEntityDef |
createEntity()
Creates a new dkEntityDef 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 |
void |
delAttr(dkAttrDef attrObj)
Deletes the given attribute object from persistent datastore |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name from persistent datastore. |
java.lang.String[] |
listAttrNames()
Gets a list of attribute names defined in the current server |
dkCollection |
listAttrs()
Gets a list of attributes defined in the current server |
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 |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef |
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveEntity, setDatastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreDefDL(dkDatastore ds)
ds
- datastoreMethod Detail |
public dkEntityDef createEntity() throws DKException, java.lang.Exception
createEntity
in class dkAbstractDatastoreDef
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 dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
DKException
- if error occurspublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
DKException
- if error occurspublic dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
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
listEntityAttrNames
in class dkAbstractDatastoreDef
entityName
- name of entity to retrieve attribute names forDKException
- if the entity name does not existpublic dkCollection listAttrs() throws DKException, java.lang.Exception
DKException
- if the entity name does not existpublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
DKException
- if the entity name does not existpublic 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
public dkAttrDef createAttr() throws DKException, java.lang.Exception
public void addAttr(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- attribute object to be added.DKException
- if the attribute object is invalid
or error occurs in the server.public void delAttr(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- the entity object to be deleted.DKException
- if the attrObj is invalid or does
not exist in the server.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |