| | |
| | | package org.opends.server.tools.tasks; |
| | | |
| | | import org.opends.server.types.RawAttribute; |
| | | import org.opends.server.backends.task.FailedDependencyAction; |
| | | |
| | | import java.util.List; |
| | | import java.util.Date; |
| | |
| | | */ |
| | | public interface TaskScheduleInformation { |
| | | |
| | | |
| | | /** |
| | | * Adds utility specific attributes to <code>attributes</code> for |
| | | * population of the entry that is added to the task backend. |
| | |
| | | */ |
| | | void addTaskAttributes(List<RawAttribute> attributes); |
| | | |
| | | |
| | | /** |
| | | * Gets the objectclass used to represent scheduled instances of this |
| | | * utility in the task backend. |
| | |
| | | */ |
| | | String getTaskObjectclass(); |
| | | |
| | | |
| | | /** |
| | | * Gets the Class that implements the utility to execute. |
| | | * |
| | |
| | | */ |
| | | Class getTaskClass(); |
| | | |
| | | |
| | | /** |
| | | * Gets the date at which this task should be scheduled to start. |
| | | * |
| | | * @return date/time at which the task should be scheduled |
| | | */ |
| | | Date getStartDateTime(); |
| | | |
| | | |
| | | /** |
| | | * Gets a list of task IDs upon which this task is dependent. |
| | | * |
| | | * @return list of task IDs |
| | | */ |
| | | List<String> getDependencyIds(); |
| | | |
| | | |
| | | /** |
| | | * Gets the action to take should one of the dependent task fail. |
| | | * |
| | | * @return action to take |
| | | */ |
| | | FailedDependencyAction getFailedDependencyAction(); |
| | | |
| | | |
| | | /** |
| | | * Gets a list of email address to which an email will be sent when this |
| | | * task completes. |
| | | * |
| | | * @return list of email addresses |
| | | */ |
| | | List<String> getNotifyUponCompletionEmailAddresses(); |
| | | |
| | | |
| | | /** |
| | | * Gets a list of email address to which an email will be sent if this |
| | | * task encounters an error during execution. |
| | | * |
| | | * @return list of email addresses |
| | | */ |
| | | List<String> getNotifyUponErrorEmailAddresses(); |
| | | |
| | | |
| | | } |