Package com.uc4.api.objects

Class JobPlanExternal

java.lang.Object
com.uc4.api.objects.JobPlanExternal
All Implemented Interfaces:
HasAlias
Direct Known Subclasses:
JobPlanMonitor.JobPlanMonitorExternal
public class JobPlanExternal extends Object implements HasAlias
External Dependency.

  • Constructor Details

    • JobPlanExternal

      protected JobPlanExternal(com.uc4.util.XMLDocument doc, Element task)

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element task)

    • getAlias

      public UC4Alias getAlias()
      Returns the alias name of this task or null if no alias is set.
      Specified by:
      getAlias in interface HasAlias
      Returns:
      Alias name or null

    • setAlias

      public void setAlias(UC4Alias alias)
      Sets the alias name, use null to remove the alias.
      Parameters:
      alias - Alias name or null

    • isValidOnSameLDate

      public boolean isValidOnSameLDate()
      Returns:
      True if the external dependency is only valid when activated with the same logical date.

    • setValidOnSameLDate

      public void setValidOnSameLDate(boolean validOnSameLDate)
      Parameters:
      validOnSameLDate - Sets a flag to decide if this external dependency is only valid when activated with the same logical date.

    • getParentAlias

      public UC4Alias getParentAlias()
      Returns:
      Parent alias

    • setParentAlias

      public void setParentAlias(UC4Alias parentAlias)
      Sets the parent alias.
      Parameters:
      parentAlias - parent alias

    • getExternalParent

      public UC4ObjectName getExternalParent()
      Returns the parent of the external task. An empty UC4ObjectName is returned if the external dependency does not have a parent.
      Returns:
      Parent of the external dependency

    • setExternalParent

      public void setExternalParent(UC4ObjectName externalParent)
      Sets the parent of the external task. An empty UC4ObjectName can be used if the external dependency should not have a parent
      Parameters:
      externalParent - Parent of the external dependency

    • setElseWait

      public void setElseWait()
      Set the else action to "Wait".

    • isElseWait

      public boolean isElseWait()
      Returns true if "Wait" is set as "Else" action.
      Returns:
      True if the external dependency waits

    • setElseSkip

      public void setElseSkip()
      Set the else action to "Skip".

    • isElseSkip

      public boolean isElseSkip()
      Returns true if "Skip" is set as "Else" action.
      Returns:
      True if the external dependency is skipped

    • setElseCancelJobPlan

      public void setElseCancelJobPlan()
      The JobPlan containing the external dependency is aborted.

    • isElseCancelJobPlan

      public boolean isElseCancelJobPlan()
      Returns true if "JobPlan cancel" is set as "Else" action.
      Returns:
      True if the JobPlan containing the external dependency should be aborted.

    • isElseAlarm

      public boolean isElseAlarm()
      Returns true if an alarm object should be executed. The name of the alarm object can be set using the method setAlarmObject.
      Returns:
      True if an alarm object should be executed

    • setElseAlarm

      public void setElseAlarm(boolean elseAlarmFlag)
      Enables or disables the execution of an alarm object. If elseAlarmFlag is set to true the alarm object which is specified using the method setAlarmObject is executed.
      Parameters:
      elseAlarmFlag - Boolean which is set to true if the alarm object should be enabled

    • getAlarmObject

      public UC4ObjectName getAlarmObject()
      Returns the name of the alarm object.
      Returns:
      Alarm object

    • setAlarmObject

      public void setAlarmObject(UC4ObjectName alarmObject)
      Sets the alarm object.
      Parameters:
      alarmObject - Alarm object

    • setSltSinceLastJobPlanExecution

      public void setSltSinceLastJobPlanExecution()
      The satisfaction lead time commences at the end of the last JobPlan execution.

    • isSltSinceLastJobPlanExecution

      public boolean isSltSinceLastJobPlanExecution()
      Returns true if satisfaction lead time commences at the end of the last JobPlan execution.
      Returns:
      SLT since last JobPlan execution

    • setSltAfterJobPlanStart

      public void setSltAfterJobPlanStart()
      The satisfaction lead time commences when the JobPlan starts.

    • isSltAfterJobPlanStart

      public boolean isSltAfterJobPlanStart()
      Returns true if satisfaction lead time commences when the JobPlan starts.
      Returns:
      SLT after JobPlan start

    • setSltBeforeJobPlanStart

      public void setSltBeforeJobPlanStart(int seconds)
      The satisfaction lead time commences before the JobPlan starts. The length of this period depends on the value that has been specified. There is a limit when the end of the last JobPlan execution is also within this period.
      Parameters:
      seconds - Time limit in seconds

    • isSltBeforeJobPlanStart

      public boolean isSltBeforeJobPlanStart()
      Returns true if the satisfaction lead time commences before the JobPlan starts.
      Returns:
      SLT before JobPlan starts

    • getSltWithinSeconds

      public int getSltWithinSeconds()
      Returns the number of seconds which are set as time limit.
      Returns:
      Number of seconds

    • setTimeoutWait

      public void setTimeoutWait()
      Settings made in here are only taken into account when "Wait" has been checked in the Else area.

      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.

    • isTimeoutWait

      public boolean isTimeoutWait()
      Returns true if JobPlan execution is in a waiting condition without limitation.
      Returns:
      True if "Wait" is selected as timeout option

    • setTimeoutSkip

      public void setTimeoutSkip()
      Settings made in here are only taken into account when "Wait" has been checked in the Else area.

      The external dependency is skipped.

    • isTimeoutSkip

      public boolean isTimeoutSkip()
      Returns true if external dependency is skipped.
      Returns:
      True if "Skip" is selected as timeout option

    • setTimeoutCancelJobPlan

      public void setTimeoutCancelJobPlan()
      Settings made in here are only taken into account when "Wait" has been checked in the Else area.

      The JobPlan containing the external dependency is aborted.

    • isTimeoutCancelJobPlan

      public boolean isTimeoutCancelJobPlan()
      Returns true if the JobPlan containing the external dependency is aborted.
      Returns:
      True if "JobPlan cancel" is selected as timeout option

    • isTimeoutAlarm

      public boolean isTimeoutAlarm()
      Settings made in here are only taken into account when "Wait" has been checked in the Else area.

      Returns true if an alarm object should be executed

      Returns:
      True if an alarm object should be executed

    • setTimeoutAlarm

      public void setTimeoutAlarm(boolean timeoutAlarmFlag)
      Settings made in here are only taken into account when "Wait" has been checked in the Else area.

      Sets if an alarm object should be executed.

      Parameters:
      timeoutAlarmFlag - True if an alarm object should be executed

    • getTimeoutSeconds

      public int getTimeoutSeconds()
      Returns the time span that should be waited.
      Returns:
      Time span in seconds

    • setTimeoutSeconds

      public void setTimeoutSeconds(int timeoutSeconds)
      Sets the time span that should be waited. The value of MIN_EVENT_INTERVAL in the variable UC_SYSTEM_SETTINGS also affects the time span. As it defines the minimum value, it is used if the timeout value is less than the value specified in MIN_EVENT_INTERVAL.
      Parameters:
      timeoutSeconds - Time span in seconds

    • isTimeout

      public boolean isTimeout()
      Returns true if timeout is enabled.
      Returns:
      True if timeout is enabled

    • setTimeout

      public void setTimeout(boolean timeoutFlag)
      Enables or disables timeout.
      Parameters:
      timeoutFlag - True if timeout should be enabled

    • getExpectedStatus

      public TaskState getExpectedStatus()
      Returns the status expected for the external task's end of execution.
      Returns:
      Status

    • setExpectedStatus

      public void setExpectedStatus(TaskState expectedStatus)
      Sets the status expected for the external task's end of execution.
      Parameters:
      expectedStatus - Status

    • copy

      public JobPlanExternal copy()
      Creates a deep copy of this object
      Returns:
      A copy of this object