|
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.dkAbstractEntityDef | +--com.ibm.mm.sdk.common.DKDatabaseDefQBIC
This class defines methods to access entity information for QBIC.
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 | |
DKDatabaseDefQBIC()
Constructs a database def for QBIC |
|
DKDatabaseDefQBIC(dkDatastore ds)
Constructs a database def for QBIC |
Method Summary | |
void |
add()
Adds this entity definition to the persistent store, i.e. |
void |
add(dkEntityDef subEntityObj)
Adds the sub entity definition object to the this entity in the persistent store. |
DKCatalogDefQBIC |
createCatalog()
Creates new catalog definition and returns it to caller. |
dkEntityDef |
createSubEntity()
Creates new dkEntityDef and returns it to caller. |
void |
del()
Deletes this entity from the persistent store, e.g. |
void |
del(dkEntityDef subEntityObj)
Delete the sub entity definition object from this entity in the persistent store. |
DKCatalogDefQBIC |
getCatalog(java.lang.String catalogName)
Retrieves a catalog object from a given catalog name. |
dkEntityDef |
getSubEntity(java.lang.String subEntityName)
Retrieves a sub entity object from a given sub entity name. |
boolean |
hasSubEntities()
Checks if this entity has sub entity objects |
boolean |
isSearchable()
Checks if the entity is searchable |
java.lang.String[] |
listCatalogNames()
Gets a list of catalog def names from persistent datastore |
dkCollection |
listCatalogs()
Gets a list of catalog def from persistent datastore |
dkCollection |
listSubEntities()
Gets a list of sub entities |
java.lang.String[] |
listSubEntityNames()
Gets a list of sub entity names |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
add, addAttr, addSubEntity, clearCache, createAttr, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getAttr, getDatastore, getDescription, getName, getParentEntityName, getType, isTextSearchable, listAttrNames, listAttrs, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatabaseDefQBIC()
public DKDatabaseDefQBIC(dkDatastore ds)
ds
- datastoreMethod Detail |
public boolean hasSubEntities() throws DKException, java.lang.Exception
hasSubEntities
in class dkAbstractEntityDef
public dkEntityDef createSubEntity() throws DKException, java.lang.Exception
createSubEntity
in class dkAbstractEntityDef
DKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public dkEntityDef getSubEntity(java.lang.String subEntityName) throws DKException, java.lang.Exception
getSubEntity
in class dkAbstractEntityDef
subEntityName
- name of attribute to be retrievedDKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public dkCollection listSubEntities() throws DKException, java.lang.Exception
listSubEntities
in class dkAbstractEntityDef
DKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public java.lang.String[] listSubEntityNames() throws DKException, java.lang.Exception
listSubEntityNames
in class dkAbstractEntityDef
DKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public DKCatalogDefQBIC createCatalog() throws DKException, java.lang.Exception
public DKCatalogDefQBIC getCatalog(java.lang.String catalogName) throws DKException, java.lang.Exception
catalogName
- name of catalog to be retrievedpublic dkCollection listCatalogs() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listCatalogNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic boolean isSearchable() throws DKException, java.lang.Exception
dkAbstractEntityDef
isSearchable
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
public void add(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
subEntityObj
- an sub entity object to be added to this
entity objectDKException
- if there is error in datastore serverpublic void del(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
subEntityObj
- an sub entity object to be deleted from this
entity objectDKException
- if the error occurs in datastorepublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- when the subclass does not implement this methodpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- when the subclass does not implement this method
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |