org.opends.server.tools.tasks
Class TaskEntry

java.lang.Object
  extended by org.opends.server.tools.tasks.TaskEntry

public class TaskEntry
extends java.lang.Object

Processes information from a task entry from the directory and provides accessors for attribute information. In some cases the data is formatted into more human-friendly formats.


Constructor Summary
TaskEntry(Entry entry)
          Creates a parameterized instance.
 
Method Summary
 Message getActualStartTime()
          Gets the human-friendly start time.
 java.lang.String getClassName()
          Gets the name of the class implementing the task represented here.
 java.util.List<java.lang.String> getCompletionNotificationEmailAddresses()
          Gets the email messages that will be used for notifications when the task completes.
 Message getCompletionTime()
          Gets the human-friendly completion time.
 java.util.List<java.lang.String> getDependencyIds()
          Gets the IDs of tasks upon which this task depends.
 DN getDN()
          Gets the DN of the wrapped entry.
 java.util.List<java.lang.String> getErrorNotificationEmailAddresses()
          Gets the email messages that will be used for notifications when the task encounters an error.
 Message getFailedDependencyAction()
          Gets the action to take if this task fails.
 java.lang.String getId()
          Gets the ID of the task.
 java.util.List<Message> getLogMessages()
          Gets the logs associated with this task's execution.
 Message getScheduledStartTime()
          Gets the human-friendly scheduled time.
 Message getState()
          Gets the state of the task.
 java.util.Map<Message,java.util.List<java.lang.String>> getTaskSpecificAttributeValuePairs()
          Gets a mapping of attributes that are specific to the implementing task as opposed to the superior, or base, task.
 TaskState getTaskState()
          Gets the task state.
 Message getType()
          Gets a user presentable string indicating the type of this task.
 boolean isCancelable()
          Indicates whether or not this task supports a cancel operation.
 boolean isDone()
          Indicates whether or not this task is done.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskEntry

public TaskEntry(Entry entry)
Creates a parameterized instance.

Parameters:
entry - to wrap
Method Detail

getDN

public DN getDN()
Gets the DN of the wrapped entry.

Returns:
DN of entry

getId

public java.lang.String getId()
Gets the ID of the task.

Returns:
String ID of the task

getClassName

public java.lang.String getClassName()
Gets the name of the class implementing the task represented here.

Returns:
String name of class

getState

public Message getState()
Gets the state of the task.

Returns:
Message representing state

getScheduledStartTime

public Message getScheduledStartTime()
Gets the human-friendly scheduled time.

Returns:
String time

getActualStartTime

public Message getActualStartTime()
Gets the human-friendly start time.

Returns:
String time

getCompletionTime

public Message getCompletionTime()
Gets the human-friendly completion time.

Returns:
String time

getDependencyIds

public java.util.List<java.lang.String> getDependencyIds()
Gets the IDs of tasks upon which this task depends.

Returns:
array of IDs

getFailedDependencyAction

public Message getFailedDependencyAction()
Gets the action to take if this task fails.

Returns:
String action

getLogMessages

public java.util.List<Message> getLogMessages()
Gets the logs associated with this task's execution.

Returns:
array of log messages

getCompletionNotificationEmailAddresses

public java.util.List<java.lang.String> getCompletionNotificationEmailAddresses()
Gets the email messages that will be used for notifications when the task completes.

Returns:
array of email addresses

getErrorNotificationEmailAddresses

public java.util.List<java.lang.String> getErrorNotificationEmailAddresses()
Gets the email messages that will be used for notifications when the task encounters an error.

Returns:
array of email addresses

getType

public Message getType()
Gets a user presentable string indicating the type of this task.

Returns:
Message type

isCancelable

public boolean isCancelable()
Indicates whether or not this task supports a cancel operation.

Returns:
boolean where true means this task supports being canceled.

getTaskSpecificAttributeValuePairs

public java.util.Map<Message,java.util.List<java.lang.String>> getTaskSpecificAttributeValuePairs()
Gets a mapping of attributes that are specific to the implementing task as opposed to the superior, or base, task.

Returns:
mapping of atribute field labels to lists of string values for each field.

getTaskState

public TaskState getTaskState()
Gets the task state.

Returns:
TaskState of task

isDone

public boolean isDone()
Indicates whether or not this task is done.

Returns:
boolean where true means this task is done