org.opends.server.admin.std.server
Interface WorkflowCfg

All Superinterfaces:
Configuration

public interface WorkflowCfg
extends Configuration

A server-side interface for querying Workflow settings.

The Workflow is a list of processing steps (Work Flow Elements) that are applied to data as it is retrieved from the Directory Server.


Method Summary
 void addChangeListener(ConfigurationChangeListener<WorkflowCfg> listener)
          Register to be notified when this Workflow is changed.
 java.lang.Class<? extends WorkflowCfg> configurationClass()
          Gets the configuration class associated with this Workflow.
 DN getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getWorkflowElement()
          Gets the "workflow-element" property.
 DN getWorkflowElementDN()
          Gets the "workflow-element" property as a DN.
 java.lang.String getWorkflowId()
          Gets the "workflow-id" property.
 boolean isEnabled()
          Gets the "enabled" property.
 void removeChangeListener(ConfigurationChangeListener<WorkflowCfg> listener)
          Deregister an existing Workflow configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends WorkflowCfg> configurationClass()
Gets the configuration class associated with this Workflow.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Workflow.

addChangeListener

void addChangeListener(ConfigurationChangeListener<WorkflowCfg> listener)
Register to be notified when this Workflow is changed.

Parameters:
listener - The Workflow configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<WorkflowCfg> listener)
Deregister an existing Workflow configuration change listener.

Parameters:
listener - The Workflow configuration change listener.

getBaseDN

DN getBaseDN()
Gets the "base-dn" property.

Specifies the base DN of the data targeted by the Workflow .

Returns:
Returns the value of the "base-dn" property.

isEnabled

boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Workflow is enabled for use in the server.

If a Workflow is not enabled, then its contents are not accessible when processing operations.

Returns:
Returns the value of the "enabled" property.

getWorkflowElement

java.lang.String getWorkflowElement()
Gets the "workflow-element" property.

Specifies the root Work Flow Element in the Workflow .

Returns:
Returns the value of the "workflow-element" property.

getWorkflowElementDN

DN getWorkflowElementDN()
Gets the "workflow-element" property as a DN.

Specifies the root Work Flow Element in the Workflow .

Returns:
Returns the DN value of the "workflow-element" property.

getWorkflowId

java.lang.String getWorkflowId()
Gets the "workflow-id" property.

Provides a name that identifies the Workflow.

The name must be unique among all Workflows in the server.

Returns:
Returns the value of the "workflow-id" property.