|
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.DKDatastoreDefOD
This class defines methods to access datastore definition information in OnDemand.
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 | |
DKDatastoreDefOD(dkDatastore ds)
constructor |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds the given entity definition object to the persistent datastore |
void |
addAttr(dkAttrDef attrObj)
Adds the given attribute definition object to the persitent datastore |
dkAttrDef |
createAttr()
Creates a new dkAttrDef |
dkEntityDef |
createEntity()
Creates a new dkEntityDef object |
dkDatastoreAdmin |
datastoreAdmin()
Get a datastore administration object for a datastore |
void |
del(dkEntityDef entityObj)
Deletes the given entity definition object from the persistent datastore |
void |
delAttr(dkAttrDef attrObj)
Deletes the given attribute definition object from the persistent datastore |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name from the persistent datastore. |
int |
getNumFolders()
Retrieves the number of OnDemand folders |
java.lang.String[] |
listAttrNames()
Gets a list of attribute names |
dkCollection |
listAttrs()
Gets a list of attributes |
dkCollection |
listEntities()
Gets a list of entities from the 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 the persistent datastore |
dkCollection |
listFolders()
Retrieves the folders fields for the specified folder |
dkCollection |
listSearchableEntities(int type)
Gets a list of folders/applgrps from the persistent datastore |
dkCollection |
listSearchTemplates()
Gets a list of folders from the persistent datastore |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef |
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, retrieveEntity, setDatastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreDefOD(dkDatastore ds)
ds
- a Datastore objectMethod Detail |
public dkEntityDef createEntity() throws DKException, java.lang.Exception
createEntity
in class dkAbstractDatastoreDef
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkEntityDef getEntity(java.lang.String entityName) throws DKException, java.lang.Exception
getEntity
in class dkAbstractDatastoreDef
entityName
- the name of entity to retrieveDKException
- if the entity name does not existjava.lang.Exception
- if error detectedpublic dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkCollection listSearchTemplates() throws DKException, java.lang.Exception
listSearchTemplates
in class dkAbstractDatastoreDef
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkCollection listSearchableEntities(int type) throws DKException, java.lang.Exception
listSearchableEntities
in class dkAbstractDatastoreDef
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
entityName
- the name of entity to retrieve attributes forDKException
- if the entity name does not existjava.lang.Exception
- if error detectedpublic java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in class dkAbstractDatastoreDef
entityName
- the name of entity to retrieve attribute names forDKException
- if the entity name does not existjava.lang.Exception
- if error detectedpublic void add(dkEntityDef entityObj) throws DKException, java.lang.Exception
add
in class dkAbstractDatastoreDef
entityObj
- the entity definition object to be added.DKException
- if the entity object is invalid
or error occurs in the server.DKException
- if error detectedpublic void del(dkEntityDef entityObj) throws DKException, java.lang.Exception
del
in class dkAbstractDatastoreDef
entityObj
- the entity definition object to be deleted.DKException
- if the entityObj is invalid or does
not exist in the server.DKException
- if error detectedpublic dkDatastoreAdmin datastoreAdmin() throws DKException, java.lang.Exception
datastoreAdmin
in class dkAbstractDatastoreDef
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic dkCollection listAttrs() throws DKException, java.lang.Exception
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
DKException
- if error occursjava.lang.Exception
- if error detectedpublic dkAttrDef createAttr() throws DKException, java.lang.Exception
DKException
- if error detectedjava.lang.Exception
- if error detectedpublic void addAttr(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- the attribute definition object to be added.DKException
- if the attribute object is invalid
or error occurs in the server.java.lang.Exception
- if error detectedpublic void delAttr(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- the attribute definition object to be deleted.DKException
- if the attrObj is invalid or does
not exist in the server.java.lang.Exception
- if error detectedpublic int getNumFolders() throws java.lang.Exception
public dkCollection listFolders() throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |