public interface StoredQueryData
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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
static int |
KIND_PRIVATE
States that the stored query is private.
|
static int |
KIND_PUBLIC
States that the stored query is public.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getClientType()
Returns a user-defined client type that names the creator of the stored
query.
|
java.lang.String |
getCreator()
Returns the ID of the user that created the stored query.
|
int |
getKind()
States whether the stored query is a public query available to everybody or
a private query available only to its owner.
|
java.lang.String |
getName()
Returns the name of the stored query.
|
java.lang.String |
getOrderByClause()
Returns the sort criteria specified for the stored query definition.
|
java.lang.String |
getOwner()
Returns the owner of the stored query when the stored query is for private
usage.
|
java.lang.String |
getSelectClause()
Returns the select clause specified for the stored query definition.
|
java.util.List |
getStoredQueryProperties()
Returns a list of user-defined properties for the stored query definition - refer
to
StoredQueryProperty . |
java.lang.Integer |
getThreshold()
Returns the threshold specified for the stored query definition.
|
java.lang.String |
getWhereClause()
Returns the filter specified for the stored query definition.
|
static final java.lang.String COPYRIGHT
static final int KIND_PUBLIC
static final int KIND_PRIVATE
java.lang.String getName()
java.lang.String getSelectClause()
java.lang.String getWhereClause()
java.lang.String getOrderByClause()
java.lang.Integer getThreshold()
java.util.List getStoredQueryProperties() throws WorkItemManagerException
StoredQueryProperty
. If there are
no properties, an empty list is returned.WorkItemManagerException
java.lang.String getClientType()
int getKind()
Returns either KIND_PUBLIC or KIND_PRIVATE.
java.lang.String getOwner()
java.lang.String getCreator()