|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.workflow.TaskQueryOptions
public class TaskQueryOptions
A bean which holds filtering and sorting criteria to be used when
querying for tasks. In particular, this class is used to specify
additional restrictions to be put on TaskInfos returned by all the
getActiveTasks
and getAllTasks
methods,
in both WorkflowManager and WorkflowView.
Here are some specific examples of how task information can be filtered:
processName
property is specified, only the
tasks in the corresponding workflow process are returned
processName
and segmentName
properties are specified, only the tasks in the corresponding
workflow process segment are returned
processName
, segmentName
, and
taskElementIds
properties are specified, only the
tasks in the corresponding workflow process segment and with the
specified process element ids are returned
TaskInfo
,
WorkflowManager
,
WorkflowView
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Constructor Summary | |
---|---|
TaskQueryOptions(java.util.Comparator pSorter)
Constructs a new TaskQueryOptions object with the given sorter. |
|
TaskQueryOptions(java.lang.String pProcessName)
Constructs a new TaskQueryOptions object with the given process name. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.util.Comparator pSorter)
Constructs a new TaskQueryOptions object with the given process name and sorter. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.lang.String pSegmentName)
Constructs a new TaskQueryOptions object with the given process name and segment name. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.lang.String pSegmentName,
java.util.Comparator pSorter)
Constructs a new TaskQueryOptions object with the given process name, segment name, and sorter. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.lang.String pSegmentName,
java.lang.String pTaskElementId)
Constructs a new TaskQueryOptions object with the given process name, segment name, and task element id. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.lang.String pSegmentName,
java.lang.String[] pTaskElementIds)
Constructs a new TaskQueryOptions object with the given process name, segment name, and task element ids. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.lang.String pSegmentName,
java.lang.String[] pTaskElementIds,
java.util.Comparator pSorter)
Constructs a new TaskQueryOptions object with the given process name, segment name, task element ids, and sorter. |
|
TaskQueryOptions(java.lang.String pProcessName,
java.lang.String pSegmentName,
java.lang.String pTaskElementId,
java.util.Comparator pSorter)
Constructs a new TaskQueryOptions object with the given process name, segment name, task element id, and sorter. |
Method Summary | |
---|---|
java.lang.String |
getProcessName()
Returns the name of the workflow process for which task information should be returned. |
java.lang.String |
getSegmentName()
Returns the name of the workflow process segment for which task information should be returned. |
java.util.Comparator |
getSorter()
Returns the Comparator to use when sorting tasks. |
java.lang.String[] |
getTaskElementIds()
Returns the process element ids of the task elements in the workflow for which task information should be returned. |
void |
setProcessName(java.lang.String pProcessName)
Sets the name of the workflow process for which task information should be returned. |
void |
setSegmentName(java.lang.String pSegmentName)
Sets the name of the workflow process segment for which task information should be returned. |
void |
setSorter(java.util.Comparator pSorter)
Sets the Comparator to use when sorting tasks. |
void |
setTaskElementIds(java.lang.String[] pTaskElementIds)
Sets the process element ids of the task elements in the workflow for which task information should be returned. |
java.lang.String |
toString()
Returns a String representation of this TaskQueryOptions object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public TaskQueryOptions(java.util.Comparator pSorter)
pSorter
- a Comparator to be used when sorting TaskInfospublic TaskQueryOptions(java.lang.String pProcessName)
pProcessName
- the name of the workflow process for which
task information should be returnedpublic TaskQueryOptions(java.lang.String pProcessName, java.util.Comparator pSorter)
pProcessName
- the name of the workflow process for which
task information should be returnedpSorter
- a Comparator to be used when sorting TaskInfospublic TaskQueryOptions(java.lang.String pProcessName, java.lang.String pSegmentName)
pProcessName
- the name of the workflow process for which
task information should be returnedpSegmentName
- the name of the workflow process segment for
which task information should be returnedpublic TaskQueryOptions(java.lang.String pProcessName, java.lang.String pSegmentName, java.util.Comparator pSorter)
pProcessName
- the name of the workflow process for which
task information should be returnedpSegmentName
- the name of the workflow process segment for
which task information should be returnedpSorter
- a Comparator to be used when sorting TaskInfospublic TaskQueryOptions(java.lang.String pProcessName, java.lang.String pSegmentName, java.lang.String pTaskElementId)
pProcessName
- the name of the workflow process for which
task information should be returnedpSegmentName
- the name of the workflow process segment for
which task information should be returnedpTaskElementId
- the process element id of the task element
for which task information should be returnedpublic TaskQueryOptions(java.lang.String pProcessName, java.lang.String pSegmentName, java.lang.String pTaskElementId, java.util.Comparator pSorter)
pProcessName
- the name of the workflow process for which
task information should be returnedpSegmentName
- the name of the workflow process segment for
which task information should be returnedpTaskElementId
- the process element id of the task element
for which task information should be returnedpSorter
- a Comparator to be used when sorting TaskInfospublic TaskQueryOptions(java.lang.String pProcessName, java.lang.String pSegmentName, java.lang.String[] pTaskElementIds)
pProcessName
- the name of the workflow process for which
task information should be returnedpSegmentName
- the name of the workflow process segment for
which task information should be returnedpTaskElementIds
- the process element ids of the task
elements for which task information should be returnedpublic TaskQueryOptions(java.lang.String pProcessName, java.lang.String pSegmentName, java.lang.String[] pTaskElementIds, java.util.Comparator pSorter)
pProcessName
- the name of the workflow process for which
task information should be returnedpSegmentName
- the name of the workflow process segment for
which task information should be returnedpTaskElementIds
- the process element ids of the task
elements for which task information should be returnedpSorter
- a Comparator to be used when sorting TaskInfosMethod Detail |
---|
public java.lang.String getProcessName()
public void setProcessName(java.lang.String pProcessName)
public java.lang.String getSegmentName()
processName
property is not null. If null,
information for tasks associated with all segments of the
specified workflow will be returned.
public void setSegmentName(java.lang.String pSegmentName)
public java.lang.String[] getTaskElementIds()
processName
and segmentName
properties are not null. If null,
information for all tasks associated with the specified workflow
segment will be returned.
public void setTaskElementIds(java.lang.String[] pTaskElementIds)
public java.util.Comparator getSorter()
public void setSorter(java.util.Comparator pSorter)
equals
method must be implemented to compare two
TaskInfo objects.
TaskInfo
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |