com.bea.wli.worklist.api
Class TaskSelector

java.lang.Object
  extended by com.bea.wli.worklist.api.TaskSelector
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TaskQuery

public class TaskSelector
extends Object
implements Serializable

Deprecated: You should not use this class directly. Use TaskQuery instead. In a future release, this class will be removed.

TaskSelector is used to select tasks based on specific properties.

A value for querying can be set against interested properties. If the value is not null, it will be used to filter tasks. Null values and empty arrays (applicable in case of String and String[]) will not be used for filtering.

If multiple querying conditions are specified, only the tasks fulfilling all the conditions will be selected. This selector also allows the results to be sorted in ascending or descending order.

To search for tasks without assignees, use an Assignee object without user or group. Note that if Assignee is part of sorting criteria, only tasks with assignees will be returned.

For sorting the results, use the setSortByXXX(short order) methods. The order parameter indicates the precedence of the sort criteria as well as sorting in descending order or ascending order.

A negative order parameter will result in descending sort order, while a positive parameter will result in ascending sort order.

The absolute value of the order parameter denotes the relative precedence of the sort criteria. A smaller absolute value indicates that the criteria be sorted first.

The following example illustrates the usage:

setSortByPriority((short)1);
setSortByTaskName((short)-2);

This means that the tasks will be sorted first by priority in ascending order, followed by sorting on task names in descending order. If the same order parameter is given to multiple criteria, the relative sort order among the criteria is not guaranteed. If the order parameter given is Short.MAX_VALUE, then the criteria will not take effect at all.

Some special criteria accept wildcard characters: % stands for any sequence of characters, _ stands for any single character.
You can escape these characters using \. i.e. %a_b\%%

Deprecated: You should not use this class directly. Use TaskQuery instead. In a future release, this class will be removed.

Since:
8.1
See Also:
Serialized Form

Constructor Summary
TaskSelector()
          Construct a new empty task selector.
TaskSelector(String[] taskIds, String taskName, boolean isNamePattern, String description, boolean isDescriptionPattern, String comment, boolean isCommentPattern, String[] owners, String[] claimants, Assignee assignee, Integer minPriority, Integer maxPriority, StateType[] stateTypes, String parentProcessUri, boolean isParentProcessUriPattern, String[] parentProcessIds, String listeningProcessUri, boolean isListeningProcessUriPattern, String[] listeningProcessIds, Date completionDueDateBefore, Date completionDueDateAfter, Date claimDueDateBefore, Date claimDueDateAfter, Date creationDateBefore, Date creationDateAfter, Boolean canBeReassigned, Boolean canBeReturned, Boolean canBeAborted, String[] propertyNames, String[] propertyValues, boolean[] isPropertyValuePattern)
          Deprecated.  
TaskSelector(String[] taskIds, String taskName, boolean isNamePattern, String description, boolean isDescriptionPattern, String comment, boolean isCommentPattern, String[] owners, String[] claimants, Assignee assignee, Integer minPriority, Integer maxPriority, StateType[] stateTypes, String parentProcessUri, boolean isParentProcessUriPattern, String[] parentProcessIds, String listeningProcessUri, boolean isListeningProcessUriPattern, String[] listeningProcessIds, Date completionDueDateBefore, Date completionDueDateAfter, Date claimDueDateBefore, Date claimDueDateAfter, Date creationDateBefore, Date creationDateAfter, Boolean canBeReassigned, Boolean canBeReturned, Boolean canBeAborted, String[] propertyNames, String[] propertyValues, boolean[] isPropertyValuePattern, boolean includeTaskRequest, boolean includeTaskResponse)
          Deprecated.  
TaskSelector(String[] taskIds, String taskName, boolean isNamePattern, String description, boolean isDescriptionPattern, String comment, boolean isCommentPattern, String[] owners, String[] claimants, Assignee assignee, Integer minPriority, Integer maxPriority, StateType[] stateTypes, String parentProcessUri, boolean isParentProcessUriPattern, String[] parentProcessIds, String listeningProcessUri, boolean isListeningProcessUriPattern, String[] listeningProcessIds, Date completionDueDateBefore, Date completionDueDateAfter, Date claimDueDateBefore, Date claimDueDateAfter, Date creationDateBefore, Date creationDateAfter, Boolean canBeReassigned, Boolean canBeReturned, Boolean canBeAborted, String[] propertyNames, String[] propertyValues, boolean[] isPropertyValuePattern, boolean includeTaskRequest, boolean includeTaskResponse, boolean includeTaskProperties)
          Deprecated.  
TaskSelector(String[] taskIds, String taskName, boolean isNamePattern, String description, boolean isDescriptionPattern, String comment, boolean isCommentPattern, String[] owners, String[] claimants, Assignee assignee, Integer minPriority, Integer maxPriority, StateType[] stateTypes, String parentProcessUri, boolean isParentProcessUriPattern, String[] parentProcessIds, String listeningProcessUri, boolean isListeningProcessUriPattern, String[] listeningProcessIds, Date completionDueDateBefore, Date completionDueDateAfter, Date claimDueDateBefore, Date claimDueDateAfter, Date creationDateBefore, Date creationDateAfter, Boolean canBeReassigned, Boolean canBeReturned, Boolean canBeAborted, String propertyName, String propertyValue, boolean isPropertyValuePattern)
          Deprecated.  
TaskSelector(String[] taskIds, String taskName, boolean isNamePattern, String description, boolean isDescriptionPattern, String comment, boolean isCommentPattern, String[] owners, String[] claimants, Assignee assignee, Integer minPriority, Integer maxPriority, StateType[] stateTypes, String parentProcessUri, boolean isParentProcessUriPattern, String[] parentProcessIds, String listeningProcessUri, boolean isListeningProcessUriPattern, String[] listeningProcessIds, Date completionDueDateBefore, Date completionDueDateAfter, Date claimDueDateBefore, Date claimDueDateAfter, Date creationDateBefore, Date creationDateAfter, Boolean canBeReassigned, Boolean canBeReturned, Boolean canBeAborted, String propertyName, String propertyValue, boolean isPropertyValuePattern, boolean includeTaskRequest, boolean includeTaskResponse)
          Deprecated.  
TaskSelector(String[] taskIds, String taskName, boolean isNamePattern, String description, boolean isDescriptionPattern, String comment, boolean isCommentPattern, String[] owners, String[] claimants, Assignee assignee, Integer minPriority, Integer maxPriority, StateType[] stateTypes, String parentProcessUri, boolean isParentProcessUriPattern, String[] parentProcessIds, String listeningProcessUri, boolean isListeningProcessUriPattern, String[] listeningProcessIds, Date completionDueDateBefore, Date completionDueDateAfter, Date claimDueDateBefore, Date claimDueDateAfter, Date creationDateBefore, Date creationDateAfter, Boolean canBeReassigned, Boolean canBeReturned, Boolean canBeAborted, String propertyName, String propertyValue, boolean isPropertyValuePattern, boolean includeTaskRequest, boolean includeTaskResponse, boolean includeTaskProperties)
          Deprecated.  
TaskSelector(TaskSelector selector)
          Copy Constructor
 
Method Summary
 void addProperties(String[] propertyNames, String[] propertyValues, boolean[] isPatternFlags)
           
 void addProperty(String propertyName, String[] propertyValues, boolean isPattern)
           
 void addProperty(String propertyName, String propertyValue, boolean isPattern)
           
 Assignee getAssignee()
           
 Boolean getCanBeAborted()
          Deprecated.  
 Boolean getCanBeReassigned()
          Deprecated.  
 Boolean getCanBeReturned()
          Deprecated.  
 String[] getClaimants()
           
 Date getClaimDueDateAfter()
          Deprecated.  
 Date getClaimDueDateBefore()
          Deprecated.  
 String getComment()
           
 Date getCompletedDateAfter()
           
 Date getCompletedDateBefore()
           
 Date getCompletionDueDateAfter()
           
 Date getCompletionDueDateBefore()
           
 Date getCreationDateAfter()
           
 Date getCreationDateBefore()
           
 String getDescription()
          Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.
 List<String> getIncludedPropertyNames()
           
 boolean getIncludeTaskProperties()
           
 boolean getIncludeTaskRequestMessage()
          Deprecated.  
 boolean getIncludeTaskResponseMessage()
          Deprecated.  
 String[] getListeningProcessIds()
          Deprecated.  
 String getListeningProcessUri()
          Deprecated.  
 Integer getMaxPriority()
           
 int getMaxTasksReturned()
           
 Integer getMinPriority()
           
 String[] getOwners()
           
 String[] getParentProcessIds()
          Deprecated.  
 String getParentProcessUri()
          Deprecated.  
 String getPropertyName()
          Deprecated. Use getPropertyNames() instead.
 String[] getPropertyNames()
           
 String getPropertyValue()
          Deprecated. Use getPropertyValue(String propertyName)
 String getPropertyValue(String propertyName)
          Deprecated. Use getPropertyValues(String propertyName)
 String[] getPropertyValues(String propertyName)
          Get the property values for the given property.
 short getSortByAssignee()
           
 short getSortByCanBeAborted()
          Deprecated.  
 short getSortByCanBeReassigned()
          Deprecated.  
 short getSortByCanBeReturned()
          Deprecated.  
 short getSortByClaimant()
           
 short getSortByClaimDueDate()
          Deprecated.  
 short getSortByComment()
           
 short getSortByCompletedDate()
           
 short getSortByCompletionDueDate()
           
 short getSortByCreationDate()
           
 short getSortByDescription()
          Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.
 short getSortByListeningProcessId()
          Deprecated.  
 short getSortByListeningProcessUri()
          Deprecated.  
 short getSortByOwner()
           
 short getSortByParentProcessId()
          Deprecated.  
 short getSortByParentProcessUri()
          Deprecated.  
 short getSortByPriority()
           
 Map getSortByPropertyMap()
           
 short getSortByPropertyValue()
          Deprecated. use getSortByPropertyValue(String propertyName)
 short getSortByPropertyValue(String propertyName)
          Get the sort value for a given property name, if previously specified.
 short getSortByStateType()
          Deprecated. Use admin state, working state, and/or current step instead
 short getSortByTaskId()
           
 short getSortByTaskName()
           
 StateType[] getStateTypes()
          Deprecated. Use admin state, working state, and/or current step instead.
 String[] getTaskIds()
           
 String getTaskName()
           
 boolean isCommentPattern()
           
 boolean isDescriptionPattern()
          Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.
 boolean isListeningProcessUriPattern()
          Deprecated.  
 boolean isParentProcessUriPattern()
          Deprecated.  
 boolean isPropertyValuePattern()
          Deprecated. Use isPropertyValuePattern(String propertyName)
 boolean isPropertyValuePattern(String propertyName)
          To check if the property value is a pattern.
 boolean isSingleton()
           
 boolean isTaskNamePattern()
           
 void setAssignee(Assignee assignee)
          To search for tasks without assignees, use an Assignee object without user or group.
 void setCanBeAborted(Boolean canBeAborted)
          Deprecated.  
 void setCanBeReassigned(Boolean canBeReassigned)
          Deprecated.  
 void setCanBeReturned(Boolean canBeReturned)
          Deprecated.  
 void setClaimants(String[] claimants)
           
 void setClaimDueDateAfter(Date claimDueDateAfter)
          Deprecated.  
 void setClaimDueDateBefore(Date claimDueDateBefore)
          Deprecated.  
 void setComment(String comment, boolean isPattern)
           
 void setCompletedDateAfter(Date completedDateAfter)
           
 void setCompletedDateBefore(Date completedDateBefore)
           
 void setCompletionDueDateAfter(Date completionDueDateAfter)
           
 void setCompletionDueDateBefore(Date completionDueDateBefore)
           
 void setCreationDateAfter(Date creationDateAfter)
           
 void setCreationDateBefore(Date creationDateBefore)
           
 void setDescription(String description, boolean isPattern)
          Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.
 void setIncludedPropertyNames(List<String> propNames)
           
 void setIncludeTaskProperties(boolean include)
           
 void setIncludeTaskRequestMessage(boolean include)
          Deprecated.  
 void setIncludeTaskResponseMessage(boolean include)
          Deprecated.  
 void setListeningProcessIds(String[] listeningProcessIds)
          Deprecated.  
 void setListeningProcessUri(String listeningProcessUri, boolean isPattern)
          Deprecated.  
 void setMaxPriority(Integer maxPriority)
           
 void setMaxTasksReturned(int count)
           
 void setMinPriority(Integer minPriority)
           
 void setOwners(String[] owners)
           
 void setParentProcessIds(String[] parentProcessIds)
          Deprecated.  
 void setParentProcessUri(String parentProcessUri, boolean isPattern)
          Deprecated.  
 void setPropertyName(String propertyName)
           
 void setPropertyNames(String[] propertyNames)
           
 void setPropertyValue(String propertyValue, boolean isPattern)
          Deprecated. Use setPropertyValue(String propertyName, String propertyValue, boolean isPattern)
 void setPropertyValue(String propertyName, String propertyValue, boolean isPattern)
          Set the property to the new iarray of values.
 void setPropertyValues(String propertyName, String[] propertyValues, boolean isPattern)
          Set the property to a group of values.
 void setSortByAssignee(short order)
          If Assignee is part of sorting criteria, only tasks with assignees will be returned.
 void setSortByCanBeAborted(short order)
          Deprecated.  
 void setSortByCanBeReassigned(short order)
          Deprecated.  
 void setSortByCanBeReturned(short order)
          Deprecated.  
 void setSortByClaimant(short order)
           
 void setSortByClaimDueDate(short order)
          Deprecated.  
 void setSortByComment(short order)
           
 void setSortByCompletedDate(short order)
           
 void setSortByCompletionDueDate(short order)
           
 void setSortByCreationDate(short order)
           
 void setSortByDescription(short order)
          Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.
 void setSortByListeningProcessId(short order)
          Deprecated.  
 void setSortByListeningProcessUri(short order)
          Deprecated.  
 void setSortByOwner(short order)
           
 void setSortByParentProcessId(short order)
          Deprecated.  
 void setSortByParentProcessUri(short order)
          Deprecated.  
 void setSortByPriority(short order)
           
 void setSortByPropertyValue(short order)
          Deprecated. use setSortByPropertyValue(String propertyName, short order)
 void setSortByPropertyValue(String propertyName, short order)
          Request that returned tasks or task IDs be sorted by property
 void setSortByStateType(short order)
          Deprecated. Use admin state, working state, and/or current step instead
 void setSortByTaskId(short order)
           
 void setSortByTaskName(short order)
           
 void setStateTypes(StateType[] stateTypes)
          Deprecated. Use admin state, working state, and/or current step instead
 void setTaskIds(String[] taskIds)
           
 void setTaskName(String taskName, boolean isPattern)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskSelector

public TaskSelector()
Construct a new empty task selector. If an empty task selector is passed to the worklist manager, it will return all the tasks in the database with no sorting applied.


TaskSelector

public TaskSelector(TaskSelector selector)
Copy Constructor


TaskSelector

public TaskSelector(String[] taskIds,
                    String taskName,
                    boolean isNamePattern,
                    String description,
                    boolean isDescriptionPattern,
                    String comment,
                    boolean isCommentPattern,
                    String[] owners,
                    String[] claimants,
                    Assignee assignee,
                    Integer minPriority,
                    Integer maxPriority,
                    StateType[] stateTypes,
                    String parentProcessUri,
                    boolean isParentProcessUriPattern,
                    String[] parentProcessIds,
                    String listeningProcessUri,
                    boolean isListeningProcessUriPattern,
                    String[] listeningProcessIds,
                    Date completionDueDateBefore,
                    Date completionDueDateAfter,
                    Date claimDueDateBefore,
                    Date claimDueDateAfter,
                    Date creationDateBefore,
                    Date creationDateAfter,
                    Boolean canBeReassigned,
                    Boolean canBeReturned,
                    Boolean canBeAborted,
                    String propertyName,
                    String propertyValue,
                    boolean isPropertyValuePattern)
Deprecated. 

Construct a new task selector. It allows only one property value to be set.

Parameters:
taskIds - The unique Task identifiers
taskName - The task name
isNamePattern - true if name is a pattern, else false
description - the task description
isDescriptionPattern - true if description is a pattern, else false
comment - the task comment
isCommentPattern - true if comment is a pattern, else false
owners - The task owner
claimants - the task claimant
assignee - the task assignee
minPriority - the minimum priority
maxPriority - the max priority
stateTypes - the states
parentProcessUri - The parent process.
isParentProcessUriPattern - true if parent process uri is a pattern, else false
parentProcessIds - The parent process id
listeningProcessUri - The listening process
isListeningProcessUriPattern - true if listening process uri is a pattern, else false
listeningProcessIds - the listening process ids
completionDueDateBefore - Completion due date before
completionDueDateAfter - Completion due date after
claimDueDateBefore - Claim due date before
claimDueDateAfter - Claim due date after
canBeReassigned - true if task can be re-assigned, else false
canBeReturned - true if task can be returned, else false
canBeAborted - true if task can be aborted, else false
propertyName - a task property name
propertyValue - a task property value
isPropertyValuePattern - true if property value is a pattern, else false

TaskSelector

public TaskSelector(String[] taskIds,
                    String taskName,
                    boolean isNamePattern,
                    String description,
                    boolean isDescriptionPattern,
                    String comment,
                    boolean isCommentPattern,
                    String[] owners,
                    String[] claimants,
                    Assignee assignee,
                    Integer minPriority,
                    Integer maxPriority,
                    StateType[] stateTypes,
                    String parentProcessUri,
                    boolean isParentProcessUriPattern,
                    String[] parentProcessIds,
                    String listeningProcessUri,
                    boolean isListeningProcessUriPattern,
                    String[] listeningProcessIds,
                    Date completionDueDateBefore,
                    Date completionDueDateAfter,
                    Date claimDueDateBefore,
                    Date claimDueDateAfter,
                    Date creationDateBefore,
                    Date creationDateAfter,
                    Boolean canBeReassigned,
                    Boolean canBeReturned,
                    Boolean canBeAborted,
                    String[] propertyNames,
                    String[] propertyValues,
                    boolean[] isPropertyValuePattern)
Deprecated. 

Construct a new task selector. It allows multiple property values to be set.

Parameters:
taskIds - The unique Task identifiers
taskName - The task name
isNamePattern - true if name is a pattern, else false
description - the task description
isDescriptionPattern - true if description is a pattern, else false
comment - the task comment
isCommentPattern - true if comment is a pattern, else false
owners - The task owner
claimants - the task claimant
assignee - the task assignee
minPriority - the minimum priority
maxPriority - the max priority
stateTypes - the states
parentProcessUri - The parent process.
isParentProcessUriPattern - true if parent process uri is a pattern, else false
parentProcessIds - The parent process id
listeningProcessUri - The listening process
isListeningProcessUriPattern - true if listening process uri is a pattern, else false
listeningProcessIds - the listening process ids
completionDueDateBefore - Completion due date before
completionDueDateAfter - Completion due date after
claimDueDateBefore - Claim due date before
claimDueDateAfter - Claim due date after
canBeReassigned - true if task can be re-assigned, else false
canBeReturned - true if task can be returned, else false
canBeAborted - true if task can be aborted, else false
propertyNames - an array of task property names
propertyValues - an array of task property values
isPropertyValuePattern - an array of booleans declaring whether propertyValue is a pattern

TaskSelector

public TaskSelector(String[] taskIds,
                    String taskName,
                    boolean isNamePattern,
                    String description,
                    boolean isDescriptionPattern,
                    String comment,
                    boolean isCommentPattern,
                    String[] owners,
                    String[] claimants,
                    Assignee assignee,
                    Integer minPriority,
                    Integer maxPriority,
                    StateType[] stateTypes,
                    String parentProcessUri,
                    boolean isParentProcessUriPattern,
                    String[] parentProcessIds,
                    String listeningProcessUri,
                    boolean isListeningProcessUriPattern,
                    String[] listeningProcessIds,
                    Date completionDueDateBefore,
                    Date completionDueDateAfter,
                    Date claimDueDateBefore,
                    Date claimDueDateAfter,
                    Date creationDateBefore,
                    Date creationDateAfter,
                    Boolean canBeReassigned,
                    Boolean canBeReturned,
                    Boolean canBeAborted,
                    String propertyName,
                    String propertyValue,
                    boolean isPropertyValuePattern,
                    boolean includeTaskRequest,
                    boolean includeTaskResponse)
Deprecated. 

Construct a new task selector. It allows multiple property values to be set.

Parameters:
taskIds - The unique Task identifiers
taskName - The task name
isNamePattern - true if name is a pattern, else false
description - the task description
isDescriptionPattern - true if description is a pattern, else false
comment - the task comment
isCommentPattern - true if comment is a pattern, else false
owners - The task owner
claimants - the task claimant
assignee - the task assignee
minPriority - the minimum priority
maxPriority - the max priority
stateTypes - the states
parentProcessUri - The parent process.
isParentProcessUriPattern - true if parent process uri is a pattern, else false
parentProcessIds - The parent process id
listeningProcessUri - The listening process
isListeningProcessUriPattern - true if listening process uri is a pattern, else false
listeningProcessIds - the listening process ids
completionDueDateBefore - Completion due date before
completionDueDateAfter - Completion due date after
claimDueDateBefore - Claim due date before
claimDueDateAfter - Claim due date after
creationDateBefore - Task created before
creationDateAfter - Task created after
canBeReassigned - true if task can be re-assigned, else false
canBeReturned - true if task can be returned, else false
canBeAborted - true if task can be aborted, else false
propertyName - a property name
propertyValue - a property value
isPropertyValuePattern - an array of booleans declaring whether propertyValue is a pattern
includeTaskRequest - include the Task Request data in the query response
includeTaskResponse - include the Task Response data in the query response
Since:
8.1.5

TaskSelector

public TaskSelector(String[] taskIds,
                    String taskName,
                    boolean isNamePattern,
                    String description,
                    boolean isDescriptionPattern,
                    String comment,
                    boolean isCommentPattern,
                    String[] owners,
                    String[] claimants,
                    Assignee assignee,
                    Integer minPriority,
                    Integer maxPriority,
                    StateType[] stateTypes,
                    String parentProcessUri,
                    boolean isParentProcessUriPattern,
                    String[] parentProcessIds,
                    String listeningProcessUri,
                    boolean isListeningProcessUriPattern,
                    String[] listeningProcessIds,
                    Date completionDueDateBefore,
                    Date completionDueDateAfter,
                    Date claimDueDateBefore,
                    Date claimDueDateAfter,
                    Date creationDateBefore,
                    Date creationDateAfter,
                    Boolean canBeReassigned,
                    Boolean canBeReturned,
                    Boolean canBeAborted,
                    String[] propertyNames,
                    String[] propertyValues,
                    boolean[] isPropertyValuePattern,
                    boolean includeTaskRequest,
                    boolean includeTaskResponse)
Deprecated. 

Construct a new task selector. It allows multiple property values to be set.

Parameters:
taskIds - The unique Task identifiers
taskName - The task name
isNamePattern - true if name is a pattern, else false
description - the task description
isDescriptionPattern - true if description is a pattern, else false
comment - the task comment
isCommentPattern - true if comment is a pattern, else false
owners - The task owner
claimants - the task claimant
assignee - the task assignee
minPriority - the minimum priority
maxPriority - the max priority
stateTypes - the states
parentProcessUri - The parent process.
isParentProcessUriPattern - true if parent process uri is a pattern, else false
parentProcessIds - The parent process id
listeningProcessUri - The listening process
isListeningProcessUriPattern - true if listening process uri is a pattern, else false
listeningProcessIds - the listening process ids
completionDueDateBefore - Completion due date before
completionDueDateAfter - Completion due date after
claimDueDateBefore - Claim due date before
claimDueDateAfter - Claim due date after
creationDateBefore - Task created before
creationDateAfter - Task created after
canBeReassigned - true if task can be re-assigned, else false
canBeReturned - true if task can be returned, else false
canBeAborted - true if task can be aborted, else false
propertyNames - an array of task property names
propertyValues - an array of task property values
isPropertyValuePattern - an array of booleans declaring whether propertyValue is a pattern
includeTaskRequest - include the Task Request data in the query response
includeTaskResponse - include the Task Response data in the query response
Since:
8.1.5

TaskSelector

public TaskSelector(String[] taskIds,
                    String taskName,
                    boolean isNamePattern,
                    String description,
                    boolean isDescriptionPattern,
                    String comment,
                    boolean isCommentPattern,
                    String[] owners,
                    String[] claimants,
                    Assignee assignee,
                    Integer minPriority,
                    Integer maxPriority,
                    StateType[] stateTypes,
                    String parentProcessUri,
                    boolean isParentProcessUriPattern,
                    String[] parentProcessIds,
                    String listeningProcessUri,
                    boolean isListeningProcessUriPattern,
                    String[] listeningProcessIds,
                    Date completionDueDateBefore,
                    Date completionDueDateAfter,
                    Date claimDueDateBefore,
                    Date claimDueDateAfter,
                    Date creationDateBefore,
                    Date creationDateAfter,
                    Boolean canBeReassigned,
                    Boolean canBeReturned,
                    Boolean canBeAborted,
                    String propertyName,
                    String propertyValue,
                    boolean isPropertyValuePattern,
                    boolean includeTaskRequest,
                    boolean includeTaskResponse,
                    boolean includeTaskProperties)
Deprecated. 

Construct a new task selector. It allows multiple property values to be set.

Parameters:
taskIds - The unique Task identifiers
taskName - The task name
isNamePattern - true if name is a pattern, else false
description - the task description
isDescriptionPattern - true if description is a pattern, else false
comment - the task comment
isCommentPattern - true if comment is a pattern, else false
owners - The task owner
claimants - the task claimant
assignee - the task assignee
minPriority - the minimum priority
maxPriority - the max priority
stateTypes - the states
parentProcessUri - The parent process.
isParentProcessUriPattern - true if parent process uri is a pattern, else false
parentProcessIds - The parent process id
listeningProcessUri - The listening process
isListeningProcessUriPattern - true if listening process uri is a pattern, else false
listeningProcessIds - the listening process ids
completionDueDateBefore - Completion due date before
completionDueDateAfter - Completion due date after
claimDueDateBefore - Claim due date before
claimDueDateAfter - Claim due date after
creationDateBefore - Task created before
creationDateAfter - Task created after
canBeReassigned - true if task can be re-assigned, else false
canBeReturned - true if task can be returned, else false
canBeAborted - true if task can be aborted, else false
propertyName - a task property name
propertyValue - a task property value
isPropertyValuePattern - Do we use a pattern for the propertyValue?
includeTaskRequest - include the Task Request data in the query response
includeTaskResponse - include the Task Response data in the query response
includeTaskProperties - include the Task Properties data in the query response
Since:
8.1.5

TaskSelector

public TaskSelector(String[] taskIds,
                    String taskName,
                    boolean isNamePattern,
                    String description,
                    boolean isDescriptionPattern,
                    String comment,
                    boolean isCommentPattern,
                    String[] owners,
                    String[] claimants,
                    Assignee assignee,
                    Integer minPriority,
                    Integer maxPriority,
                    StateType[] stateTypes,
                    String parentProcessUri,
                    boolean isParentProcessUriPattern,
                    String[] parentProcessIds,
                    String listeningProcessUri,
                    boolean isListeningProcessUriPattern,
                    String[] listeningProcessIds,
                    Date completionDueDateBefore,
                    Date completionDueDateAfter,
                    Date claimDueDateBefore,
                    Date claimDueDateAfter,
                    Date creationDateBefore,
                    Date creationDateAfter,
                    Boolean canBeReassigned,
                    Boolean canBeReturned,
                    Boolean canBeAborted,
                    String[] propertyNames,
                    String[] propertyValues,
                    boolean[] isPropertyValuePattern,
                    boolean includeTaskRequest,
                    boolean includeTaskResponse,
                    boolean includeTaskProperties)
Deprecated. 

Construct a new task selector. It allows multiple property values to be set.

Parameters:
taskIds - The unique Task identifiers
taskName - The task name
isNamePattern - true if name is a pattern, else false
description - the task description
isDescriptionPattern - true if description is a pattern, else false
comment - the task comment
isCommentPattern - true if comment is a pattern, else false
owners - The task owner
claimants - the task claimant
assignee - the task assignee
minPriority - the minimum priority
maxPriority - the max priority
stateTypes - the states
parentProcessUri - The parent process.
isParentProcessUriPattern - true if parent process uri is a pattern, else false
parentProcessIds - The parent process id
listeningProcessUri - The listening process
isListeningProcessUriPattern - true if listening process uri is a pattern, else false
listeningProcessIds - the listening process ids
completionDueDateBefore - Completion due date before
completionDueDateAfter - Completion due date after
claimDueDateBefore - Claim due date before
claimDueDateAfter - Claim due date after
creationDateBefore - Task created before
creationDateAfter - Task created after
canBeReassigned - true if task can be re-assigned, else false
canBeReturned - true if task can be returned, else false
canBeAborted - true if task can be aborted, else false
propertyNames - an array of task property names
propertyValues - an array of task property values
isPropertyValuePattern - an array of booleans declaring whether to use a pattern for the propertyValue
includeTaskRequest - include the Task Request data in the query response
includeTaskResponse - include the Task Response data in the query response
includeTaskProperties - include the Task Properties data in the query response
Since:
8.1.5
Method Detail

getMaxTasksReturned

public int getMaxTasksReturned()

setMaxTasksReturned

public void setMaxTasksReturned(int count)

getTaskIds

public String[] getTaskIds()

setTaskIds

public void setTaskIds(String[] taskIds)

setSortByTaskId

public void setSortByTaskId(short order)

getSortByTaskId

public short getSortByTaskId()

getTaskName

public String getTaskName()

setTaskName

public void setTaskName(String taskName,
                        boolean isPattern)

isTaskNamePattern

public boolean isTaskNamePattern()

setSortByTaskName

public void setSortByTaskName(short order)

getSortByTaskName

public short getSortByTaskName()

getComment

public String getComment()

setComment

public void setComment(String comment,
                       boolean isPattern)

isCommentPattern

public boolean isCommentPattern()

setSortByComment

public void setSortByComment(short order)

getSortByComment

public short getSortByComment()

getDescription

public String getDescription()
Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.

Get the descriptor for the task.


setDescription

public void setDescription(String description,
                           boolean isPattern)
Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.

Set the description of the task.


isDescriptionPattern

public boolean isDescriptionPattern()
Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.

Is the description value to be treated as a selection pattern.


setSortByDescription

public void setSortByDescription(short order)
Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.

Set whether the description value to be sorted, and in what direction and with what precedence with respect to other sort fields.


getSortByDescription

public short getSortByDescription()
Deprecated. Description should be placed in the task plan. Use comment for per-task-instance comments.

Is the description value to be sorted, and in what direction and with what precedence with respect to other sort fields.


getOwners

public String[] getOwners()

setOwners

public void setOwners(String[] owners)

setSortByOwner

public void setSortByOwner(short order)

getSortByOwner

public short getSortByOwner()

getClaimants

public String[] getClaimants()

setClaimants

public void setClaimants(String[] claimants)

setSortByClaimant

public void setSortByClaimant(short order)

getSortByClaimant

public short getSortByClaimant()

getAssignee

public Assignee getAssignee()

setAssignee

public void setAssignee(Assignee assignee)
To search for tasks without assignees, use an Assignee object without user or group. Note that if Assignee is part of sorting criteria, only tasks with assignees will be returned.


setSortByAssignee

public void setSortByAssignee(short order)
If Assignee is part of sorting criteria, only tasks with assignees will be returned.

Parameters:
order -

getSortByAssignee

public short getSortByAssignee()

getStateTypes

public StateType[] getStateTypes()
Deprecated. Use admin state, working state, and/or current step instead.

The task state types. This property is for use by 8.1.x clients only. Setting this property causes the task selection process to assume it is working with the Compatibility 8.1.x task plan and will select tasks that have a current step name matching the name of the states you set here.


setStateTypes

public void setStateTypes(StateType[] stateTypes)
Deprecated. Use admin state, working state, and/or current step instead

For querying tasks at different states, use the static constants in the StateType class instead of using the constructor. This property is for use by 8.1.x clients only. Setting this property causes the task selection process to assume it is working with the Compatibility 8.1.x task plan and will select tasks that have a current step name matching the name of the states you set here.

Parameters:
stateTypes - an array of state types

setSortByStateType

public void setSortByStateType(short order)
Deprecated. Use admin state, working state, and/or current step instead

Parameters:
order -

getSortByStateType

public short getSortByStateType()
Deprecated. Use admin state, working state, and/or current step instead


getParentProcessUri

public String getParentProcessUri()
Deprecated. 


setParentProcessUri

public void setParentProcessUri(String parentProcessUri,
                                boolean isPattern)
Deprecated. 


isParentProcessUriPattern

public boolean isParentProcessUriPattern()
Deprecated. 


setSortByParentProcessUri

public void setSortByParentProcessUri(short order)
Deprecated. 


getSortByParentProcessUri

public short getSortByParentProcessUri()
Deprecated. 


getParentProcessIds

public String[] getParentProcessIds()
Deprecated. 


setParentProcessIds

public void setParentProcessIds(String[] parentProcessIds)
Deprecated. 


setSortByParentProcessId

public void setSortByParentProcessId(short order)
Deprecated. 


getSortByParentProcessId

public short getSortByParentProcessId()
Deprecated. 


getListeningProcessUri

public String getListeningProcessUri()
Deprecated. 


setListeningProcessUri

public void setListeningProcessUri(String listeningProcessUri,
                                   boolean isPattern)
Deprecated. 


isListeningProcessUriPattern

public boolean isListeningProcessUriPattern()
Deprecated. 


setSortByListeningProcessUri

public void setSortByListeningProcessUri(short order)
Deprecated. 


getSortByListeningProcessUri

public short getSortByListeningProcessUri()
Deprecated. 


getListeningProcessIds

public String[] getListeningProcessIds()
Deprecated. 


setListeningProcessIds

public void setListeningProcessIds(String[] listeningProcessIds)
Deprecated. 


setSortByListeningProcessId

public void setSortByListeningProcessId(short order)
Deprecated. 


getSortByListeningProcessId

public short getSortByListeningProcessId()
Deprecated. 


getCompletionDueDateBefore

public Date getCompletionDueDateBefore()

getCompletionDueDateAfter

public Date getCompletionDueDateAfter()

setCompletionDueDateBefore

public void setCompletionDueDateBefore(Date completionDueDateBefore)

setCompletionDueDateAfter

public void setCompletionDueDateAfter(Date completionDueDateAfter)

setSortByCompletionDueDate

public void setSortByCompletionDueDate(short order)

getSortByCompletionDueDate

public short getSortByCompletionDueDate()

getClaimDueDateBefore

public Date getClaimDueDateBefore()
Deprecated. 


getClaimDueDateAfter

public Date getClaimDueDateAfter()
Deprecated. 


setClaimDueDateBefore

public void setClaimDueDateBefore(Date claimDueDateBefore)
Deprecated. 


setClaimDueDateAfter

public void setClaimDueDateAfter(Date claimDueDateAfter)
Deprecated. 


setSortByClaimDueDate

public void setSortByClaimDueDate(short order)
Deprecated. 


getSortByClaimDueDate

public short getSortByClaimDueDate()
Deprecated. 


getCreationDateBefore

public Date getCreationDateBefore()

getCreationDateAfter

public Date getCreationDateAfter()

setCreationDateBefore

public void setCreationDateBefore(Date creationDateBefore)

setCreationDateAfter

public void setCreationDateAfter(Date creationDateAfter)

setSortByCreationDate

public void setSortByCreationDate(short order)

getSortByCreationDate

public short getSortByCreationDate()

getCanBeReassigned

public Boolean getCanBeReassigned()
Deprecated. 


setCanBeReassigned

public void setCanBeReassigned(Boolean canBeReassigned)
Deprecated. 


setSortByCanBeReassigned

public void setSortByCanBeReassigned(short order)
Deprecated. 


getSortByCanBeReassigned

public short getSortByCanBeReassigned()
Deprecated. 


getCanBeReturned

public Boolean getCanBeReturned()
Deprecated. 


setCanBeReturned

public void setCanBeReturned(Boolean canBeReturned)
Deprecated. 


setSortByCanBeReturned

public void setSortByCanBeReturned(short order)
Deprecated. 


getSortByCanBeReturned

public short getSortByCanBeReturned()
Deprecated. 


getCanBeAborted

public Boolean getCanBeAborted()
Deprecated. 


setCanBeAborted

public void setCanBeAborted(Boolean canBeAborted)
Deprecated. 


setSortByCanBeAborted

public void setSortByCanBeAborted(short order)
Deprecated. 


getSortByCanBeAborted

public short getSortByCanBeAborted()
Deprecated. 


getMinPriority

public Integer getMinPriority()

getMaxPriority

public Integer getMaxPriority()

setMinPriority

public void setMinPriority(Integer minPriority)

setMaxPriority

public void setMaxPriority(Integer maxPriority)

setSortByPriority

public void setSortByPriority(short order)

getSortByPriority

public short getSortByPriority()

addProperty

public void addProperty(String propertyName,
                        String propertyValue,
                        boolean isPattern)
Parameters:
propertyName -
propertyValue -
isPattern -

addProperty

public void addProperty(String propertyName,
                        String[] propertyValues,
                        boolean isPattern)
Parameters:
propertyName -
propertyValue -
isPattern -

addProperties

public void addProperties(String[] propertyNames,
                          String[] propertyValues,
                          boolean[] isPatternFlags)

getPropertyValue

public String getPropertyValue()
Deprecated. Use getPropertyValue(String propertyName)

Returns:
property value
See Also:
getPropertyValue(String)

getPropertyValue

public String getPropertyValue(String propertyName)
Deprecated. Use getPropertyValues(String propertyName)

Get the property value for the given property. It throws IllegalArgumentException if the property name has not previously been set.

Parameters:
propertyName -
Returns:
propertyValue

getPropertyValues

public String[] getPropertyValues(String propertyName)
Get the property values for the given property. It throws IllegalArgumentException if the property name has not previously been set.

Parameters:
propertyName -
Returns:
propertyValues

setPropertyValue

public void setPropertyValue(String propertyName,
                             String propertyValue,
                             boolean isPattern)
Set the property to the new iarray of values. It throws IllegalArgumentException if no property name has previously been set.

Parameters:
propertyName -
propertyValue -
isPattern -

setPropertyValues

public void setPropertyValues(String propertyName,
                              String[] propertyValues,
                              boolean isPattern)
Set the property to a group of values. If the propery value matches one of the values the task will be returned by the query. Mutually exclusive with the setPropertyValue method. Setting one nulls the other. It throws IllegalArgumentException if no property name has previously been set.

Parameters:
propertyName -
propertyValues -
isPattern -

setPropertyValue

public void setPropertyValue(String propertyValue,
                             boolean isPattern)
Deprecated. Use setPropertyValue(String propertyName, String propertyValue, boolean isPattern)

Set the property to the new value. It throws IllegalArgumentException if the property name has not previously been set.

Parameters:
propertyValue -
isPattern -
See Also:
setPropertyValue(String,String,boolean)

getPropertyName

public String getPropertyName()
Deprecated. Use getPropertyNames() instead.

Returns:
A single property name.
See Also:
getPropertyNames()

getPropertyNames

public String[] getPropertyNames()
Returns:
An array of property names that have been set or null if none have been set.

setPropertyName

public void setPropertyName(String propertyName)

setPropertyNames

public void setPropertyNames(String[] propertyNames)

isPropertyValuePattern

public boolean isPropertyValuePattern()
Deprecated. Use isPropertyValuePattern(String propertyName)

See Also:
isPropertyValuePattern(String)

isPropertyValuePattern

public boolean isPropertyValuePattern(String propertyName)
To check if the property value is a pattern. It throws IllegalArgumentException if the property name has not previously been set.


setSortByPropertyValue

public void setSortByPropertyValue(short order)
Deprecated. use setSortByPropertyValue(String propertyName, short order)

Request that returned tasks or task IDs be sorted by property

Parameters:
order -
Throws:
IllegalArgumentException - if setSortByPropertyValue(String propertyName, short order) has already been called.

getSortByPropertyValue

public short getSortByPropertyValue()
Deprecated. use getSortByPropertyValue(String propertyName)

Returns:

setSortByPropertyValue

public void setSortByPropertyValue(String propertyName,
                                   short order)
Request that returned tasks or task IDs be sorted by property

Parameters:
propertyName - the name of the propery to sort on
order - the sort order for this property
Throws:
IllegalArgumentException - if setSortByPropertyValue(short order) has already been called.

getSortByPropertyValue

public short getSortByPropertyValue(String propertyName)
Get the sort value for a given property name, if previously specified.

Parameters:
propertyName - the name of the propery to sort on
Returns:
the sort value.
Throws:
IllegalArgumentException - if setSortByPropertyValue(short order) has already been called.

getSortByPropertyMap

public Map getSortByPropertyMap()

getIncludeTaskRequestMessage

public boolean getIncludeTaskRequestMessage()
Deprecated. 


setIncludeTaskRequestMessage

public void setIncludeTaskRequestMessage(boolean include)
Deprecated. 


getIncludeTaskResponseMessage

public boolean getIncludeTaskResponseMessage()
Deprecated. 


setIncludeTaskResponseMessage

public void setIncludeTaskResponseMessage(boolean include)
Deprecated. 


getIncludeTaskProperties

public boolean getIncludeTaskProperties()

setIncludeTaskProperties

public void setIncludeTaskProperties(boolean include)

getIncludedPropertyNames

public List<String> getIncludedPropertyNames()

setIncludedPropertyNames

public void setIncludedPropertyNames(List<String> propNames)

getCompletedDateBefore

public Date getCompletedDateBefore()
Since:
8.1.4

getCompletedDateAfter

public Date getCompletedDateAfter()
Since:
8.1.4

setCompletedDateBefore

public void setCompletedDateBefore(Date completedDateBefore)
Parameters:
completedDateBefore -
Since:
8.1.4

setCompletedDateAfter

public void setCompletedDateAfter(Date completedDateAfter)
Parameters:
completedDateAfter -
Since:
8.1.4

setSortByCompletedDate

public void setSortByCompletedDate(short order)
Since:
8.1.4

getSortByCompletedDate

public short getSortByCompletedDate()
Since:
8.1.4

isSingleton

public boolean isSingleton()