public class JobPlanMonitor extends XMLRequest implements java.lang.Iterable<JobPlanMonitor.Task>
Modifier and Type | Class and Description |
---|---|
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 |
---|---|
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.
|
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.
|
boolean |
isActive()
Returns
true if the monitor was read form the activity window. |
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 |
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
|
getMessageBox, getRequestID, handleResponse, send
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 queriedpublic 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()
public JobPlanMonitor.Task getTaskByRunID(int runID)
runID
- runID 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 boolean isActive()
true
if the monitor was read form the activity window.