org.opends.server.admin.std.server
Interface WorkflowElementCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
LocalBackendWorkflowElementCfg

public interface WorkflowElementCfg
extends Configuration

A server-side interface for querying Workflow Element settings.

Workflow Elements implement a single processing step in a Work Flow.


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

Method Detail

configurationClass

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

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

addChangeListener

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

Parameters:
listener - The Workflow Element configuration change listener.

removeChangeListener

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

Parameters:
listener - The Workflow Element configuration change listener.

isEnabled

boolean isEnabled()
Gets the "enabled" property.

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

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

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

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Workflow Element implementation.

Returns:
Returns the value of the "java-class" property.

getWorkflowElementId

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

Provides a name that identifies the associated Workflow Element .

The name must be unique among all Workflow Elements in the server.

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