com.ibm.bpe.api
Interface WorkListData

All Superinterfaces:
java.io.Serializable

public interface WorkListData
extends java.io.Serializable

Accesses the properties of a worklist.

A worklist is a query persistently stored on the database. It represents a set of items which have the same characteristics. These characteristics are specified by a filter. Additionally, sort criteria can be defined that are applied on the server, and a threshold to restrict the number of items transferred from the server to the client.

Although work-list definitions are stored persistently, items contained in the worklist are assembled dynamically when they are queried. All worklists are publicly accessible.


Method Summary
 java.lang.String getName()
          Returns the name of the worklist.
 java.lang.String getOrderByClause()
          Returns the sort criteria specified for the work-list definition.
 java.lang.String getSelectClause()
          Returns the select clause specified for the work-list definition.
 java.lang.Integer getThreshold()
          Returns the threshold specified for the work-list definition.
 java.lang.String getWhereClause()
          Returns the filter specified for the work-list definition.
 

Method Detail

getName

public java.lang.String getName()
Returns the name of the worklist.


getSelectClause

public java.lang.String getSelectClause()
Returns the select clause specified for the work-list definition.


getWhereClause

public java.lang.String getWhereClause()
Returns the filter specified for the work-list definition. If there is no filter, a null string is returned.


getOrderByClause

public java.lang.String getOrderByClause()
Returns the sort criteria specified for the work-list definition. If there are no sort criteria, a null string is returned.


getThreshold

public java.lang.Integer getThreshold()
Returns the threshold specified for the work-list definition. If there is no threshold defined, a null string is returned.