org.opends.server.core
Interface Workflow

All Known Implementing Classes:
RootDseWorkflowTopology, WorkflowImpl, WorkflowTopology, WorkflowTopologyNode

public interface Workflow

This class defines the workflow interface. There can be two implementations for the workflows. In the first workflow implementation a workflow is a list of structured tasks (aka workflow element). Each task is working on a set of data being identified by a base DN. The order of the tasks and their synchronization are defined statically by a task tree. In the second workflow implementation each workflow is a node in a workflow tree (aka worflow topology). Each node in the tree is linked to a workflow object of the first implementation and the base DN of the node is the base DN of the attached workflow object. The relationship of the nodes in the tree is based on the base DNs of the nodes. A workflow node is a subordinate of another workflow node when the base DN of the former is a superior of the base DN of the latter. Workflow topology are useful, for example, in subtree searches: search is performed on a node as well as on all the subordinate nodes.


Method Summary
 void execute(Operation operation)
          Executes all the tasks defined by the workflow task tree for a given operation.
 DN getBaseDN()
          Gets the base DN which identifies the set of data upon which the workflow is to be executed.
 

Method Detail

getBaseDN

DN getBaseDN()
Gets the base DN which identifies the set of data upon which the workflow is to be executed.

Returns:
the base DN of the workflow

execute

void execute(Operation operation)
             throws CanceledOperationException
Executes all the tasks defined by the workflow task tree for a given operation.

Parameters:
operation - the operation to execute
Throws:
CanceledOperationException - if this operation should be cancelled.