|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.dsc.filter.DefaultPropertyFilter com.adobe.idp.taskmanager.dsc.client.query.TaskSearchFilter
public class TaskSearchFilter
A filter object to be used by the
TaskManagerQueryService.taskSearch()
method.
The TaskSearchFilter
object can add attributes with which to filter
the results of a query and create a custom result set. If no result
set attributes are added, a default result set is returned.
When searching for process variables or adding them to a result set, you must specify the service (process) name that you are
searching against by using the setServiceName
method, as shown in the following example:
TaskSearchFilter filt = new TaskSearchFilter();
filt.setServiceName("procvar3");
Once the process name is set, you can add process variables to a condition or add them to the result set. To do so, add the prefix
"procVar."
to your process variable. If a process variable is called "one"
,
it becomes "procVar.one"
when used with the
TaskSearchFilter
object, as shown in the following example:
filt.addCondition("procVar.two", Operator.EQUALS, new Long(28));
filt.addResultsetAttribute("procVar.one");
Query service methods handle only simple types of process variables. Here is a list of the supported process variable types:
boolean
byte
date
date-time
decimal
double
float
int
long
short
string
Constructor Summary | |
---|---|
TaskSearchFilter()
The default constructor. |
Method Summary | |
---|---|
Condition |
addCondition(java.lang.String s,
java.lang.Object o)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
java.lang.Object o,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
boolean b,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
java.util.Date date,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
float v,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
int i,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
long l,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
java.lang.Object o)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
java.lang.Object o,
Connective connective)
Adds a condition to filter query results. |
Condition |
addCondition(java.lang.String s,
com.adobe.idp.dsc.filter.Operator operator,
java.lang.String s1,
Connective connective)
Adds a condition to filter query results. |
void |
addResultsetAttribute(java.util.List resultSet)
Adds a list of attributes to be projected into the result set of the query. |
void |
addResultsetAttribute(java.lang.String aPropertyName)
Adds an attribute to be projected into the result set of the query. |
Sort |
addSortAsc(java.lang.String s)
Sets an attribute on which to sort in ascending order. |
Sort |
addSortDesc(java.lang.String s)
Sets an attribute on which to sort in descending order. |
java.util.List |
getConditionList()
Retrieves a list of condition objects. |
int |
getMaxObjects()
Retrieves the maximum number of items returned from the query as specified in setMaxObjects() . |
int |
getOffset()
Retrieves the result set offset. |
TaskSearchingUtil |
getPropertyUtil()
Deprecated. For internal use only. Do not use. Returns the TaskSearchingUtil object containing the attribute definitions used to filter queries and build result sets. |
java.util.List |
getResultSet()
Retrieves a list of attributes to be projected into the result set of the query. |
java.util.List |
getResultsetAttributes()
Retrieves a list of attributes to be projected into the result set of the query. |
java.lang.String |
getServiceName()
Retrieves current service name set for process variable searching. |
java.util.List |
getSortList()
Retrieves a list of sort objects. |
boolean |
isAdminIgnoreAllAcls()
Determines whether the request to ignore ACLs for a task when querying for results has been set. |
boolean |
isGenericAssignmentJoin()
For internal use only. |
boolean |
isIgnoreAllAcls()
Determines whether the request to ignore ACLs for a task when querying for results has been set. |
boolean |
isProcessJoin()
For internal use only. |
boolean |
isTaskNotificationJoin()
|
void |
setAdminIgnoreAllAcls(boolean ignoreAllAcls)
Sets whether to ignore ACLs for a task when querying for results. |
void |
setConditionList(java.util.List list)
Adds a list of conditions to filter query results. |
void |
setGenericAssignmentJoin(boolean aGenericAssignment)
For internal use only. |
void |
setIgnoreAllAcls(boolean ignoreAllAcls)
Sets whether to ignore ACLs for a task when querying for results. |
void |
setMaxObjects(int i)
Sets the maximum number of items returned from the query. |
void |
setOffset(int i)
Sets the result set offset. |
void |
setProcessJoin(boolean aProcessJoin)
For internal use only. |
void |
setPropertyUtil(TaskSearchingUtil aUtil)
Deprecated. For internal use only. Do not use. |
void |
setResultSet(java.util.List resultSet)
Adds a list of attributes to be projected into the result set of the query. |
void |
setResultsetAttributes(java.util.List resultSet)
Adds a list of attributes to be projected into the result set of the query. |
void |
setServiceName(java.lang.String serviceName)
Sets the service name for process variable searching. |
void |
setSortList(java.util.List list)
Sets a list of sort objects. |
void |
setTaskNotificationJoin(boolean isTaskNotificationJoin)
|
Methods inherited from class com.adobe.idp.dsc.filter.DefaultPropertyFilter |
---|
getConditions, getPagingFilter, getReturnSizeOfValue, setConditions, setPagingFilter, setReturnSizeOfValue |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TaskSearchFilter()
Method Detail |
---|
public boolean isGenericAssignmentJoin()
public void setGenericAssignmentJoin(boolean aGenericAssignment)
public boolean isProcessJoin()
public void setProcessJoin(boolean aProcessJoin)
public Condition addCondition(java.lang.String s, java.lang.Object o)
Attribute names are defined in TaskSearchingConstants
.
When filtering on a process variable you must create a string with the prefix "procVar."
followed by the name of the attribute as it was defined in the process designer.
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.o
- The Object
that contains the values on which to filter.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, java.lang.Object o, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.o
- The Object
that contains the values on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
This connective adds the logical operator between the current condition and the previous one.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, java.lang.Object o)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.o
- The Object
that contains the values on which to filter.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, java.lang.Object o, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.o
- The Object
that contains the values on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, int i, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.i
- An integer
value on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, java.lang.String s1, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.s1
- A String
object on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, long l, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.l
- A long
value on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, boolean b, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.b
- A boolean
value on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, float v, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.v
- A float
value on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public Condition addCondition(java.lang.String s, com.adobe.idp.dsc.filter.Operator operator, java.util.Date date, Connective connective)
addCondition
in interface com.adobe.idp.dsc.filter.PropertyFilter
addCondition
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The attribute on which to filter the query results.operator
- The operator for the filter.date
- A Date
value on which to filter.connective
- An object used to determine whether to connect the filter attribute
using a logical AND
or OR
.
Condition
object containing the set filter values.public void setConditionList(java.util.List list)
setConditionList
in interface com.adobe.idp.dsc.filter.PropertyFilter
setConditionList
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
list
- A java.util.List
object containing Condition
objects.public java.util.List getConditionList()
getConditionList
in interface com.adobe.idp.dsc.filter.PropertyFilter
getConditionList
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
java.util.List
object containing Condition
objects.public void setOffset(int i)
setOffset
in interface com.adobe.idp.dsc.filter.PagingFilter
setOffset
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
i
- The result set offset.public int getOffset()
getOffset
in interface com.adobe.idp.dsc.filter.PagingFilter
getOffset
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
public void setMaxObjects(int i)
setMaxObjects
in interface com.adobe.idp.dsc.filter.PagingFilter
setMaxObjects
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
i
- The maximum number of items returned from the query.public int getMaxObjects()
setMaxObjects()
.
getMaxObjects
in interface com.adobe.idp.dsc.filter.PagingFilter
getMaxObjects
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
public void setSortList(java.util.List list)
setSortList
in interface com.adobe.idp.dsc.filter.PagingFilter
setSortList
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
list
- A java.util.List
object containing Sort
objects.public java.util.List getSortList()
getSortList
in interface com.adobe.idp.dsc.filter.PagingFilter
getSortList
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
java.util.List
object containing Sort
objects.public Sort addSortAsc(java.lang.String s)
addSortAsc
in interface com.adobe.idp.dsc.filter.PagingFilter
addSortAsc
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The name of the attribute on which to sort.
Sort
object containing the attribute and its sort order.public Sort addSortDesc(java.lang.String s)
addSortDesc
in interface com.adobe.idp.dsc.filter.PagingFilter
addSortDesc
in class com.adobe.idp.dsc.filter.DefaultPropertyFilter
s
- The name of the attribute on which to sort.
Sort
object containing the attribute and its sort order.public void addResultsetAttribute(java.lang.String aPropertyName)
Property names are defined in TaskSearchingConstants
.
When adding a process variable to the result set, you must create a string with the prefix "procVar."
followed by the name of the attribute.
aPropertyName
- The attribute to be projected into the result set of the query.public void addResultsetAttribute(java.util.List resultSet)
resultSet
- A java.util.List
of attributes to be projected into the result set of the query.public void setResultsetAttributes(java.util.List resultSet)
resultSet
- A java.util.List
of attributes to be projected into the result set of the query.public java.util.List getResultsetAttributes()
java.util.List
of attributes to be projected into the result set of the query.public java.util.List getResultSet()
java.util.List
of attributes to be projected into the result set of the query.public void setResultSet(java.util.List resultSet)
resultSet
- A java.util.List
of attributes to be projected into the result set of the query.public boolean isIgnoreAllAcls()
true
if the request to ignore ACLs has been set, false
otherwise.public void setIgnoreAllAcls(boolean ignoreAllAcls)
Only the query criteria must be honored when ignoreAllAcls
is set to true
. Doing so, however,
has no effect if the user is not in an administrative role.
ignoreAllAcls
- true
ACLs are to be ignored when querying task results, false
otherwise.public java.lang.String getServiceName()
public void setServiceName(java.lang.String serviceName)
serviceName
- The name of the service that contains the process variables you want to query.public boolean isAdminIgnoreAllAcls()
true
if the request to ignore ACLs has been set, false
otherwise.public void setAdminIgnoreAllAcls(boolean ignoreAllAcls)
Only the query criteria must be honored when ignoreAllAcls
is set to true
. Doing so, however,
has no effect if the user is not in an administrative role.
ignoreAllAcls
- true
if ACLs are to be ignored when querying task results, false
otherwise.public TaskSearchingUtil getPropertyUtil()
Returns the TaskSearchingUtil object containing the attribute definitions used to filter queries and build result sets.
public void setPropertyUtil(TaskSearchingUtil aUtil)
public boolean isTaskNotificationJoin()
public void setTaskNotificationJoin(boolean isTaskNotificationJoin)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |