public class TaskScheduleArgs extends Object
Modifier and Type | Field and Description |
---|---|
static String |
NOW
Magic value used to indicate that the user would like to schedule this operation to run immediately as a task as
opposed to running the operation in the local VM.
|
Constructor and Description |
---|
TaskScheduleArgs()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
com.forgerock.opendj.cli.Argument[] |
getArguments()
Returns all the task schedule related arguments.
|
com.forgerock.opendj.cli.StringArgument |
getCompletionNotificationArg()
Returns the
StringArgument corresponding to the email address of a recipient to be notified when the task
completes. |
com.forgerock.opendj.cli.StringArgument |
getDependencyArg()
Returns the
StringArgument corresponding to the ID of a task upon which this task depends. |
List<String> |
getDependencyIds()
Gets a list of task IDs upon which the associated task is dependent.
|
com.forgerock.opendj.cli.StringArgument |
getErrorNotificationArg()
Returns the
StringArgument corresponding to the email address of a recipient to be notified if an
error occurs when this task executes. |
FailedDependencyAction |
getFailedDependencyAction()
Gets the action to take should one of the dependent task fail.
|
com.forgerock.opendj.cli.StringArgument |
getFailedDependencyActionArg()
Returns the
StringArgument corresponding to the action this task will take should one if
its dependent tasks fail. |
List<String> |
getNotifyUponCompletionEmailAddresses()
Gets a list of email address to which an email will be sent when this task completes.
|
List<String> |
getNotifyUponErrorEmailAddresses()
Gets a list of email address to which an email will be sent if this task encounters an error during execution.
|
com.forgerock.opendj.cli.StringArgument |
getRecurringArg()
Returns the
StringArgument corresponding to a crontab(5) compatible date/time pattern. |
String |
getRecurringDateTime()
Gets the date/time pattern for recurring task schedule.
|
com.forgerock.opendj.cli.StringArgument |
getStartArg()
Returns the
StringArgument corresponding to the scheduled start date/time of the task. |
Date |
getStartDateTime()
Gets the date at which the associated task should be scheduled to start.
|
boolean |
isStartNow()
Whether the arguments provided by the user, indicate that the task should be executed immediately.
|
void |
validateArgs()
Validates arguments related to task scheduling.
|
void |
validateArgsIfOffline()
Validates arguments related to task scheduling.
|
public static final String NOW
public com.forgerock.opendj.cli.Argument[] getArguments()
public void validateArgs() throws com.forgerock.opendj.cli.ArgumentException, com.forgerock.opendj.cli.ClientException
ArgumentParser.parseArguments
has been called. validateArgsIfOffline()
should
be called instead of this method.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.public void validateArgsIfOffline() throws com.forgerock.opendj.cli.ArgumentException, com.forgerock.opendj.cli.ClientException
ArgumentParser.parseArguments
has been called. validateArgs()
, so it is not necessary to call that method if this method is being called.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.public Date getStartDateTime()
public boolean isStartNow()
true
if the task must be executed immediately and false
otherwise.public String getRecurringDateTime()
public List<String> getDependencyIds()
public FailedDependencyAction getFailedDependencyAction()
public List<String> getNotifyUponCompletionEmailAddresses()
public List<String> getNotifyUponErrorEmailAddresses()
public com.forgerock.opendj.cli.StringArgument getStartArg()
StringArgument
corresponding to the scheduled start date/time of the task.StringArgument
corresponding to the scheduled start date/time of the task.public com.forgerock.opendj.cli.StringArgument getRecurringArg()
StringArgument
corresponding to a crontab(5) compatible date/time pattern.StringArgument
corresponding to a crontab(5) compatible date/time pattern.public com.forgerock.opendj.cli.StringArgument getCompletionNotificationArg()
StringArgument
corresponding to the email address of a recipient to be notified when the task
completes.StringArgument
corresponding to the email address of a recipient to be notified when the task
completespublic com.forgerock.opendj.cli.StringArgument getErrorNotificationArg()
StringArgument
corresponding to the email address of a recipient to be notified if an
error occurs when this task executes.StringArgument
corresponding to the email address of a recipient to be notified if an
error occurs when this task executes.public com.forgerock.opendj.cli.StringArgument getDependencyArg()
StringArgument
corresponding to the ID of a task upon which this task depends.StringArgument
corresponding to the ID of a task upon which this task depends.public com.forgerock.opendj.cli.StringArgument getFailedDependencyActionArg()
StringArgument
corresponding to the action this task will take should one if
its dependent tasks fail.StringArgument
corresponding to the action this task will take should one if
its dependent tasks fail.Copyright 2010-2018 ForgeRock AS.