com.ibm.task.api
Interface ExecutableQuery
- public interface ExecutableQuery
This interface supports implementations that use pre-defined queries. In contrast to stored queries, the queries can be customized before calling the query() method.
The get methods of this interface are called by the HumanTaskManagerDelegate when the query is set up. The setQueryResultSet() method of this interface is called to store the result of the query.
Since:
5.1
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getOrderByClause()
Retrieves the orderBy-clause of the query to be executed.
|
|
getSelectClause()
Retrieves the select-clause of the query to be executed.
|
|
getThreshold()
Retrieves the threshold of the query to be executed.
|
|
getTimezone()
Retrieves the timezone that is to be used for time values in the where-clause
and in the query result set.
|
|
getWhereClause()
Retrieves the where-clause of the query to be executed.
|
|
setQueryResultSet(QueryResultSet queryResultSet)
Sets the result of the query.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
getSelectClause
- java.lang.String getSelectClause( )
Retrieves the select-clause of the query to be executed.
Returns:
String
The select-clause; must not be null.
getWhereClause
- java.lang.String getWhereClause( )
Retrieves the where-clause of the query to be executed.
Returns:
String
The where-clause. Must return null if there is no where-clause.
getOrderByClause
- java.lang.String getOrderByClause( )
Retrieves the orderBy-clause of the query to be executed.
Returns:
String
The orderBy-clause. Must return null if there is no orderBy-clause.
getThreshold
- java.lang.Integer getThreshold( )
Retrieves the threshold of the query to be executed.
Returns:
Integer
The threshold. Must return null if there is no threshold.
getTimezone
- java.util.TimeZone getTimezone( )
Retrieves the timezone that is to be used for time values in the where-clause
and in the query result set.
Returns:
TimeZone
The time zone. Must return null if there are no time values or if time values are
provided in UTC.
setQueryResultSet
- void setQueryResultSet(QueryResultSet queryResultSet)
Sets the result of the query.
Parameters:
queryResultSet
- The result of the query as provided by the Human Task Manager API.