com.ibm.task.api
Interface StoredQuery
All Superinterfaces:
java.io.Serializable
- public interface StoredQuery
- extends java.io.Serializable
A stored query represents a set of items which have the same characteristics. These characteristics are specified by a filter. To allow for the re-use of stored queries, parameters can be specified in the where-clause so that, for example, the owner of an activity or task can be specified when the stored query is executed.
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.
Since:
6.0.2 - introduced in 6.0
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
|
KIND_PRIVATE
States that the stored query is private.
|
|
KIND_PUBLIC
States that the stored query is public.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getClientType()
Returns a user-defined client type that names the creator of the stored
query.
|
|
getCreator()
Returns the ID of the user that created the stored query.
|
|
getKind()
States whether the stored query is a public query available to everybody or
a private query available only to its owner.
|
|
getName()
Returns the name of the stored query.
|
|
getOrderByClause()
Returns the sort criteria specified for the stored query definition.
|
|
getOwner()
Returns the owner of the stored query when the stored query is for private
usage.
|
|
getSelectClause()
Returns the select clause specified for the stored query definition.
|
|
getStoredQueryProperties()
Returns a list of user-defined properties for the stored query definition - refer
to
StoredQueryProperty .
|
|
getThreshold()
Returns the threshold specified for the stored query definition.
|
|
getWhereClause()
Returns the filter specified for the stored query definition.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
KIND_PUBLIC
- static final int KIND_PUBLIC
States that the stored query is public.
See Also:
KIND_PRIVATE
- static final int KIND_PRIVATE
States that the stored query is private.
See Also:
Method Detail
getName
- java.lang.String getName()
Returns the name of the stored query.
getSelectClause
- java.lang.String getSelectClause( )
Returns the select clause specified for the stored query definition.
getWhereClause
- java.lang.String getWhereClause( )
Returns the filter specified for the stored query definition. If there is no filter,
a null string is returned.
getOrderByClause
- 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
- java.lang.Integer getThreshold( )
Returns the threshold specified for the stored query definition. If there is no
threshold defined, a null string is returned.
getStoredQueryProperties
- java.util.List getStoredQueryProperties( )
- throws WorkItemManagerException
Returns a list of user-defined properties for the stored query definition - refer
to
StoredQueryProperty
. If there are
no properties, an empty list is returned.
Throws:
getClientType
- java.lang.String getClientType( )
Returns a user-defined client type that names the creator of the stored
query. If there is no client type, a null string is returned.
getKind
- int getKind()
States whether the stored query is a public query available to everybody or
a private query available only to its owner.
Returns either KIND_PUBLIC or KIND_PRIVATE.
getOwner
- java.lang.String getOwner()
Returns the owner of the stored query when the stored query is for private
usage. Returns null when the stored query is available for public usage.
getCreator
- java.lang.String getCreator()
Returns the ID of the user that created the stored query. If the creator is unknown,
null is returned.