public class TaskList extends JWPRequest implements java.lang.Iterable<Task>
Modifier and Type | Class and Description |
---|---|
static class |
TaskList.DateRange
Type of the time frame in a combined task selection.
|
Constructor and Description |
---|
TaskList(TaskFilter taskFilter,
java.lang.String... selectedFields)
Creates a new
TaskList request. |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.Integer> |
getExpandedRunIds()
Gets the expanded RunIds.
|
void |
includeHistoricalData()
Call this method before sending the request to include statistics data in addition to the tasks in the activity list.
|
boolean |
isTreeMode() |
java.util.Iterator<Task> |
iterator()
Returns an iterator over the
Task elements in this activity list. |
void |
setClient(int client)
Sets a specific client as filter for the
TaskList . |
void |
setDateSelectionLast(TaskList.DateRange type,
int amount,
TaskFilter.TimeUnit unit)
Sets a time range filter for the last minutes, hours or days.
|
void |
setDateSelectionRange(TaskList.DateRange type,
DateTime from,
DateTime to)
Sets a time interval.
|
void |
setExpandedRunIds(java.util.List<java.lang.Integer> runIds)
Sets the RundIds of Tasks that should be expanded.
|
void |
setTreeMode(boolean treeMode) |
int |
size()
Returns the number of tasks.
|
getMessageBox, getRequestID, handleResponse, send
public TaskList(TaskFilter taskFilter, java.lang.String... selectedFields)
TaskList
request.taskFilter
- the task filterselectedFields
- Fields which should be returned.
If no field is selected all fields are returned.
Possible values are:
Name | Description |
OBJECT_NAME | Name of the object. |
ALIAS_NAME | Name of the object or alias |
OBJECT_TYPE | Object type |
AGENT_NAME | Name of the Agent |
PARENT_PROCESSOR_RUNID | RunID of the parent processor |
STATUS_WITHIN_PARENT | Status within a workflow |
CONTAINER_TYPE | Type of the container, used for icon |
STARTED_BY_AE | Is a JOBD monitored or started by the AE. Used for the icon only |
COMMENT_FLAG | Is this execution commented? |
END_TIME | End time of the task. |
START_TIME | Start time of the task. |
USER_ID | User who started this task. |
PLATFORM | Platform |
TREE_PARENT | RunID of the parent in the tree view |
PERIOD_DESCRIPTION | Description of PERIOD objects. |
REMOTE_STATUS_ID | Translation ID of the remote status. |
REMOTE_STATUS_INSERT | Remote status insert. |
CPU_TIME | CPU time. |
RESOURCE | Resource count |
QUEUE | Name of the Queue. |
PROCESS_ID | Process ID |
START_TYPE | Start type |
STATUS | Status of the task |
RUNID | RunID of the task. |
PRIORITY | Priority |
LOGIN | Login object |
ALIAS_NAME | Alias name |
ARCHIVE_KEY1 | Archive key 1 |
ARCHIVE_KEY2 | Archive Key 2 |
PROCESSOR_TASK | Flag which indicates if this task is parent processor or not |
public void includeHistoricalData()
public void setDateSelectionRange(TaskList.DateRange type, DateTime from, DateTime to)
type
- Selection typefrom
- Start of the time intervalto
- End of the time intervalpublic void setDateSelectionLast(TaskList.DateRange type, int amount, TaskFilter.TimeUnit unit)
type
- Selection typeamount
- Number of minutes, hours or daysunit
- Time unitpublic void setClient(int client)
TaskList
. This method is only used for client 0.
For all clients other 0 it has no effect.client
- filter for the TaskList
public java.util.Iterator<Task> iterator()
Task
elements in this activity list.iterator
in interface java.lang.Iterable<Task>
public int size()
public boolean isTreeMode()
public void setTreeMode(boolean treeMode)
treeMode
- to set hierarchical view modepublic void setExpandedRunIds(java.util.List<java.lang.Integer> runIds)
TaskList
is used in tree modus.runIds
- RundIds of the tasks, that should be expanded.public java.util.List<java.lang.Integer> getExpandedRunIds()
TaskList
is used in tree modus.