|
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
This class defines methods to access datastore def information
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
dkAbstractDatastoreDef()
Constructor with default value, |
|
dkAbstractDatastoreDef(dkDatastore ds)
Constructor with datastore owner reference |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds the given entity object to persitent datastore |
void |
clearCache()
Clear datastore def cache |
dkEntityDef |
createEntity()
Creates a new dkEntityDef and return it. |
dkDatastoreAdmin |
datastoreAdmin()
Gets the reference to dkDatastoreAdmin object |
java.lang.String |
datastoreName()
Gets the name of this datastore object. |
java.lang.String |
datastoreType()
Gets the type for this datastore object |
void |
del(dkEntityDef entityObj)
Deletes the given entity object from persistent datastore |
void |
deleteEntity(java.lang.String entityName)
Deletes the dkEntityDef object for the given entity name from persistent datastore. |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name (memory-only) |
dkCollection |
listEntities()
Gets a list of entities from persistent datastore |
dkCollection |
listEntities(DKNVPair[] options)
Gets a list of entities from persistent datastore |
dkCollection |
listEntities(int options)
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[] |
listEntityNames(DKNVPair[] options)
Gets a list of entity names from persistent datastore |
java.lang.String[] |
listEntityNames(int options)
Gets a list of entity names from persistent datastore |
dkCollection |
listSearchableEntities()
Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types. |
dkCollection |
listSearchableEntities(DKNVPair[] options)
Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types. |
dkCollection |
listSearchableEntities(int options)
Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types. |
java.lang.String[] |
listSearchableEntityNames()
Gets a list of searchable entity names from persistent datastore |
java.lang.String[] |
listSearchableEntityNames(DKNVPair[] options)
Gets a list of searchable entity names from persistent datastore |
java.lang.String[] |
listSearchableEntityNames(int options)
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 |
dkEntityDef |
retrieveEntity(java.lang.String entityName)
Retrieves the dkEntityDef object for the given entity name from persistent datastore. |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public dkAbstractDatastoreDef()
public dkAbstractDatastoreDef(dkDatastore ds)
ds
- reference to owner datastoreMethod Detail |
public void setDatastore(dkDatastore ds)
setDatastore
in interface dkDatastoreDef
public dkDatastore getDatastore()
getDatastore
in interface dkDatastoreDef
public java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkDatastoreDef
public java.lang.String datastoreType() throws java.lang.Exception
datastoreType
in interface dkDatastoreDef
public dkEntityDef createEntity() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
createEntity
in interface dkDatastoreDef
public dkEntityDef getEntity(java.lang.String entityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
getEntity
in interface dkDatastoreDef
entityName
- name of entity to retrieveDKException
- if the entity name is not existpublic dkEntityDef retrieveEntity(java.lang.String entityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
retrieveEntity
in interface dkDatastoreDef
entityName
- name of entity to retrieveDKException
- if the entity name is not existpublic dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in interface dkDatastoreDef
DKException
- if error occurspublic dkCollection listEntities(int options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listEntities
in interface dkDatastoreDef
options
- option for listing entitiesDKException
- if error occurspublic dkCollection listEntities(DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listEntities
in interface dkDatastoreDef
options
- option for listing entitiesDKException
- if error occurspublic dkCollection listSearchableEntities() throws DKException, java.lang.Exception
Note: Default behavior will call dkAbstractDatastoreDef.listEntities()
listSearchableEntities
in interface dkDatastoreDef
DKException
- if error occurspublic dkCollection listSearchableEntities(int options) throws DKException, java.lang.Exception
Note: Default behavior will call dkAbstractDatastoreDef.listEntities(int)
listSearchableEntities
in interface dkDatastoreDef
options
- option for listing searchable entitiesDKException
- if error occurspublic dkCollection listSearchableEntities(DKNVPair[] options) throws DKException, java.lang.Exception
Note: Default behavior will call dkAbstractDatastoreDef.listEntities(DKNVPair[])
listSearchableEntities
in interface dkDatastoreDef
options
- option for listing searchable entitiesDKException
- if error occurspublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in interface dkDatastoreDef
DKException
- if error occurspublic java.lang.String[] listEntityNames(int options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listEntityNames
in interface dkDatastoreDef
options
- option for listing entity namesDKException
- if error occurspublic java.lang.String[] listEntityNames(DKNVPair[] options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listEntityNames
in interface dkDatastoreDef
options
- option for listing entity namesDKException
- if error occurspublic java.lang.String[] listSearchableEntityNames() throws DKException, java.lang.Exception
Note: Default behavior will call dkAbstractDatastoreDef.listEntityNames()
listSearchableEntityNames
in interface dkDatastoreDef
DKException
- if error occurspublic java.lang.String[] listSearchableEntityNames(int options) throws DKException, java.lang.Exception
Note: Default behavior will call dkAbstractDatastoreDef.listEntityNames(int)
listSearchableEntityNames
in interface dkDatastoreDef
options
- option for listing searchable entity namesDKException
- if error occurslistSearchableEntityNames()
public java.lang.String[] listSearchableEntityNames(DKNVPair[] options) throws DKException, java.lang.Exception
listSearchableEntityNames
in interface dkDatastoreDef
options
- option for listing searchable entity names
Note: Default behavior will call dkAbstractDatastoreDef.listEntityNames(DKNVPair[])
DKException
- if error occurslistSearchableEntityNames()
public dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in interface dkDatastoreDef
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 interface dkDatastoreDef
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
listSearchTemplates
in interface dkDatastoreDef
DKException
- if error occurspublic java.lang.String[] listSearchTemplateNames() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
listSearchTemplateNames
in interface dkDatastoreDef
DKException
- if error occurspublic void add(dkEntityDef entityObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
add
in interface dkDatastoreDef
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
Note:DKUsageError exception thrown if method is not implemented
del
in interface dkDatastoreDef
entityObj
- the entity object to be deleted.DKException
- if the entityObj is invalid or does
not exist in the server.public void deleteEntity(java.lang.String entityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
deleteEntity
in interface dkDatastoreDef
entityName
- name of entity to retrieveDKException
- if the entity name is not existpublic dkDatastoreAdmin datastoreAdmin() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
datastoreAdmin
in interface dkDatastoreDef
public void clearCache() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
clearCache
in interface dkDatastoreDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |