com.adobe.idp.taskmanager.dsc.client.query
Class TaskSearchFilter

java.lang.Object
  com.adobe.idp.dsc.filter.DefaultPropertyFilter
      com.adobe.idp.taskmanager.dsc.client.query.TaskSearchFilter

All Implemented Interfaces:

com.adobe.idp.dsc.filter.PagingFilter, com.adobe.idp.dsc.filter.PropertyFilter, java.io.Serializable

public class TaskSearchFilter
extends com.adobe.idp.dsc.filter.DefaultPropertyFilter

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

See Also:

Serialized Form

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	isIncludeCommonVariables()
boolean	isIncludeProcessVariables()
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	setIncludeCommonVariables(boolean isIncludeCommonVariables)
void	setIncludeProcessVariables(boolean isIncludeProcessVariables)
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

TaskSearchFilter

public TaskSearchFilter()

The default constructor.

Method Detail

isGenericAssignmentJoin

public boolean isGenericAssignmentJoin()

For internal use only. Do not use.

setGenericAssignmentJoin

public void setGenericAssignmentJoin(boolean aGenericAssignment)

For internal use only. Do not use.

isProcessJoin

public boolean isProcessJoin()

For internal use only. Do not use.

setProcessJoin

public void setProcessJoin(boolean aProcessJoin)

For internal use only. Do not use.

addCondition

public Condition addCondition(java.lang.String s,
                              java.lang.Object o)

Adds a condition to filter query results.

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.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

s - The attribute on which to filter the query results.

o - The Object that contains the values on which to filter.

Returns:

A Condition object containing the set filter values.

addCondition

public Condition addCondition(java.lang.String s,
                              java.lang.Object o,
                              Connective connective)

Adds a condition to filter query results.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

public Condition addCondition(java.lang.String s,
                              com.adobe.idp.dsc.filter.Operator operator,
                              java.lang.Object o)

Adds a condition to filter query results.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

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

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

public Condition addCondition(java.lang.String s,
                              com.adobe.idp.dsc.filter.Operator operator,
                              int i,
                              Connective connective)

Adds a condition to filter query results.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

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

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

public Condition addCondition(java.lang.String s,
                              com.adobe.idp.dsc.filter.Operator operator,
                              long l,
                              Connective connective)

Adds a condition to filter query results.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

public Condition addCondition(java.lang.String s,
                              com.adobe.idp.dsc.filter.Operator operator,
                              boolean b,
                              Connective connective)

Adds a condition to filter query results.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

public Condition addCondition(java.lang.String s,
                              com.adobe.idp.dsc.filter.Operator operator,
                              float v,
                              Connective connective)

Adds a condition to filter query results.

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

addCondition

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

Specified by:

addCondition in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

addCondition in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

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.

Returns:

A Condition object containing the set filter values.

setConditionList

public void setConditionList(java.util.List list)

Adds a list of conditions to filter query results.

Specified by:

setConditionList in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

setConditionList in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

list - A java.util.List object containing Condition objects.

getConditionList

public java.util.List getConditionList()

Retrieves a list of condition objects.

Specified by:

getConditionList in interface com.adobe.idp.dsc.filter.PropertyFilter

Overrides:

getConditionList in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Returns:

A java.util.List object containing Condition objects.

setOffset

public void setOffset(int i)

Sets the result set offset.

Specified by:

setOffset in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

setOffset in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

i - The result set offset.

getOffset

public int getOffset()

Retrieves the result set offset.

Specified by:

getOffset in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

getOffset in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Returns:

The result set offset.

setMaxObjects

public void setMaxObjects(int i)

Sets the maximum number of items returned from the query.

Specified by:

setMaxObjects in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

setMaxObjects in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

i - The maximum number of items returned from the query.

getMaxObjects

public int getMaxObjects()

Retrieves the maximum number of items returned from the query as specified in setMaxObjects().

Specified by:

getMaxObjects in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

getMaxObjects in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Returns:

The maximum number of items returned from the query.

setSortList

public void setSortList(java.util.List list)

Sets a list of sort objects.

Specified by:

setSortList in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

setSortList in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

list - A java.util.List object containing Sort objects.

getSortList

public java.util.List getSortList()

Retrieves a list of sort objects.

Specified by:

getSortList in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

getSortList in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Returns:

A java.util.List object containing Sort objects.

addSortAsc

public Sort addSortAsc(java.lang.String s)

Sets an attribute on which to sort in ascending order.

Specified by:

addSortAsc in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

addSortAsc in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

s - The name of the attribute on which to sort.

Returns:

A Sort object containing the attribute and its sort order.

addSortDesc

public Sort addSortDesc(java.lang.String s)

Sets an attribute on which to sort in descending order.

Specified by:

addSortDesc in interface com.adobe.idp.dsc.filter.PagingFilter

Overrides:

addSortDesc in class com.adobe.idp.dsc.filter.DefaultPropertyFilter

Parameters:

s - The name of the attribute on which to sort.

Returns:

A Sort object containing the attribute and its sort order.

addResultsetAttribute

public void addResultsetAttribute(java.lang.String aPropertyName)

Adds an attribute to be projected into the result set of the query.

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.

Parameters:

aPropertyName - The attribute to be projected into the result set of the query.

addResultsetAttribute

public void addResultsetAttribute(java.util.List resultSet)

Adds a list of attributes to be projected into the result set of the query.

Parameters:

resultSet - A java.util.List of attributes to be projected into the result set of the query.

setResultsetAttributes

public void setResultsetAttributes(java.util.List resultSet)

Adds a list of attributes to be projected into the result set of the query.

Parameters:

resultSet - A java.util.List of attributes to be projected into the result set of the query.

getResultsetAttributes

public java.util.List getResultsetAttributes()

Retrieves a list of attributes to be projected into the result set of the query.

Returns:

A java.util.List of attributes to be projected into the result set of the query.

getResultSet

public java.util.List getResultSet()

Retrieves a list of attributes to be projected into the result set of the query.

Returns:

A java.util.List of attributes to be projected into the result set of the query.

setResultSet

public void setResultSet(java.util.List resultSet)

Adds a list of attributes to be projected into the result set of the query.

Parameters:

resultSet - A java.util.List of attributes to be projected into the result set of the query.

isIgnoreAllAcls

public boolean isIgnoreAllAcls()

Determines whether the request to ignore ACLs for a task when querying for results has been set.

Returns:

true if the request to ignore ACLs has been set, false otherwise.

setIgnoreAllAcls

public void setIgnoreAllAcls(boolean ignoreAllAcls)

Sets whether to ignore ACLs for a task when querying for results.

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.

Parameters:

ignoreAllAcls - true ACLs are to be ignored when querying task results, false otherwise.

getServiceName

public java.lang.String getServiceName()

Retrieves current service name set for process variable searching.

Returns:

The current service name for process variable searching.

setServiceName

public void setServiceName(java.lang.String serviceName)

Sets the service name for process variable searching. Only one service can be searched at a time. Setting this attribute is essential for retrieval of process variables only.

Parameters:

serviceName - The name of the service that contains the process variables you want to query.

isAdminIgnoreAllAcls

public boolean isAdminIgnoreAllAcls()

Determines whether the request to ignore ACLs for a task when querying for results has been set.

Returns:

true if the request to ignore ACLs has been set, false otherwise.

setAdminIgnoreAllAcls

public void setAdminIgnoreAllAcls(boolean ignoreAllAcls)

Sets whether to ignore ACLs for a task when querying for results.

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.

Parameters:

ignoreAllAcls - true if ACLs are to be ignored when querying task results, false otherwise.

getPropertyUtil

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

Returns:

The task attribute mapping class.

setPropertyUtil

public void setPropertyUtil(TaskSearchingUtil aUtil)

Deprecated. For internal use only. Do not use.

isTaskNotificationJoin

public boolean isTaskNotificationJoin()

setTaskNotificationJoin

public void setTaskNotificationJoin(boolean isTaskNotificationJoin)

isIncludeCommonVariables

public boolean isIncludeCommonVariables()

setIncludeCommonVariables

public void setIncludeCommonVariables(boolean isIncludeCommonVariables)

isIncludeProcessVariables

public boolean isIncludeProcessVariables()

setIncludeProcessVariables

public void setIncludeProcessVariables(boolean isIncludeProcessVariables)