Constructor and Description |
---|
JobPlanTask(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element task,
ConnectionAttributes session)
Constructs a
JobPlanTask from the specified XML document. |
Modifier and Type | Method and Description |
---|---|
TaskCalendar |
calendar()
Gets the calendar condition of this JobPlan task.
|
JobPlanCheckpoint |
checkpoint()
Deprecated.
use the method general() instead
|
void |
cloneProperties(JobPlanTask toClone)
Creates a deep copy of all task properties of the given task for this task,
except the task values (prompts and variables).
|
JobPlanTask |
copy()
Creates a copy of this task with only the properties set.
|
JobPlanDependencies |
dependencies()
Gets the dependencies of this JobPlan task.
|
JobPlanEarliest |
earliest()
Gets the earliest start time settings of this JobPlan task.
|
JobPlanExternal |
external()
Gets properties for external dependencies.
|
ProcessFlowGeneral |
general()
This methdo provides access to the "General" tab of a ProcessFlow task.
|
UC4HostName |
getHostName()
Returns the hostName for the JobPlan task if exist otherwise will return
null
|
java.lang.String |
getIdnr()
Returns the ID of this
or ScheduleTask task. |
int |
getLnr()
Returns number containing the order of activation.
|
java.lang.String |
getRASubJobType()
Gets the object Subtype of this RA task.
|
java.lang.String |
getSubType()
Gets the object Subtype of this task.
|
java.lang.String |
getTaskIcon()
Return the Task Icon
|
java.lang.String |
getTaskName()
Gets the name of this JobPlan task.
|
java.lang.String |
getTaskTitle()
Return the Title of the Task
|
java.lang.String |
getTitleOrName()
Return the Task Title if available else the name of the task object
|
java.lang.String |
getType()
Returns the object type of this task.
|
java.lang.String |
getUserDefinedID()
Returns the user defined ID of this task or
null if not set. |
int |
getX()
Returns the column number of this JobPlan task.
|
int |
getY()
Returns the row number of this JobPlan task.
|
boolean |
hasCalendarCondition() |
boolean |
hasRuntimeCondition() |
boolean |
isExternal()
Returns
true if this task is an external dependency. |
boolean |
isInactive()
Return the status of the task
|
ConditionsSet |
postConditions()
This method provides access to the "Post-Conditions" of a JobPlan task.
|
ConditionsSet |
preConditions()
This method provides access to the "Pre-Conditions" of a JobPlan task.
|
OCVPanel |
raPanel()
If this task is an RA solution and the Workflow has been saved and
reopened this method can be used to override RA panel values.
|
TaskRuntime |
runtime()
Gets the runtime settings of this JobPlan task.
|
void |
setExternal()
Do not use - only for testing!
Sets this task to type EXTERNAL
|
void |
setUserDefinedID(java.lang.String userDefinedID)
Sets the user defined task ID.
|
void |
setX(int x)
Sets the column number of this task.
|
void |
setY(int y)
Sets the row number of this task.
|
org.w3c.dom.Element |
store(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element jobpStruct) |
java.lang.String |
toString() |
TaskValues |
values()
Provides access to the values and PromptSets of a Schedule or Workflow task.
|
public JobPlanTask(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task, ConnectionAttributes session)
JobPlanTask
from the specified XML document.
Internal use only.doc
- XML documenttask
- Task elementsession
- Session infopublic org.w3c.dom.Element store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element jobpStruct)
doc
- XMLDocumentjobpStruct
- Jobplan structurepublic java.lang.String getIdnr()
ITaskItem
or ScheduleTask
task.@Deprecated public JobPlanCheckpoint checkpoint()
IllegalStateException
is thrown.public java.lang.String getUserDefinedID()
null
if not set.public void setUserDefinedID(java.lang.String userDefinedID)
userDefinedID
- Any String with should be used to identify the task laterpublic ProcessFlowGeneral general()
IllegalStateException
is thrown.public TaskValues values()
ITaskItem
public OCVPanel raPanel()
public ConditionsSet preConditions()
public ConditionsSet postConditions()
public JobPlanEarliest earliest()
public boolean hasCalendarCondition()
hasCalendarCondition
in interface ITaskItem
public boolean hasRuntimeCondition()
hasRuntimeCondition
in interface ITaskItem
public TaskCalendar calendar()
IllegalStateException
is
thrown.public TaskRuntime runtime()
IllegalStateException
is thrown.public JobPlanDependencies dependencies()
public java.lang.String getTaskName()
getTaskName
in interface ITaskItem
public java.lang.String getType()
ITaskItem
public java.lang.String getSubType()
public java.lang.String getRASubJobType()
public int getX()
public int getY()
public int getLnr()
ITaskItem
public void setX(int x)
x
- Column numberpublic void setY(int y)
y
- Row numberpublic void setExternal()
public JobPlanExternal external()
IllegalStateException
is thrown.public java.lang.String toString()
toString
in class java.lang.Object
public boolean isExternal()
true
if this task is an external dependency.public UC4HostName getHostName()
public java.lang.String getTitleOrName()
public java.lang.String getTaskIcon()
public java.lang.String getTaskTitle()
public boolean isInactive()
public JobPlanTask copy()
public void cloneProperties(JobPlanTask toClone)
toClone
- The task whose properties to clone.