public class TaskList extends XMLRequest 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 |
---|---|
protected void |
createRequest(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element request,
ConnectionAttributes sessionInfo)
Creates the XML Document for the request.
|
java.lang.String |
getAlias()
Returns the alias.
|
boolean |
getCommentFlag()
Returns commented flag.
|
java.util.List<java.lang.Integer> |
getExpandedRunIds()
Gets the expanded RunIds.
|
java.lang.String |
getHost()
Gets the host.
|
boolean |
getModifyFlag()
Returns modify flag.
|
java.lang.String |
getMsgInsert()
Returns remote status insert.
|
int |
getMsgNumber()
Returns remote status number.
|
int |
getRunID()
Returns runID.
|
java.util.List<java.lang.Integer> |
getRunIDs()
Returns the filter for multiple RunIDs or null if there is no filter.
|
java.lang.String |
getSourceDestHost()
Returns the source host.
|
protected java.lang.String |
getSrc()
Returns the request source.
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
void |
includeHistoricalData()
Call this method before sending the request to include statistics data in addition to the tasks in the activity list.
|
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
boolean |
isExcludeHost()
Checks if is exclude host.
|
boolean |
isLimitReached() |
boolean |
isTreeMode() |
java.util.Iterator<Task> |
iterator()
Returns an iterator over the
Task elements in this activity list. |
void |
setAlias(java.lang.String alias)
Sets the filter for the alias.
|
void |
setCauVersion(java.lang.String cauVersion)
Sets the filter for the Version of the Agent.
|
void |
setClient(int client)
Sets a specific client as filter for the
TaskList . |
void |
setCommentFlag(boolean commentFlag)
Sets comment flag.
|
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 |
setExcludeHost(boolean excludeHost)
Sets the exclude host.
|
void |
setExpandedRunIds(java.util.List<java.lang.Integer> runIds)
Sets the RundIds of Tasks that should be expanded.
|
void |
setGroupingType(ActivityList.GroupingType groupingType)
Sets the grouping type for the activity window.
|
void |
setHost(java.lang.String host)
Sets the host.
|
void |
setMaxRows(int maxRows)
Used to limit the number of returned tasks.
|
void |
setModifyFlag(boolean modifyFlag)
Sets modify flag.
|
void |
setMsgInsert(java.lang.String msgInsert)
Sets remote status insert.
|
void |
setMsgNumber(int msgNumber)
Sets remote status number.
|
void |
setRemoteContextName(java.lang.String remoteContextName)
Sets the filter for the remote context name.
|
void |
setRemoteContextValue(java.lang.String remoteContextValue)
Sets the filter for the remote context value.
|
void |
setRunID(int runID)
Sets runID.
|
void |
setRunIDs(java.util.List<java.lang.Integer> runIDs)
Sets List of runIDs.
|
void |
setSourceDestHost(java.lang.String sourceDestHost)
Sets the filter for the source host.
|
void |
setSyncObjectNames(java.util.Set<java.lang.String> syncObjectNames)
Sets the filter for SYNC objects.
|
void |
setTreeMode(boolean treeMode) |
void |
setZduVersion(java.lang.String zduVersion)
Sets the ZDU version filter.
|
int |
size()
Returns the number of tasks.
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
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. |
ACTIVATION_TIME | Activation 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 |
ROLLBACK_FLAG | Flag if rollback is enabled |
ARCHIVE_KEY1 | Archive key 1 |
ARCHIVE_KEY2 | Archive Key 2 |
ZDU_VERSION | ZDU Version |
PROCESSOR_TASK | Flag which indicates if this task is parent processor or not |
RETURN_CODE | User return code of the task |
INT_ACCOUNT | Account |
VERSION | Version of the object |
public void setCauVersion(java.lang.String cauVersion)
cauVersion
- Agent Version, use null to clear the filterpublic void setZduVersion(java.lang.String zduVersion)
zduVersion
- "B" (Base) or "T" (Target) or null
to clear the filterpublic void includeHistoricalData()
public void setMaxRows(int maxRows)
maxRows
- Maximum number of rows, value between 1 and GENERIC_ACTIVITIES_LIMITjava.lang.IllegalArgumentException
- if the value is negative or zero or larger than the allowed maximum GENERIC_ACTIVITIES_LIMIT: 20000public void setSourceDestHost(java.lang.String sourceDestHost)
sourceDestHost
- source hostpublic java.lang.String getSourceDestHost()
public void setAlias(java.lang.String alias)
alias
- new aliaspublic java.lang.String getAlias()
public void setCommentFlag(boolean commentFlag)
commentFlag
- new commented flagpublic boolean getCommentFlag()
public void setModifyFlag(boolean modifyFlag)
modifyFlag
- new modify flagpublic void setGroupingType(ActivityList.GroupingType groupingType)
groupingType
- GroupingType
public void setSyncObjectNames(java.util.Set<java.lang.String> syncObjectNames)
syncObjectNames
- Set of Sync object names, use null to clear the filter.public boolean getModifyFlag()
public void setRunID(int runID)
runID
- new runIDpublic void setRunIDs(java.util.List<java.lang.Integer> runIDs)
runIDs
- List of RunIDs or nullpublic int getRunID()
public java.util.List<java.lang.Integer> getRunIDs()
public void setMsgInsert(java.lang.String msgInsert)
msgInsert
- new remote status insertpublic java.lang.String getMsgInsert()
public void setMsgNumber(int msgNumber)
msgNumber
- new remote status numberpublic int getMsgNumber()
public void setExcludeHost(boolean excludeHost)
excludeHost
- the new exclude hostpublic boolean isExcludeHost()
public void setHost(java.lang.String host)
host
- the new hostpublic java.lang.String getHost()
public void setRemoteContextName(java.lang.String remoteContextName)
remoteContextName
- new remote context namepublic void setRemoteContextValue(java.lang.String remoteContextValue)
remoteContextValue
- new remote context valuepublic 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 unitprotected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionpublic 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
protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
public java.util.Iterator<Task> iterator()
Task
elements in this activity list.iterator
in interface java.lang.Iterable<Task>
public int size()
public boolean isLimitReached()
protected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwisepublic 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.protected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest