com.ibm.bpe.api
Interface RowResultSet
- public interface RowResultSet
- extends java.io.Serializable
The row result set returns attributes in rows which match the filter criteria that have been specified in the query table and in the query request. The rows are sorted according to the sort criteria specified in the query request. If sort criteria are not specified, there is no intrinsic order of rows. The number of rows returned is restricted by the threshold and skipCount parameters specified in the query request. If a threshold is not specified, all rows are returned.
The number of rows in the result set can be determined by using the
size()
method.
Rows can be read in a relative fashion using the next()
method
or in an absolute fashion using the first()
and last()
methods. Because the implicit cursor of a result set is
initially positioned before the first row, either first() or next() must be called
before reading a row.
A row 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. They can be retrieved by name or by specifying a column index. The first attribute (column) of a row states the value of the first selected attribute. The second attribute (column) of a row states the value of the second selected attribute, and so on.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
first()
Positions the cursor on the first row in the result set.
|
|
getAttributeInfo()
Returns information about the attributes in the row.
|
|
getAttributeValue(int columnIndex)
Retrieves the value of the attribute specified by its column index.
|
|
getAttributeValue(java.lang.String attributeName)
Retrieves the value of the specified attribute.
|
|
getLocale()
Returns the locale that is calculated for the system variable $LOCALE.
|
|
getPrimaryQueryTableName()
Returns the name of the primary query table that is associated with this query result.
|
|
getQueryTableName()
Returns the name of the query table that is associated with this query result.
|
|
last()
Positions the cursor on the last row in the result set.
|
|
next()
Positions the cursor on the next row in the result set starting from the current position.
|
|
previous()
Positions the cursor on the previous row in the result set starting from the current position.
|
|
size()
Returns the number of rows in the result set.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
Method Detail
getQueryTableName
- java.lang.String getQueryTableName( )
getPrimaryQueryTableName
- java.lang.String getPrimaryQueryTableName( )
next
- boolean next()
The implicit cursor is initially positioned before the first row in the set. This means that either next() or first() must be called before a row can be read.
If next() is used to read the result set, the first row in the result set becomes the current row. A further call to next() makes the second row the current row, and so on.
If the cursor is positioned at the last row of the result set and next() is called, the cursor position becomes undefined.
first
- boolean first()
The implicit cursor is initially positioned before the first row in the set. This means that first() or next() must be called before the first row can be read.
last
- boolean last()
previous
- boolean previous()
size
- int size()
The number of rows can be used to preallocate an array
to hold all rows that are navigated using the next()
call.
getAttributeInfo
- java.util.List getAttributeInfo( )
AttributeInfo
objects that describe the attributes in the row. getAttributeValue
- java.io.Serializable getAttributeValue( java.lang.String attributeName)
attributeName
- The name of the attribute to be retrieved.
java.lang.IllegalArgumentException
- if the specified attribute is not found. getAttributeValue
- java.io.Serializable getAttributeValue( int columnIndex)
columnIndex
- The column index of the attribute to be retrieved.
The first column index is 1, the second is 2, and so on.
java.lang.IndexOutOfBoundsException
- if the specified columnIndex is not valid. getLocale
- java.util.Locale getLocale()