|
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.DKEntityDefIP
The Entity Definition defines the set of attributes
available for a particular type of item, e.g. Document
or Folder.
These attributes are the parametric fields which are
available to identify and describe a particular item
stored on the back-end server.
Besides the attributes, the Entity Definition has a name
and a type associated with it.
Note: Formerly this was referred to as a Keyfield Group.
DKAttrDefIP
, Serialized FormFields inherited from interface com.ibm.mm.sdk.common.DKConstantIP |
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 | |
DKEntityDefIP()
Constructs and initializes an ImagePlus/390 Entity definition. |
|
DKEntityDefIP(dkDatastore ds)
Constructs and initializes an ImagePlus/390 Entity definition. |
Method Summary | |
void |
add()
Adds this entity definition to the persistent datastore. |
void |
add(dkAttrDef attrObj)
Adds the given attribute definition object to the this entity in the persistent store. Note: ImagePlus/390 does not support persistent entities, thus the addition of attributes to the entity definition is not supported. |
dkAttrDef |
createAttr()
Creates new dkAttrDef and returns it to caller. |
void |
del()
Deletes this entity from the persistent datastore. Note: ImagePlus/390 does not support persistent entities, thus the deletion of entity definitions is not supported. |
void |
del(dkAttrDef attrObj)
Deletes the given attribute from this entity definition in the persistent store. |
dkAttrDef |
getAttr(java.lang.String attrName)
Retrieves the attribute object associated with the specified attribute name. |
java.lang.String |
getName()
Gets entity name |
short |
getType()
Returns the entity type for this definition. |
java.lang.String[] |
listAttrNames()
Returns the list of attribute names for this entity definition. |
dkCollection |
listAttrs()
Returns the list of attributes for this entity definition. |
void |
setName(java.lang.String name)
Sets entity name |
void |
setType(short entityType)
Sets the Entity type for this definition. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
add, addAttr, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getParentEntityName, getSubEntity, hasSubEntities, isSearchable, isTextSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setParentEntityName, setTextSearchable |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKEntityDefIP()
public DKEntityDefIP(dkDatastore ds)
ds
- the datastore with which the Entity definition
is associated. The datastore must be of type
DKDatastoreIP.DKDatastoreIP
Method Detail |
public java.lang.String getName()
getName
in class dkAbstractEntityDef
public void setName(java.lang.String name)
setName
in class dkAbstractEntityDef
name
- new name to be set to this entity objectpublic short getType()
getType
in class dkAbstractEntityDef
DKConstantIP
public void setType(short entityType)
setType
in class dkAbstractEntityDef
entityType
- the entity type, which should be one of the Entity
Type values defined in DKConstantIP.DKConstantIP
public dkAttrDef createAttr() throws DKException, java.lang.Exception
createAttr
in class dkAbstractEntityDef
DKException
- - DKUsageError: the ImagePlus/390 datastore does not support adding new
attributes to entity definitions.java.lang.Exception
- if an error occurs in the java classes.public dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
getAttr
in class dkAbstractEntityDef
attrName
- name of the attribute to be retrievedDKException
- if an attribute
with the specified name does not exist.java.lang.Exception
- if an error occurs in the java classes.public dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in class dkAbstractEntityDef
DKException
- if an error occurs.java.lang.Exception
- if an error occurs in the java classes.DKAttrDefIP
public java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractEntityDef
DKException
- if an error occursjava.lang.Exception
- if an error occurs in the java classes.public void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- - DKUsageError: the ImagePlus/390 datastore does not support the creation of
new entity definitions.java.lang.Exception
- if an error occurs in the java classes.public void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- - DKUsageError: the ImagePlus/390 datastore does not support the deletion of
entity definitions.java.lang.Exception
- if an error occurs in the java classes.public void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
attrObj
- an attribute object to be added to this entity definitionDKException
- - DKUsageError: the ImagePlus/390 datastore does not support the addition of
new attributes to the entity definition.java.lang.Exception
- if an error occurs in the java classes.public void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
attrObj
- an attribute object to be deleted from this entity definitionDKException
- - DKUsageError: the ImagePlus/390 datastore does not support the deletion of
attributes from the entity definition.java.lang.Exception
- if an error occurs in the java classes.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |