Object
Serializable
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:
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.setSortByPriority((short)1);
setSortByTaskName((short)-2);
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\%%
Object
TaskSelector
Serializable
Constructor Summary |
|
|
|
Method Summary |
public void |
|
public void |
|
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public int | |
public | |
public | |
public | |
public | |
public | |
public | |
public | |
public |
|
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public short | |
public | |
public | |
public | |
public boolean | |
public boolean | |
public boolean | |
public boolean | |
public boolean | |
public boolean |
|
public boolean | |
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void | |
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public 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)
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)
Method Detail |
public void addProperties(String
[] propertyNames,String
[] propertyValues, boolean[] isPatternFlags)
public void addProperty(String
propertyName,String
propertyValue, boolean isPattern)
public Assignee
getAssignee()
public Boolean
getCanBeAborted()
public Boolean
getCanBeReassigned()
public Boolean
getCanBeReturned()
public String
[] getClaimants()
public Date
getClaimDueDateAfter()
public Date
getClaimDueDateBefore()
public String
getComment()
public Date
getCompletedDateAfter()
public Date
getCompletedDateBefore()
public Date
getCompletionDueDateAfter()
public Date
getCompletionDueDateBefore()
public Date
getCreationDateAfter()
public Date
getCreationDateBefore()
public String
getDescription()
public String
[] getListeningProcessIds()
public String
getListeningProcessUri()
public Integer
getMaxPriority()
public int getMaxTasksReturned()
public Integer
getMinPriority()
public String
[] getOwners()
public String
[] getParentProcessIds()
public String
getParentProcessUri()
DEPRECATED Use com.bea.wli.worklist.api.TaskSelector.getPropertyNames()
instead.
public String
getPropertyName()
Related Topics
TaskSelector.getPropertyNames()
public String
[] getPropertyNames()
DEPRECATED Use com.bea.wli.worklist.api.TaskSelector.getPropertyValue(java.lang.String)
public String
getPropertyValue()
Related Topics
TaskSelector.getPropertyValue(String)
publicGet the property value for the given property. It throws IllegalArgumentException if the property name has not previously been set.String
getPropertyValue(String
propertyName)
public short getSortByAssignee()
public short getSortByCanBeAborted()
public short getSortByCanBeReassigned()
public short getSortByCanBeReturned()
public short getSortByClaimant()
public short getSortByClaimDueDate()
public short getSortByComment()
public short getSortByCompletedDate()
public short getSortByCompletionDueDate()
public short getSortByCreationDate()
public short getSortByDescription()
public short getSortByListeningProcessId()
public short getSortByListeningProcessUri()
public short getSortByOwner()
public short getSortByParentProcessId()
public short getSortByParentProcessUri()
public short getSortByPriority()
public short getSortByPropertyValue()
public short getSortByStateType()
public short getSortByTaskId()
public short getSortByTaskName()
public StateType
[] getStateTypes()
public String
[] getTaskIds()
public String
getTaskName()
public boolean isCommentPattern()
public boolean isDescriptionPattern()
public boolean isListeningProcessUriPattern()
public boolean isParentProcessUriPattern()
DEPRECATED Use com.bea.wli.worklist.api.TaskSelector.isPropertyValuePattern(java.lang.String)
public boolean isPropertyValuePattern()
Related Topics
TaskSelector.isPropertyValuePattern(String)
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.
public boolean isTaskNamePattern()
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.
public void setCanBeAborted(Boolean
canBeAborted)
public void setCanBeReassigned(Boolean
canBeReassigned)
public void setCanBeReturned(Boolean
canBeReturned)
public void setClaimants(String
[] claimants)
public void setClaimDueDateAfter(Date
claimDueDateAfter)
public void setClaimDueDateBefore(Date
claimDueDateBefore)
public void setComment(String
comment,
boolean isPattern)
public void setCompletedDateAfter(Date
completedDateAfter)
public void setCompletedDateBefore(Date
completedDateBefore)
public void setCompletionDueDateAfter(Date
completionDueDateAfter)
public void setCompletionDueDateBefore(Date
completionDueDateBefore)
public void setCreationDateAfter(Date
creationDateAfter)
public void setCreationDateBefore(Date
creationDateBefore)
public void setDescription(String
description,
boolean isPattern)
public void setListeningProcessIds(String
[] listeningProcessIds)
public void setListeningProcessUri(String
listeningProcessUri,
boolean isPattern)
public void setMaxPriority(Integer
maxPriority)
public void setMaxTasksReturned(int count)
public void setMinPriority(Integer
minPriority)
public void setOwners(String
[] owners)
public void setParentProcessIds(String
[] parentProcessIds)
public void setParentProcessUri(String
parentProcessUri,
boolean isPattern)
public void setPropertyName(String
propertyName)
public void setPropertyNames(String
[] propertyNames)
public void setPropertyValue(Set the property to the new value. It throws IllegalArgumentException if no property name has previously been set.String
propertyName,String
propertyValue, boolean isPattern)
DEPRECATED Use com.bea.wli.worklist.api.TaskSelector.setPropertyValue(java.lang.String, java.lang.String, boolean)
public void setPropertyValue(String
propertyValue,
boolean isPattern)
Set the property to the new value. It throws IllegalArgumentException if the property
name has not previously been set.
Related Topics
TaskSelector.setPropertyValue(String, String, boolean)
public void setSortByAssignee(short order)If Assignee is part of sorting criteria, only tasks with assignees will be returned.
public void setSortByCanBeAborted(short order)
public void setSortByCanBeReassigned(short order)
public void setSortByCanBeReturned(short order)
public void setSortByClaimant(short order)
public void setSortByClaimDueDate(short order)
public void setSortByComment(short order)
public void setSortByCompletedDate(short order)
public void setSortByCompletionDueDate(short order)
public void setSortByCreationDate(short order)
public void setSortByDescription(short order)
public void setSortByListeningProcessId(short order)
public void setSortByListeningProcessUri(short order)
public void setSortByOwner(short order)
public void setSortByParentProcessId(short order)
public void setSortByParentProcessUri(short order)
public void setSortByPriority(short order)
public void setSortByPropertyValue(short order)
public void setSortByStateType(short order)
public void setSortByTaskId(short order)
public void setSortByTaskName(short order)
public void setStateTypes(StateType
[] stateTypes)
For querying tasks at different states, use the static constants in the StateType class
instead of using the constructor.
public void setTaskIds(String
[] taskIds)
public void setTaskName(String
taskName,
boolean isPattern)