org.opends.server.admin.std.client
Interface WorkflowElementCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
LocalBackendWorkflowElementCfgClient

public interface WorkflowElementCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Workflow Element settings.

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


Method Summary
 ManagedObjectDefinition<? extends WorkflowElementCfgClient,? extends WorkflowElementCfg> definition()
          Get the configuration definition associated with this Workflow Element.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getWorkflowElementId()
          Gets the "workflow-element-id" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setWorkflowElementId(java.lang.String value)
          Sets the "workflow-element-id" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends WorkflowElementCfgClient,? extends WorkflowElementCfg> definition()
Get the configuration definition associated with this Workflow Element.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Workflow Element.

isEnabled

java.lang.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.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setWorkflowElementId

void setWorkflowElementId(java.lang.String value)
                          throws IllegalPropertyValueException,
                                 PropertyIsReadOnlyException
Sets 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.

This property is read-only and can only be modified during creation of a Workflow Element.

Parameters:
value - The value of the "workflow-element-id" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Workflow Element is not being initialized.