com.ibm.bpe.api
Interface StoredQueryData

All Superinterfaces:
java.io.Serializable

public interface StoredQueryData
extends java.io.Serializable

Accesses the properties of a query stored persistently.

A StoredQuery 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 these definitions are stored persistently, qualifying items are assembled dynamically when they are queried. All StoredQuery objects are publicly accessible.

Since:
6.0

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getName()
          Returns the name of the stored query.
 java.lang.String getOrderByClause()
          Returns the sort criteria specified for the stored query definition.
 java.lang.String getSelectClause()
          Returns the select clause specified for the stored query definition.
 java.lang.Integer getThreshold()
          Returns the threshold specified for the stored query definition.
 java.lang.String getWhereClause()
          Returns the filter specified for the stored query definition.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getName

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


getSelectClause

public java.lang.String getSelectClause()
Returns the select clause specified for the stored query definition.


getWhereClause

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


getOrderByClause

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


getThreshold

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