com.ibm.bpc.clientcore
Class GenericBPCQuery

java.lang.Object
  extended bycom.ibm.bpc.clientcore.GenericBPCQuery
All Implemented Interfaces:
Query

public abstract class GenericBPCQuery
extends java.lang.Object
implements Query

GenericBPCQuery is an abstract base class used for queries against the Business Flow Manager and the Human Task Manager.
The class allows to dynamically set the SELECT, WHERE and ORDER BY clauses as well as the Threshold.

In addition it provides static methods for common conversion required to generate SQL queries.


Field Summary
static java.lang.String COPYRIGHT
           
protected  java.lang.String orderClause
           
protected  java.lang.String selectClause
           
protected  java.lang.Integer threshold
           
protected  java.lang.String type
           
protected  java.lang.String whereClause
           
 
Constructor Summary
GenericBPCQuery()
           
 
Method Summary
abstract  java.util.List execute()
          Retrieves a list of application objects.
 java.lang.String getOrderClause()
          Returns the order clause stored for the query
 java.lang.String getSelectClause()
          Returns the select clause stored for the query
 java.lang.Integer getThreshold()
          Returns the threshold value stored for the query
 java.lang.String getType()
          Returns a type which identifies the objects returned by the Query.execute method.
 java.lang.String getWhereClause()
          Returns the where clause stored for the query
 void resetWhereClause()
          Reset the where clause for the query
 void setOrderClause(java.lang.String string)
          Sets the order clause for the query
 void setSelectClause(java.lang.String string)
          Sets the select clause for the query
 void setThreshold(int integer)
          Sets the threshold value for the query
 void setType(java.lang.String t)
          Sets a type which identifies the objects returned by the Query.execute method.
 void setWhereClause(java.lang.String string)
          Sets the where clause for the query
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

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

type

protected java.lang.String type

selectClause

protected java.lang.String selectClause

whereClause

protected java.lang.String whereClause

orderClause

protected java.lang.String orderClause

threshold

protected java.lang.Integer threshold
Constructor Detail

GenericBPCQuery

public GenericBPCQuery()
Method Detail

execute

public abstract java.util.List execute()
                                throws ClientException
Description copied from interface: Query
Retrieves a list of application objects. Implement this method to access back ends and to filter the result list.

Specified by:
execute in interface Query
Returns:
a list of objects which adhere to the Java Bean conventions.
Throws:
ClientException

getType

public java.lang.String getType()
Description copied from interface: Query
Returns a type which identifies the objects returned by the Query.execute method. Implement this type to establish type checking between the query and its caller.

Specified by:
getType in interface Query
Returns:
The String representing the type of objects

setType

public void setType(java.lang.String t)
Sets a type which identifies the objects returned by the Query.execute method.

Parameters:
t - a String representing the type of objects

getOrderClause

public java.lang.String getOrderClause()
Returns the order clause stored for the query

Returns:
the order clause

getSelectClause

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

Returns:
the select clause

getThreshold

public java.lang.Integer getThreshold()
Returns the threshold value stored for the query

Returns:
the threshold value

getWhereClause

public java.lang.String getWhereClause()
Returns the where clause stored for the query

Returns:
the where clause

setOrderClause

public void setOrderClause(java.lang.String string)
Sets the order clause for the query

Parameters:
string - an order clause

setSelectClause

public void setSelectClause(java.lang.String string)
Sets the select clause for the query

Parameters:
string - a select clause

setThreshold

public void setThreshold(int integer)
Sets the threshold value for the query

Parameters:
integer - a threshold value

setWhereClause

public void setWhereClause(java.lang.String string)
Sets the where clause for the query

Parameters:
string - a where clause

resetWhereClause

public void resetWhereClause()
Reset the where clause for the query