Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKEntityDefIP

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKEntityDefIP
All Implemented Interfaces:
DKConstant, DKConstantIP, dkEntityDef, DKMessageId, DKMessageIdIP, java.io.Serializable

public class DKEntityDefIP
extends dkAbstractEntityDef
implements DKConstantIP, DKMessageIdIP, java.io.Serializable

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.

See Also:
DKAttrDefIP, Serialized Form

Fields 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.DKMessageIdIP
copyright, DK_IP_MSG_API_PROTOCOL_ERROR, DK_IP_MSG_CLIENT_API_NOT_OK, DK_IP_MSG_DATASTORE_READONLY, DK_IP_MSG_DOCIDNOTSET, DK_IP_MSG_FAF_ERROR, DK_IP_MSG_FAF_INTERNAL_ERROR, DK_IP_MSG_FAF_NOT_OK, DK_IP_MSG_FAF_WARNING, DK_IP_MSG_FOLDER_NOT_EMPTY, DK_IP_MSG_HOST_TIMEOUT, DK_IP_MSG_INVALID_CONN_OPTION, DK_IP_MSG_INVALID_DOCTYPE, DK_IP_MSG_INVALID_IODM_RC, DK_IP_MSG_INVALID_PARM, DK_IP_MSG_IODM_FAILURE, DK_IP_MSG_IODM_NOT_AVAILABLE, DK_IP_MSG_LOCKEDBYANOTHER, DK_IP_MSG_MISSING_CONN_OPTION, DK_IP_MSG_MSGID_NOT_FOUND, DK_IP_MSG_PROTOCOL_ERROR
 
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

DKEntityDefIP

public DKEntityDefIP()
Constructs and initializes an ImagePlus/390 Entity definition.

DKEntityDefIP

public DKEntityDefIP(dkDatastore ds)
Constructs and initializes an ImagePlus/390 Entity definition.
Parameters:
ds - the datastore with which the Entity definition is associated. The datastore must be of type DKDatastoreIP.
See Also:
DKDatastoreIP
Method Detail

getName

public java.lang.String getName()
Gets entity name
Overrides:
getName in class dkAbstractEntityDef
Returns:
name of this entity

setName

public void setName(java.lang.String name)
Sets entity name
Overrides:
setName in class dkAbstractEntityDef
Parameters:
name - new name to be set to this entity object

getType

public short getType()
Returns the entity type for this definition.
Overrides:
getType in class dkAbstractEntityDef
Returns:
entity type, which is one of the Entity Type values defined in DKConstantIP.
See Also:
DKConstantIP

setType

public void setType(short entityType)
Sets the Entity type for this definition.
Overrides:
setType in class dkAbstractEntityDef
Parameters:
entityType - the entity type, which should be one of the Entity Type values defined in DKConstantIP.
See Also:
DKConstantIP

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates new dkAttrDef and returns it to caller.
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
new dkAttrDef object
Throws:
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.

getAttr

public dkAttrDef getAttr(java.lang.String attrName)
                  throws DKException,
                         java.lang.Exception
Retrieves the attribute object associated with the specified attribute name.
Overrides:
getAttr in class dkAbstractEntityDef
Parameters:
attrName - name of the attribute to be retrieved
Returns:
an attribute object of type DKAttrDefIP
Throws:
DKException - if an attribute with the specified name does not exist.
java.lang.Exception - if an error occurs in the java classes.

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Returns the list of attributes for this entity definition.
Overrides:
listAttrs in class dkAbstractEntityDef
Returns:
a dkCollection of dkAttrDef's, which are of type DKAttrDefIP
Throws:
DKException - if an error occurs.
java.lang.Exception - if an error occurs in the java classes.
See Also:
DKAttrDefIP

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Returns the list of attribute names for this entity definition.
Overrides:
listAttrNames in class dkAbstractEntityDef
Returns:
an array of attribute names
Throws:
DKException - if an error occurs
java.lang.Exception - if an error occurs in the java classes.

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this entity definition to the persistent datastore.
Note: ImagePlus/390 does not support persistent entities, thus the addition of entity definitions is not supported.
Overrides:
add in class dkAbstractEntityDef
Throws:
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.

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this entity from the persistent datastore.
Note: ImagePlus/390 does not support persistent entities, thus the deletion of entity definitions is not supported.
Overrides:
del in class dkAbstractEntityDef
Throws:
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.

add

public void add(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
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.
Overrides:
add in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be added to this entity definition
Throws:
DKException - - 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.

del

public void del(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Deletes the given attribute from this entity definition in the persistent store. Note: ImagePlus/390 does not support persistent entities, thus the deletion of attributes from the entity definition is not supported.
Overrides:
del in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be deleted from this entity definition
Throws:
DKException - - 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

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.