|
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.DKDatastoreDefDES
This class defines methods to access DES datastore information
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreDefDES(dkDatastore ds)
Constructs a new DKDatastoreDefDES object with a given datastore |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds the given entity object to persitent datastore |
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 |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name from persistent datastore. |
java.lang.String |
getEntitySourceType(java.lang.String entityName)
getEntitySourceType will return the link type of specified source |
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[] |
listEntityCategoryNames()
listEntityCategoryNames will return a String array of Category names under the specified application. |
java.lang.String[] |
listEntityNames()
Gets a list of entity names from persistent datastore |
java.lang.String[] |
listEntityNamesByCategory(java.lang.String categoryName)
listEntityNamesByCategory will return a String array of Source names names under the specified category in a specified application. |
java.lang.String[] |
listEntityNamesByCategoryAndType(java.lang.String categoryName,
java.lang.String entitysourceType)
listEntityNamesByCategoryAndType will return a String array of Source names names under the specified category in a specified application of a particulare link type. |
java.lang.String[] |
listFileSystemEntities()
listFileSystemEntities will list the file system sources configured. |
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 DKDatastoreDefDES(dkDatastore ds)
ds
- reference to the datastore objectMethod 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 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 java.lang.String[] listEntityCategoryNames() throws DKException, java.lang.Exception
public java.lang.String[] listEntityNamesByCategory(java.lang.String categoryName) throws DKException, java.lang.Exception
categoryName
- - category name of interestpublic java.lang.String[] listEntityNamesByCategoryAndType(java.lang.String categoryName, java.lang.String entitysourceType) throws DKException, java.lang.Exception
categoryName
- - category name of interestentitySourceType
- - linkType name of interestpublic java.lang.String getEntitySourceType(java.lang.String entityName) throws DKException, java.lang.Exception
entityName
- - source name of interestpublic java.lang.String[] listFileSystemEntities() throws DKException, java.lang.Exception
void
-
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |