|
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.DKEntityDefIC
This class defines methods to access entity information for an index class
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIC |
DK_CM_PARM_LINKS, DK_IC_DSTYPE |
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.DKMessageIdIC |
DK_IC_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKEntityDefIC()
Constructs an index class def for IC |
|
DKEntityDefIC(dkDatastore ds)
Constructs an index class def for IC |
Method Summary | |
void |
add()
Adds this entity definition to the persistent store, i.e. |
void |
add(dkAttrDef attrObj)
Adds the given attribute definition object to the this entity in the persistent store. |
static DKEntityDefIC |
buildEntityDef(dkDatastore ds,
java.lang.String name,
dkResultSetCursor cursor)
Loads the entity definition for the specified entity from the datastore and returns it to the caller. |
dkAttrDef |
createAttr()
Creates new dkAttrDef and returns it to caller. |
void |
del()
Deletes this entity from the persistent store, e.g. |
void |
del(dkAttrDef attrObj)
Deletes the given attribute from this entity in the persistent store. |
dkAttrDef |
getAttr(java.lang.String attrName)
Retrieves an attribute object from a given attribute name |
java.lang.String[] |
listAttrNames()
Gets a list of attributes |
dkCollection |
listAttrs()
Gets a list of attributes |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
add, addAttr, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, isTextSearchable, listSubEntities, listSubEntityNames, 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 DKEntityDefIC()
public DKEntityDefIC(dkDatastore ds)
ds
- datastoreMethod Detail |
public dkAttrDef createAttr() throws DKException, java.lang.Exception
createAttr
in class dkAbstractEntityDef
public dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
getAttr
in class dkAbstractEntityDef
attrName
- name of attribute to be retrievedDKException
- if the attribute name is not existpublic dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in class dkAbstractEntityDef
DKException
- if error occurspublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractEntityDef
DKException
- if error occurspublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- if this method is called.public void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- if this method is called.public void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
attrObj
- an attribute object to be added to this entity objectDKException
- if this method is called.public void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
attrObj
- an attribute object to be deleted from this entity objectDKException
- if this method is called.public static DKEntityDefIC buildEntityDef(dkDatastore ds, java.lang.String name, dkResultSetCursor cursor) throws DKException, java.lang.Exception
ds
- IC Datastore this entity is from.name
- Name of the entity to createdesc
- Description of entitycursor
- Result set cursor to load the attribute information
from. Column 1 must be the attribute name and
column 2 must be the attribute description.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |