public class TaskScheduleArgs extends Object
| Modifier and Type | Field and Description |
|---|---|
com.forgerock.opendj.cli.StringArgument |
completionNotificationArg
Argument for specifying completion notifications.
|
com.forgerock.opendj.cli.StringArgument |
dependencyArg
Argument for specifying dependency.
|
com.forgerock.opendj.cli.StringArgument |
errorNotificationArg
Argument for specifying error notifications.
|
com.forgerock.opendj.cli.StringArgument |
failedDependencyActionArg
Argument for specifying a failed dependency action.
|
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.
|
com.forgerock.opendj.cli.StringArgument |
recurringArg
Argument to indicate a recurring task.
|
com.forgerock.opendj.cli.StringArgument |
startArg
Argument for describing the task's start time.
|
| 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.
|
List<String> |
getDependencyIds()
Gets a list of task IDs upon which the associated task is dependent.
|
FailedDependencyAction |
getFailedDependencyAction()
Gets the action to take should one of the dependent task 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.
|
String |
getRecurringDateTime()
Gets the date/time pattern for recurring task schedule.
|
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.StringArgument startArg
public com.forgerock.opendj.cli.StringArgument recurringArg
public com.forgerock.opendj.cli.StringArgument completionNotificationArg
public com.forgerock.opendj.cli.StringArgument errorNotificationArg
public com.forgerock.opendj.cli.StringArgument dependencyArg
public com.forgerock.opendj.cli.StringArgument failedDependencyActionArg
public TaskScheduleArgs()
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()
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.