public class JobPlanExternal
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
UC4ObjectName |
getAlarmObject()
Returns the name of the alarm object.
|
UC4Alias |
getAlias()
Returns the alias name of this task or
null if no alias is set. |
TaskState |
getExpectedStatus()
Returns the status expected for the external task's end of execution.
|
UC4ObjectName |
getExternalParent()
Returns the parent of the external task.
|
UC4Alias |
getParentAlias() |
int |
getSltWithinSeconds()
Returns the number of seconds which are set as time limit.
|
int |
getTimeoutSeconds()
Returns the time span that should be waited.
|
boolean |
isElseAlarm()
Returns
true if an alarm object should be executed. |
boolean |
isElseCancelJobPlan()
Returns
true if "JobPlan cancel" is set as "Else" action. |
boolean |
isElseSkip()
Returns
true if "Skip" is set as "Else" action. |
boolean |
isElseWait()
Returns
true if "Wait" is set as "Else" action. |
boolean |
isSltAfterJobPlanStart()
Returns
true if satisfaction lead time commences when the JobPlan starts. |
boolean |
isSltBeforeJobPlanStart()
Returns
true if the satisfaction lead time commences before the JobPlan starts. |
boolean |
isSltSinceLastJobPlanExecution()
Returns
true if satisfaction lead time commences at the end of the last JobPlan execution. |
boolean |
isTimeout()
Returns
true if timeout is enabled. |
boolean |
isTimeoutAlarm()
Settings made in here are only taken into account when "Wait" has been checked in the Else area.
|
boolean |
isTimeoutCancelJobPlan()
Returns
true if the JobPlan containing the external dependency is aborted. |
boolean |
isTimeoutSkip()
Returns
true if external dependency is skipped. |
boolean |
isTimeoutWait()
Returns
true if JobPlan execution is in a waiting condition without limitation. |
boolean |
isValidOnSameLDate() |
void |
setAlarmObject(UC4ObjectName alarmObject)
Sets the alarm object.
|
void |
setAlias(UC4Alias alias)
Sets the alias name, use
null to remove the alias. |
void |
setElseAlarm(boolean elseAlarmFlag)
Enables or disables the execution of an alarm object.
|
void |
setElseCancelJobPlan()
The JobPlan containing the external dependency is aborted.
|
void |
setElseSkip()
Set the else action to "Skip".
|
void |
setElseWait()
Set the else action to "Wait".
|
void |
setExpectedStatus(TaskState expectedStatus)
Sets the status expected for the external task's end of execution.
|
void |
setExternalParent(UC4ObjectName externalParent)
Sets the parent of the external task.
|
void |
setParentAlias(UC4Alias parentAlias)
Sets the parent alias.
|
void |
setSltAfterJobPlanStart()
The satisfaction lead time commences when the JobPlan starts.
|
void |
setSltBeforeJobPlanStart(int seconds)
The satisfaction lead time commences before the JobPlan starts.
|
void |
setSltSinceLastJobPlanExecution()
The satisfaction lead time commences at the end of the last JobPlan execution.
|
void |
setTimeout(boolean timeoutFlag)
Enables or disables timeout.
|
void |
setTimeoutAlarm(boolean timeoutAlarmFlag)
Settings made in here are only taken into account when "Wait" has been checked in the Else area.
|
void |
setTimeoutCancelJobPlan()
Settings made in here are only taken into account when "Wait" has been checked in the Else area.
|
void |
setTimeoutSeconds(int timeoutSeconds)
Sets the time span that should be waited.
|
void |
setTimeoutSkip()
Settings made in here are only taken into account when "Wait" has been checked in the Else area.
|
void |
setTimeoutWait()
Settings made in here are only taken into account when "Wait" has been checked in the Else area.
|
void |
setValidOnSameLDate(boolean validOnSameLDate) |
public UC4Alias getAlias()
null
if no alias is set.public void setAlias(UC4Alias alias)
null
to remove the alias.alias
- Alias name or nullpublic boolean isValidOnSameLDate()
public void setValidOnSameLDate(boolean validOnSameLDate)
validOnSameLDate
- Sets a flag to decide if this external
dependency is only valid when activated with the same logical date.public UC4Alias getParentAlias()
public void setParentAlias(UC4Alias parentAlias)
parentAlias
- parent aliaspublic UC4ObjectName getExternalParent()
UC4ObjectName
is returned if the external dependency does not have a parent.public void setExternalParent(UC4ObjectName externalParent)
UC4ObjectName
can be used if the external dependency should not have a parentexternalParent
- Parent of the external dependencypublic void setElseWait()
public boolean isElseWait()
true
if "Wait" is set as "Else" action.public void setElseSkip()
public boolean isElseSkip()
true
if "Skip" is set as "Else" action.public void setElseCancelJobPlan()
public boolean isElseCancelJobPlan()
true
if "JobPlan cancel" is set as "Else" action.public boolean isElseAlarm()
true
if an alarm object should be executed.
The name of the alarm object can be set using the method setAlarmObject
.public void setElseAlarm(boolean elseAlarmFlag)
elseAlarmFlag
is set to true
the alarm object
which is specified using the method setAlarmObject
is executed.elseAlarmFlag
- Boolean which is set to true if the alarm object should be enabledpublic UC4ObjectName getAlarmObject()
public void setAlarmObject(UC4ObjectName alarmObject)
alarmObject
- Alarm objectpublic void setSltSinceLastJobPlanExecution()
public boolean isSltSinceLastJobPlanExecution()
true
if satisfaction lead time commences at the end of the last JobPlan execution.public void setSltAfterJobPlanStart()
public boolean isSltAfterJobPlanStart()
true
if satisfaction lead time commences when the JobPlan starts.public void setSltBeforeJobPlanStart(int seconds)
seconds
- Time limit in secondspublic boolean isSltBeforeJobPlanStart()
true
if the satisfaction lead time commences before the JobPlan starts.public int getSltWithinSeconds()
public void setTimeoutWait()
JobPlan execution is in a waiting condition without limitation. Manual action needs to be taken. Timeout is repeated in the intervals specified in timeout after... If you specified an Alarm object, it starts whenever a timeout occurs.
public boolean isTimeoutWait()
true
if JobPlan execution is in a waiting condition without limitation.public void setTimeoutSkip()
The external dependency is skipped.
public boolean isTimeoutSkip()
true
if external dependency is skipped.public void setTimeoutCancelJobPlan()
The JobPlan containing the external dependency is aborted.
public boolean isTimeoutCancelJobPlan()
true
if the JobPlan containing the external dependency is aborted.public boolean isTimeoutAlarm()
Returns true
if an alarm object should be executed
public void setTimeoutAlarm(boolean timeoutAlarmFlag)
Sets if an alarm object should be executed.
timeoutAlarmFlag
- True if an alarm object should be executedpublic int getTimeoutSeconds()
public void setTimeoutSeconds(int timeoutSeconds)
timeoutSeconds
- Time span in secondspublic boolean isTimeout()
true
if timeout is enabled.public void setTimeout(boolean timeoutFlag)
timeoutFlag
- True if timeout should be enabledpublic TaskState getExpectedStatus()
public void setExpectedStatus(TaskState expectedStatus)
expectedStatus
- Status