com.ibm.bpc.clientcore

Class GenericBPCQuery

  1. java.lang.Object
  2. extended bycom.ibm.bpc.clientcore.GenericBPCQuery
All implemented interfaces:
Query

  1. public abstract class GenericBPCQuery
  2. extends java.lang.Object
  3. 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
  1. static
  2. java.lang.String
COPYRIGHT
  1. protected
  2. java.lang.String
orderClause
  1. protected
  2. java.lang.String
selectClause
  1. protected
  2. java.lang.Integer
threshold
  1. protected
  2. java.lang.String
type
  1. protected
  2. java.lang.String
whereClause

Constructor Summary

Constructor and Description
GenericBPCQuery()

Method Summary

Modifier and Type Method and Description
  1. abstract
  2. java.util.List
execute()
  1. java.lang.String
getOrderClause()
Returns the ORDER BY clause stored for the query.
  1. java.lang.String
getSelectClause()
Returns the SELECT clause stored for the query.
  1. java.lang.Integer
getThreshold()
Returns the Threshold value stored for the query.
  1. java.lang.String
getType()
  1. java.lang.String
getWhereClause()
Returns the WHERE clause stored for the query.
  1. void
resetWhereClause()
Resets the WHERE clause for the query.
  1. void
setOrderClause(java.lang.String string)
Sets the ORDER BY clause for the query.
  1. void
setSelectClause(java.lang.String string)
Sets the SELECT clause for the query.
  1. void
setThreshold(int integer)
Sets the Threshold value for the query.
  1. void
setThreshold(java.lang.Integer integer)
Sets the Threshold value for the query.
  1. void
setType(java.lang.String value)
Sets a type that identifies the objects returned by the Query.execute method.
  1. 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

  1. public static final java.lang.String COPYRIGHT
See Also:

type

  1. protected java.lang.String type

selectClause

  1. protected java.lang.String selectClause

whereClause

  1. protected java.lang.String whereClause

orderClause

  1. protected java.lang.String orderClause

threshold

  1. protected java.lang.Integer threshold

Constructor Detail

GenericBPCQuery

  1. public GenericBPCQuery()

Method Detail

execute

  1. public abstract java.util.List execute( )
  2. throws ClientException
Description copied from interface: Query
Retrieves a list of application objects. Implement this method to access backend modules and to filter the result list.
Specified by:
execute in interface Query
Returns:
a list of objects that adhere to the Java Bean conventions.
Throws:

getType

  1. 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.
Specified by:
getType in interface Query
Returns:
The String representing the type of objects.

setType

  1. 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

  1. public java.lang.String getOrderClause( )
Returns the ORDER BY clause stored for the query.
Returns:
the ORDER BY clause

getSelectClause

  1. public java.lang.String getSelectClause( )
Returns the SELECT clause stored for the query.
Returns:
the SELECT clause

getThreshold

  1. public java.lang.Integer getThreshold( )
Returns the Threshold value stored for the query.
Returns:
the Threshold value

getWhereClause

  1. public java.lang.String getWhereClause( )
Returns the WHERE clause stored for the query.
Returns:
the WHERE clause

setOrderClause

  1. public void setOrderClause(java.lang.String string)
Sets the ORDER BY clause for the query.
Parameters:
string - an ORDER BY clause

setSelectClause

  1. public void setSelectClause(java.lang.String string)
Sets the SELECT clause for the query.
Parameters:
string - a SELECT clause

setThreshold

  1. public void setThreshold(int integer)
Sets the Threshold value for the query.
Parameters:
integer - a Threshold value

setThreshold

  1. public void setThreshold(java.lang.Integer integer)
Sets the Threshold value for the query.
Parameters:
integer - a Threshold value

setWhereClause

  1. public void setWhereClause(java.lang.String string)
Sets the WHERE clause for the query.
Parameters:
string - a WHERE clause

resetWhereClause

  1. public void resetWhereClause()
Resets the WHERE clause for the query.