Package org.opends.server.tools.tasks

Class TaskScheduleUserData

java.lang.Object
org.opends.server.tools.tasks.TaskScheduleUserData
public final class TaskScheduleUserData extends Object
A generic data structure that contains the data that the user provided to schedule a task.
The main difference with TaskScheduleInformation is that this class is completely agnostic of the execution.

  • Constructor Details

    • TaskScheduleUserData

      public TaskScheduleUserData()

  • Method Details

    • isStartNow

      public boolean isStartNow()
      Whether the arguments provided by the user, indicate that the task should be executed immediately.
      Returns:
      true if the task must be executed immediately and false otherwise.

    • setStartNow

      public void setStartNow(boolean startNow)
      Sets whether the arguments provided by the user, indicate that the task should be executed immediately.
      Parameters:
      startNow - true if the task must be executed immediately and false otherwise.

    • getStartDate

      public Instant getStartDate()
      Gets the date at which this task should be scheduled to start.
      Returns:
      date/time at which the task should be scheduled

    • setStartDate

      public void setStartDate(Instant startDate)
      Sets the date at which this task should be scheduled to start.
      Parameters:
      startDate - the date/time at which the task should be scheduled

    • getRecurringDateTime

      public String getRecurringDateTime()
      Gets the date/time pattern for recurring task schedule.
      Returns:
      recurring date/time pattern at which the task should be scheduled.

    • setRecurringDateTime

      public void setRecurringDateTime(String recurringDateTime)
      Sets the date/time pattern for recurring task schedule.
      Parameters:
      recurringDateTime - recurring date/time pattern at which the task should be scheduled.

    • getDependencyIds

      public List<String> getDependencyIds()
      Gets a list of task IDs upon which this task is dependent.
      Returns:
      list of task IDs

    • setDependencyIds

      public void setDependencyIds(Collection<String> dependencyIds)
      Sets the list of task IDs upon which this task is dependent.
      Parameters:
      dependencyIds - list of task IDs

    • getFailedDependencyAction

      public FailedDependencyAction getFailedDependencyAction()
      Gets the action to take should one of the dependent task fail.
      Returns:
      action to take

    • setFailedDependencyAction

      public void setFailedDependencyAction(FailedDependencyAction failedDependencyAction)
      Sets the action to take should one of the dependent task fail.
      Parameters:
      failedDependencyAction - the action to take

    • getNotifyUponCompletionEmailAddresses

      public List<String> getNotifyUponCompletionEmailAddresses()
      Gets a list of email address to which an email will be sent when this task completes.
      Returns:
      list of email addresses

    • setNotifyUponCompletionEmailAddresses

      public void setNotifyUponCompletionEmailAddresses(Collection<String> notifyUponCompletionEmailAddresses)
      Sets the list of email address to which an email will be sent when this task completes.
      Parameters:
      notifyUponCompletionEmailAddresses - the list of email addresses

    • getNotifyUponErrorEmailAddresses

      public List<String> getNotifyUponErrorEmailAddresses()
      Gets the list of email address to which an email will be sent if this task encounters an error during execution.
      Returns:
      list of email addresses

    • setNotifyUponErrorEmailAddresses

      public void setNotifyUponErrorEmailAddresses(Collection<String> notifyUponErrorEmailAddresses)
      Sets the list of email address to which an email will be sent if this task encounters an error during execution.
      Parameters:
      notifyUponErrorEmailAddresses - the list of email addresses