public class TaskScheduleUserData extends Object
TaskScheduleInformation
is that this class
is completely agnostic of the execution.Constructor and Description |
---|
TaskScheduleUserData() |
Modifier and Type | Method and Description |
---|---|
List<String> |
getDependencyIds()
Gets a list of task IDs upon which this 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 the 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 |
getStartDate()
Gets the date at which this task should be scheduled to start.
|
boolean |
isStartNow()
Whether the arguments provided by the user, indicate that the task should
be executed immediately.
|
void |
setDependencyIds(List<String> dependencyIds)
Sets the list of task IDs upon which this task is dependent.
|
void |
setFailedDependencyAction(FailedDependencyAction failedDependencyAction)
Sets the action to take should one of the dependent task fail.
|
void |
setNotifyUponCompletionEmailAddresses(List<String> notifyUponCompletionEmailAddresses)
Sets the list of email address to which an email will be sent when this
task completes.
|
void |
setNotifyUponErrorEmailAddresses(List<String> notifyUponErrorEmailAddresses)
Sets the list of email address to which an email will be sent if this
task encounters an error during execution.
|
void |
setRecurringDateTime(String recurringDateTime)
Sets the date/time pattern for recurring task schedule.
|
void |
setStartDate(Date startDate)
Sets the date at which this task should be scheduled to start.
|
void |
setStartNow(boolean startNow)
Sets whether the arguments provided by the user, indicate that the task
should be executed immediately.
|
static void |
updateCommandBuilderWithTaskSchedule(com.forgerock.opendj.cli.CommandBuilder commandBuilder,
TaskScheduleUserData taskSchedule)
An static utility method that can be used to update the object used to
display the equivalent command-line with the contents of a given
task schedule object.
|
public TaskScheduleUserData()
public boolean isStartNow()
true
if the task must be executed immediately and
false
otherwise.public void setStartNow(boolean startNow)
startNow
- true
if the task must be executed immediately and
false
otherwise.public Date getStartDate()
public void setStartDate(Date startDate)
startDate
- the date/time at which the task should be scheduledpublic String getRecurringDateTime()
public void setRecurringDateTime(String recurringDateTime)
recurringDateTime
- recurring date/time pattern at which the task
should be scheduled.public List<String> getDependencyIds()
public void setDependencyIds(List<String> dependencyIds)
dependencyIds
- list of task IDspublic FailedDependencyAction getFailedDependencyAction()
public void setFailedDependencyAction(FailedDependencyAction failedDependencyAction)
failedDependencyAction
- the action to takepublic List<String> getNotifyUponCompletionEmailAddresses()
public void setNotifyUponCompletionEmailAddresses(List<String> notifyUponCompletionEmailAddresses)
notifyUponCompletionEmailAddresses
- the list of email addressespublic List<String> getNotifyUponErrorEmailAddresses()
public void setNotifyUponErrorEmailAddresses(List<String> notifyUponErrorEmailAddresses)
notifyUponErrorEmailAddresses
- the list of email addressespublic static void updateCommandBuilderWithTaskSchedule(com.forgerock.opendj.cli.CommandBuilder commandBuilder, TaskScheduleUserData taskSchedule)
commandBuilder
- the command builder.taskSchedule
- the task schedule.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.