com.ibm.bpe.api

Interface Entity

All Superinterfaces:
java.io.Serializable

  1. public interface Entity
  2. extends java.io.Serializable
Describes an entity that is returned as the result of an entity-based query request against a query table.
Since:
6.2.0.1 - introduced in 6.2

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. java.io.Serializable
getAttributeValue(java.lang.String attributeName)
Returns the value of the specified attribute.
  1. java.io.Serializable[]
getAttributeValuesOfArray(java.lang.String attributeName)
Returns the values of the specified array attribute.
  1. EntityInfo
getEntityInfo()
Returns type information of the entity.
  1. KeyAttributes
getKeyAttributes()
Returns the values and definitions of the key attributes.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

getEntityInfo

  1. EntityInfo getEntityInfo()
Returns type information of the entity.
Returns:
The information about the entity.

getAttributeValue

  1. 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

  1. 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

  1. KeyAttributes getKeyAttributes( )
Returns the values and definitions of the key attributes.

Returns:
KeyAttributes - The key attribute values and definitions.