public class JobPlanMonitor extends XMLRequest implements java.lang.Iterable<JobPlanMonitor.Task>
Modifier and Type | Class and Description |
---|---|
static class |
JobPlanMonitor.JobPlanMonitorExternal
Deprecated.
Do not use it.
|
static class |
JobPlanMonitor.JobPlanMonitorRuntime
Deprecated.
Do not use it.
|
static class |
JobPlanMonitor.Task
Task in the ProcessFlow monitor.
|
Constructor and Description |
---|
JobPlanMonitor(int runID,
boolean active)
Constructs a new
JobPlanMonitor 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.
|
protected JobPlanMonitor.Task |
createTask(org.w3c.dom.Element taskElement,
ConnectionAttributes session,
JobPlanMonitor monitor)
Creates a task in the Workflow monitor.
|
protected JobPlanMonitor.Task |
createTask(org.w3c.dom.Element taskElement,
ConnectionAttributes session,
JobPlanMonitor monitor,
com.uc4.util.XMLDocument doc)
Creates a task in the Workflow monitor.
|
JobPlanMonitor.Task |
getEndTask()
Returns the end task.
|
int |
getEstimatedRunTime()
Returns the estimated runtime in seconds.
|
JobPlanMonitor.Task |
getFirstTaskByName(java.lang.String name)
Returns the first task in the JobPlan monitor which has the specified object name.
|
int |
getRunID()
returns the RunID of the ProcessFlow.
|
protected java.lang.String |
getSrc()
Returns the request source.
|
JobPlanMonitor.Task |
getStartTask()
Returns the start task.
|
java.lang.String |
getSubType()
Returns the SubType of the Workflow.
|
JobPlanMonitor.Task |
getTaskByLnr(java.lang.String lnr)
Returns the task with the specified activation number.
|
JobPlanMonitor.Task |
getTaskByRunID(int runID)
Returns the task with the specified runID.
|
JobPlanMonitor.Task |
getTaskByRunIDWithType(int runID,
java.lang.String objectType)
Returns the task with the specified runID and Type.
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
boolean |
isActive()
Returns
true if the monitor was read form the activity window. |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
boolean |
isModificationMode()
Returns
true if this instance of the JobPlanMonitor class represents a ProcessFlow which has been opened for modification. |
boolean |
isWrongMonitor()
Returns
true if no workflow monitor data was returned. |
java.util.Iterator<JobPlanMonitor.Task> |
iterator() |
void |
setEstimatedRunTime(int ert)
Sets the estimated runtime in seconds for the entry.
|
void |
setIncludeTaskProperties(boolean includeTaskProperties)
If this method is set to true, the properties of task are also returned in the monitor.
|
int |
size()
Returns the number of tasks in the ProcessFlow.
|
java.util.Iterator<JobPlanMonitor.Task> |
taskIterator()
Deprecated.
use iterator() instead
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
public JobPlanMonitor(int runID, boolean active)
JobPlanMonitor
request.runID
- RunIDactive
- true if the monitor should be read from the activity window, false if the statistics should be queriedprotected 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 sessionprotected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
public void setIncludeTaskProperties(boolean includeTaskProperties)
includeTaskProperties
- true to include properties of each task in the response.public boolean isWrongMonitor()
true
if no workflow monitor data was returned.
This can happen for example if the RunID of a Schedule was used.public int size()
protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
protected JobPlanMonitor.Task createTask(org.w3c.dom.Element taskElement, ConnectionAttributes session, JobPlanMonitor monitor)
taskElement
- XML Element of the tasksession
- Session Infomonitor
- Monitor instanceprotected JobPlanMonitor.Task createTask(org.w3c.dom.Element taskElement, ConnectionAttributes session, JobPlanMonitor monitor, com.uc4.util.XMLDocument doc)
taskElement
- XML Element of the tasksession
- Session Infomonitor
- Monitor instancedoc
- XMLDocument instancepublic JobPlanMonitor.Task getTaskByRunID(int runID)
runID
- runID of the tasknull
if not foundpublic JobPlanMonitor.Task getTaskByRunIDWithType(int runID, java.lang.String objectType)
runID
- runID of the taskobjectType
- objectType of the tasknull
if not foundpublic JobPlanMonitor.Task getFirstTaskByName(java.lang.String name)
name
- Name of the UC4 objectnull
if not foundpublic JobPlanMonitor.Task getTaskByLnr(java.lang.String lnr)
lnr
- Activation numbernull
if not foundpublic boolean isModificationMode()
true
if this instance of the JobPlanMonitor class represents a ProcessFlow which has been opened for modification.@Deprecated public java.util.Iterator<JobPlanMonitor.Task> taskIterator()
JobPlanMonitor.Task
public java.util.Iterator<JobPlanMonitor.Task> iterator()
iterator
in interface java.lang.Iterable<JobPlanMonitor.Task>
public int getRunID()
public JobPlanMonitor.Task getStartTask()
public JobPlanMonitor.Task getEndTask()
public java.lang.String getSubType()
public int getEstimatedRunTime()
public void setEstimatedRunTime(int ert)
ert
- The estimated runtime.public boolean isActive()
true
if the monitor was read form the activity window.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
otherwise