|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bea.wli.worklist.api.TaskSelector
com.bea.wli.worklist.api.TaskQuery
public final class TaskQuery
TaskQuery 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\%%
Constructor Summary | |
---|---|
TaskQuery()
Construct a new empty task query. |
|
TaskQuery(TaskQuery query)
|
|
TaskQuery(TaskSelector selector)
|
Method Summary | |
---|---|
AdminState.Type[] |
getAdminStates()
|
boolean |
getCompletionDueDateIsNull()
Should the query look for null completion due date values. |
String[] |
getCurrentStepNames()
|
boolean |
getIncludeTaskAssignee()
Should we retrieve assignee information along with the TaskData? |
boolean |
getIncludeTasksFromOtherHostApps()
Should we retrieve task instances from other applications in the domain? This flag will be ignored if task plan ids are set on the task query. |
boolean |
getIncludeTaskStepTimeEstimates()
Should we retrieve step time estimate information along with the TaskData? Defaults to true. |
String |
getListeningControlHandleStringValue()
|
String |
getParentControlHandleStringValue()
|
short |
getSortByAdminState()
|
short |
getSortByCurrentStepName()
|
short |
getSortByListeningControlHandleStringValue()
|
short |
getSortByParentControlHandleStringValue()
|
short |
getSortByTaskPlanId()
|
short |
getSortByWorkingState()
|
TaskPlanId[] |
getTaskPlanIds()
|
WorkingState.Type[] |
getWorkingStates()
|
boolean |
isListeningControlHandleStringValuePattern()
|
boolean |
isParentControlHandleStringValuePattern()
|
void |
setAdminStates(AdminState.Type[] states)
For querying tasks at different admin states, use the Type enum in the AdminState class. |
void |
setCompletionDueDateIsNull(boolean completionDueDateIsNull)
Should the query look for null completion due date values. |
void |
setCurrentStepNames(String[] steps)
For querying tasks at different steps. |
void |
setIncludeTaskAssignee(boolean include)
Should we retrieve assignee information along with the TaskData? Defaults to true. |
void |
setIncludeTasksFromOtherHostApps(boolean include)
Should we retrieve task instances from other applications in the domain? This flag will be ignored if task plan ids are set on the task query. |
void |
setIncludeTaskStepTimeEstimates(boolean include)
Should we retrieve step time estimate information along with the TaskData? Defaults to true. |
void |
setListeningControlHandleStringValue(String value,
boolean isPattern)
|
void |
setParentControlHandleStringValue(String value,
boolean isPattern)
|
void |
setSortByAdminState(short order)
|
void |
setSortByCurrentStepName(short order)
|
void |
setSortByListeningControlHandleStringValue(short order)
|
void |
setSortByParentControlHandleStringValue(short order)
|
void |
setSortByTaskPlanId(short order)
|
void |
setSortByWorkingState(short order)
|
void |
setTaskPlanIds(TaskPlanId[] types)
For querying tasks of different types. |
void |
setWorkingStates(WorkingState.Type[] states)
For querying tasks at different working states, use the Type enum in the WorkingState class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TaskQuery()
public TaskQuery(TaskSelector selector)
public TaskQuery(TaskQuery query)
Method Detail |
---|
public boolean getCompletionDueDateIsNull()
public void setCompletionDueDateIsNull(boolean completionDueDateIsNull)
public AdminState.Type[] getAdminStates()
public void setAdminStates(AdminState.Type[] states)
states
- an array of admin statespublic void setSortByAdminState(short order)
public short getSortByAdminState()
public WorkingState.Type[] getWorkingStates()
public void setWorkingStates(WorkingState.Type[] states)
states
- an array of working statespublic void setSortByWorkingState(short order)
public short getSortByWorkingState()
public String getParentControlHandleStringValue()
public void setParentControlHandleStringValue(String value, boolean isPattern)
public boolean isParentControlHandleStringValuePattern()
public void setSortByParentControlHandleStringValue(short order)
public short getSortByParentControlHandleStringValue()
public String getListeningControlHandleStringValue()
public void setListeningControlHandleStringValue(String value, boolean isPattern)
public boolean isListeningControlHandleStringValuePattern()
public void setSortByListeningControlHandleStringValue(short order)
public short getSortByListeningControlHandleStringValue()
public TaskPlanId[] getTaskPlanIds()
public void setTaskPlanIds(TaskPlanId[] types)
types
- an array of task plan idspublic void setSortByTaskPlanId(short order)
public short getSortByTaskPlanId()
public String[] getCurrentStepNames()
public void setCurrentStepNames(String[] steps)
steps
- an array of current step idspublic void setSortByCurrentStepName(short order)
public short getSortByCurrentStepName()
public boolean getIncludeTaskAssignee()
public void setIncludeTaskAssignee(boolean include)
public boolean getIncludeTaskStepTimeEstimates()
public void setIncludeTaskStepTimeEstimates(boolean include)
public boolean getIncludeTasksFromOtherHostApps()
public void setIncludeTasksFromOtherHostApps(boolean include)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |