Package org.opends.server.tools.tasks

Class TaskScheduleArgs

java.lang.Object
org.opends.server.tools.tasks.TaskScheduleArgs
public final class TaskScheduleArgs extends Object
A class that contains all the arguments related to the task scheduling.

  • Constructor Details

    • TaskScheduleArgs

      public TaskScheduleArgs()
      Default constructor.

  • Method Details

    • getArguments

      public com.forgerock.opendj.cli.Argument[] getArguments()
      Returns all the task schedule related arguments.
      Returns:
      all the task schedule related arguments.

    • validateArgs

      public void validateArgs() throws com.forgerock.opendj.cli.ArgumentException, com.forgerock.opendj.cli.ClientException
      Validates arguments related to task scheduling. This should be called after the ArgumentParser.parseArguments has been called.
      Note that this method does only validation that is not dependent on whether the operation will be launched as a task or not. If the operation is not to be launched as a task, the method validateArgsIfOffline() should be called instead of this method.
      Throws:
      com.forgerock.opendj.cli.ArgumentException - if there is a problem with the arguments.
      com.forgerock.opendj.cli.ClientException - if there is a problem with one of the values provided by the user.

    • validateArgsIfOffline

      public void validateArgsIfOffline() throws com.forgerock.opendj.cli.ArgumentException, com.forgerock.opendj.cli.ClientException
      Validates arguments related to task scheduling. This should be called after the ArgumentParser.parseArguments has been called.
      This method assumes that the operation is not to be launched as a task. This method covers all the checks done by validateArgs(), so it is not necessary to call that method if this method is being called.
      Throws:
      com.forgerock.opendj.cli.ArgumentException - if there is a problem with the arguments.
      com.forgerock.opendj.cli.ClientException - if there is a problem with one of the values provided by the user.

    • getTaskScheduleUserData

      public TaskScheduleInformation.TaskScheduleUserData getTaskScheduleUserData()
      Returns the task schedule user data extracted out of the CLI arguments.
      Returns:
      the task schedule user data extracted out of the CLI arguments

    • startDateTimeProvided

      public boolean startDateTimeProvided()
      Returns whether the scheduled start date/time of the task was provided as an argument.
      Returns:
      whether the scheduled start date/time of the task was provided as an argument.