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

All Superinterfaces:
ConfigurationClient

public interface WorkflowCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends WorkflowCfgClient,? extends WorkflowCfg> definition()
          Get the configuration definition associated with this Workflow.
 DN getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getWorkflowElement()
          Gets the "workflow-element" property.
 java.lang.String getWorkflowId()
          Gets the "workflow-id" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setBaseDN(DN value)
          Sets the "base-dn" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setWorkflowElement(java.lang.String value)
          Sets the "workflow-element" property.
 void setWorkflowId(java.lang.String value)
          Sets the "workflow-id" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends WorkflowCfgClient,? extends WorkflowCfg> definition()
Get the configuration definition associated with this Workflow.

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

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.

setBaseDN

void setBaseDN(DN value)
               throws IllegalPropertyValueException
Sets the "base-dn" property.

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

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

isEnabled

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

setEnabled

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

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

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.

setWorkflowElement

void setWorkflowElement(java.lang.String value)
                        throws IllegalPropertyValueException
Sets the "workflow-element" property.

Specifies the root Work Flow Element in the Workflow .

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

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.

setWorkflowId

void setWorkflowId(java.lang.String value)
                   throws IllegalPropertyValueException,
                          PropertyIsReadOnlyException
Sets the "workflow-id" property.

Provides a name that identifies the Workflow.

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

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

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