com.ibm.bpe.api
Interface EntityResultSet
- public interface EntityResultSet
- extends java.io.Serializable
The entity result set returns entities which match the filter criteria that have been specified in the query table and in the query request. The entities are sorted according to the sort criteria specified in the query request. If sort criteria are not specified, there is no intrinsic order of entities. The number of entities returned is restricted by the threshold and skipCount parameters of the query request. If a threshold is not specified, all entities are returned.
An entity of the result set is defined through the selected attributes. The selected attributes reference query table attributes, such as attributes of tasks or process instances. If the query table requires instance-based authorization, work item information can also be referenced.
Attribute values can be retrieved and casted to a type that is compatible with the attribute type.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getEntities()
Returns the entities that are contained in this result set.
|
getEntityInfo()
Returns type information of the entities.
|
|
|
getEntityTypeName()
Returns the type of entities that are returned as the result of the query.
|
|
getLocale()
Returns the locale that is calculated for the system variable $LOCALE.
|
|
getQueryTableName()
Returns the name of the query table that is associated with this query result.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
Method Detail
getQueryTableName
- java.lang.String getQueryTableName( )
getEntityTypeName
- java.lang.String getEntityTypeName( )
getEntityInfo
- EntityInfo getEntityInfo()
EntityInfo
. getEntities
- java.util.List getEntities()
Entity
objects that are returned as the result of the query. getLocale
- java.util.Locale getLocale()