com.ibm.task.api
Interface Entity
All Superinterfaces:
java.io.Serializable
- public interface Entity
- extends java.io.Serializable
Since:
7.0
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getAttributeValue(java.lang.String attributeName)
Returns the value of the specified attribute.
|
|
getAttributeValuesOfArray(java.lang.String attributeName)
Returns the values of the specified array attribute.
|
getEntityInfo()
Returns type information of the entity.
|
|
getKeyAttributes()
Returns the values and definitions of the key attributes.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
getEntityInfo
- EntityInfo getEntityInfo()
Returns type information of the entity.
Returns:
The information about the entity.
getAttributeValue
- java.io.Serializable getAttributeValue( java.lang.String attributeName)
Returns the value of the specified attribute.
Parameters:
attributeName
- The name of the attribute whose value is to be retrieved.
Returns:
The attribute value. If the value is not set for the entity, null is returned.
If the attribute is no single-valued attribute but an array, a Serializable[] is returned.
Throws:
java.lang.IllegalArgumentException
- If the attribute name is null or if the attribute does not exist. getAttributeValuesOfArray
- java.io.Serializable[] getAttributeValuesOfArray( java.lang.String attributeName)
Returns the values of the specified array attribute.
Parameters:
attributeName
- The name of the attribute whose values are to be retrieved.
Returns:
The attribute value. If the value is not set for the entity, an empty array is returned.
Throws:
java.lang.IllegalArgumentException
- If the attribute name is null or if the attribute does not exist or
if the attribute name specifies a single-valued attribute. getKeyAttributes
- KeyAttributes getKeyAttributes( )
Returns the values and definitions of the key attributes.
Returns:
KeyAttributes - The key attribute values and definitions.