org.opends.server.tools.tasks
Interface TaskScheduleInformation

All Known Implementing Classes:
BackUpDB, ExportLDIF, ImportLDIF, RestoreDB, TaskTool

public interface TaskScheduleInformation

Interface for tools that are capable of scheduling a task remotely through the task backend.

See Also:
TaskClient

Method Summary
 void addTaskAttributes(java.util.List<RawAttribute> attributes)
          Adds utility specific attributes to attributes for population of the entry that is added to the task backend.
 java.util.List<java.lang.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.
 java.util.List<java.lang.String> getNotifyUponCompletionEmailAddresses()
          Gets a list of email address to which an email will be sent when this task completes.
 java.util.List<java.lang.String> getNotifyUponErrorEmailAddresses()
          Gets a list of email address to which an email will be sent if this task encounters an error during execution.
 java.util.Date getStartDateTime()
          Gets the date at which this task should be scheduled to start.
 java.lang.Class getTaskClass()
          Gets the Class that implements the utility to execute.
 java.lang.String getTaskObjectclass()
          Gets the objectclass used to represent scheduled instances of this utility in the task backend.
 

Method Detail

addTaskAttributes

void addTaskAttributes(java.util.List<RawAttribute> attributes)
Adds utility specific attributes to attributes for population of the entry that is added to the task backend.

Parameters:
attributes - that will be added to the task backend

getTaskObjectclass

java.lang.String getTaskObjectclass()
Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Returns:
String representation of this utilities objectclass

getTaskClass

java.lang.Class getTaskClass()
Gets the Class that implements the utility to execute.

Returns:
class of the tasks implementation

getStartDateTime

java.util.Date getStartDateTime()
Gets the date at which this task should be scheduled to start.

Returns:
date/time at which the task should be scheduled

getDependencyIds

java.util.List<java.lang.String> getDependencyIds()
Gets a list of task IDs upon which this task is dependent.

Returns:
list of task IDs

getFailedDependencyAction

FailedDependencyAction getFailedDependencyAction()
Gets the action to take should one of the dependent task fail.

Returns:
action to take

getNotifyUponCompletionEmailAddresses

java.util.List<java.lang.String> getNotifyUponCompletionEmailAddresses()
Gets a list of email address to which an email will be sent when this task completes.

Returns:
list of email addresses

getNotifyUponErrorEmailAddresses

java.util.List<java.lang.String> getNotifyUponErrorEmailAddresses()
Gets a list of email address to which an email will be sent if this task encounters an error during execution.

Returns:
list of email addresses