public static class JobPlanMonitor.Task
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
void |
addPredecessor(JobPlanMonitor.Task pre,
TaskState state)
Adds a dependency to this monitor task.
|
java.lang.String |
getAlias()
Returns the Alias of the task.
|
java.lang.String |
getCaption()
Returns the caption of the task.
|
java.lang.String |
getComponentName()
Returns the Component Name of the task.
|
int |
getEstimatedRunTime()
Returns the estimated runtime in seconds.
|
UC4ObjectName |
getExternalParent()
Returns the name of the external parent or an empty UC4ObjectName.
|
java.lang.String |
getLnr()
Returns the activation order number of this task.
|
java.lang.String |
getName() |
java.lang.String |
getObjectSubType()
Returns the SubType of the Object.
|
java.lang.String |
getObjectType()
Returns the type of the Object.
|
java.lang.String |
getParentVariable(java.lang.String variableName)
Returns the value of a given parent variable.
|
TaskState |
getPredecessorState(JobPlanMonitor.Task t)
Returns the status of the predecessor.
|
int |
getRunID() |
Time |
getStartTime() |
DateTime |
getStartTimestamp() |
java.lang.String |
getStatus()
Returns the status of this task as String which is independent on the logon language.
|
int |
getStatusCode()
Returns the status of the task as integer.
|
java.lang.String |
getStatusText()
Returns a description of the status.
|
java.lang.String |
getTaskID()
Returns a unique ID of a task.
|
java.lang.String |
getTrafficLight() |
java.lang.String |
getVariable(java.lang.String variableName)
Returns the value of a given variable.
|
int |
getX()
Returns the position of this task.
|
int |
getY()
Returns the position of this task.
|
boolean |
hasComment() |
java.util.Iterator<java.lang.String> |
parentVariableNameIterator()
Returns an iterator over parent variable names.
|
java.util.Iterator<JobPlanMonitor.Task> |
predecessors() |
int |
predecessorsWithDottedLines() |
java.lang.String |
toString() |
java.util.Iterator<java.lang.String> |
variableNameIterator()
Returns an iterator over variable names.
|
public java.lang.String getLnr()
public UC4ObjectName getExternalParent()
public java.lang.String getObjectType()
public Time getStartTime()
public DateTime getStartTimestamp()
public java.lang.String getName()
public int getRunID()
-1
if not available.public java.lang.String getTaskID()
public java.lang.String getStatus()
AbstractTask.getStatusCode()
public int predecessorsWithDottedLines()
public void addPredecessor(JobPlanMonitor.Task pre, TaskState state)
pre
- Predecessor taskstate
- When or null
if no status should be setpublic java.util.Iterator<JobPlanMonitor.Task> predecessors()
public TaskState getPredecessorState(JobPlanMonitor.Task t)
t
- predecessor taskpublic int getX()
public int getY()
public int getEstimatedRunTime()
public java.lang.String getObjectSubType()
public java.lang.String getTrafficLight()
public java.lang.String getStatusText()
AbstractTask.getStatusCode()
public int getStatusCode()
-1
in case of an error. Possible return values are described in the status: AbstractTask.getStatusCode()
public java.lang.String getCaption()
public java.lang.String getAlias()
public java.lang.String getComponentName()
public java.util.Iterator<java.lang.String> variableNameIterator()
java.lang.String
public java.lang.String getVariable(java.lang.String variableName)
null
if the variable name does not exist.variableName
- variable namenull
if the variable does not existpublic java.util.Iterator<java.lang.String> parentVariableNameIterator()
java.lang.String
public java.lang.String getParentVariable(java.lang.String variableName)
null
if the variable name does not exist.variableName
- parent variable namenull
if the variable does not existpublic boolean hasComment()
true
if this task item has an attached comment.public java.lang.String toString()
toString
in class java.lang.Object