com.ibm.bpc.clientcore
Class GenericBPCQuery
- java.lang.Object
com.ibm.bpc.clientcore.GenericBPCQuery
All implemented interfaces:
- public abstract class GenericBPCQuery
- extends java.lang.Object
- implements Query
GenericBPCQuery
is an abstract base class used to issue queries against
the Business Flow Manager and the Human Task Manager.
The class allows you to dynamically set the SELECT, WHERE and ORDER BY clauses as well as the Threshold.
In addition, it provides static methods for common conversions that may be required to generate SQL queries.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
|
orderClause
|
|
selectClause
|
|
threshold
|
|
type
|
|
whereClause
|
Constructor Summary
Constructor and Description |
---|
GenericBPCQuery()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
execute()
|
|
getOrderClause()
Returns the ORDER BY clause stored for the query.
|
|
getSelectClause()
Returns the SELECT clause stored for the query.
|
|
getThreshold()
Returns the Threshold value stored for the query.
|
|
getType()
|
|
getWhereClause()
Returns the WHERE clause stored for the query.
|
|
resetWhereClause()
Resets the WHERE clause for the query.
|
|
setOrderClause(java.lang.String string)
Sets the ORDER BY clause for the query.
|
|
setSelectClause(java.lang.String string)
Sets the SELECT clause for the query.
|
|
setThreshold(int integer)
Sets the Threshold value for the query.
|
|
setThreshold(java.lang.Integer integer)
Sets the Threshold value for the query.
|
|
setType(java.lang.String value)
Sets a type that identifies the objects returned by the
Query.execute method.
|
|
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:
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
Retrieves a list of application objects. Implement this method to access
backend modules and to filter the result list.
getType
- public java.lang.String getType( )
Description copied from interface:
Query
Returns a type that identifies the objects returned by the
Query.execute
method.
Implement this type to establish type checking between the query and its caller.
Returns:
The String representing the type of objects.
setType
- public void setType(java.lang.String value)
Sets a type that identifies the objects returned by the
Query.execute
method.
Parameters:
value
- a String representing the type of objects getOrderClause
- public java.lang.String getOrderClause( )
Returns the ORDER BY clause stored for the query.
Returns:
the ORDER BY 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 BY clause for the query.
Parameters:
string
- an ORDER BY 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 setThreshold
- public void setThreshold(java.lang.Integer 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()
Resets the WHERE clause for the query.
Query