Package com.uc4.api.objects

Class JobPlanCheckpoint

java.lang.Object
com.uc4.api.objects.JobPlanCheckpoint
@Deprecated public class JobPlanCheckpoint extends Object
Deprecated.
Use ProcessFlowGeneral instead, this class will be removed in the next main release
This class can be used to set time checkpoints for tasks within a JobPlan. If the particular task has not started by the specified time, the specified object is activated.

  • Constructor Details

    • JobPlanCheckpoint

      protected JobPlanCheckpoint()
      Deprecated.

    • JobPlanCheckpoint

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

  • Method Details

    • store

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

    • isTimeCheckpoint

      public boolean isTimeCheckpoint()
      Deprecated.
      Returns true if time checkpoint is enabled for this JobPlanTask.
      Returns:
      True if a time checkpoint is enabled

    • setTimeCheckpoint

      public void setTimeCheckpoint(boolean timeCheckpoint)
      Deprecated.
      Enables or disables the time checkpoint for this JobPlanTask.
      Parameters:
      timeCheckpoint - Boolean value to set the time checkpoint

    • setDaysAfterJobPlanActivation

      public void setDaysAfterJobPlanActivation(int daysAfterJobPlanActivation)
      Deprecated.
      Sets the number of days as of JobPlan activation.

      Examples:

      • 0 days = the day of JobPlan activation
      • 2 days = two days after JobPlan activation
      Permitted values: 0 - 99
      Parameters:
      daysAfterJobPlanActivation - Number of days as of JobPlan activation

    • getTime

      public Time getTime()
      Deprecated.
      Returns the checkpoint time.
      Returns:
      Checkpoint time

    • setTime

      public void setTime(Time time)
      Deprecated.
      Sets the Checkpoint time.

      If the task could not be started before this time, the object specified in the "Execute" section will be activated.

      Parameters:
      time - Checkpoint time

    • getTimezone

      public UC4TimezoneName getTimezone()
      Deprecated.
      Returns the TimeZone that is to be used.
      Returns:
      Used TimeZone

    • setTimezone

      public void setTimezone(UC4TimezoneName timezone)
      Deprecated.
      Sets the TimeZone that is to be used.
      Parameters:
      timezone - TimeZone

    • getDaysAfterJobPlanActivation

      public int getDaysAfterJobPlanActivation()
      Deprecated.
      Returns the number of days as of JobPlan activation.
      Returns:
      number of days as of JobPlan activation

    • getExecute

      public UC4ObjectName getExecute()
      Deprecated.
      Returns the name of the object that is to be started when the checkpoint has been exceeded.
      Returns:
      Object name

    • setExecute

      public void setExecute(UC4ObjectName execute)
      Deprecated.
      Sets the name of the object that is to be started when the checkpoint has been exceeded.
      Parameters:
      execute - Object name