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

All Superinterfaces:
ConfigurationClient, WorkflowElementCfgClient

public interface LocalBackendWorkflowElementCfgClient
extends WorkflowElementCfgClient

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

The Local Backend Workflow Element provides access to a backend.


Method Summary
 ManagedObjectDefinition<? extends LocalBackendWorkflowElementCfgClient,? extends LocalBackendWorkflowElementCfg> definition()
          Get the configuration definition associated with this Local Backend Workflow Element.
 java.lang.String getBackend()
          Gets the "backend" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void setBackend(java.lang.String value)
          Sets the "backend" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.std.client.WorkflowElementCfgClient
getWorkflowElementId, isEnabled, setEnabled, setWorkflowElementId
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends LocalBackendWorkflowElementCfgClient,? extends LocalBackendWorkflowElementCfg> definition()
Get the configuration definition associated with this Local Backend Workflow Element.

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

getBackend

java.lang.String getBackend()
Gets the "backend" property.

Identifies the backend accessed by the workflow element.

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

setBackend

void setBackend(java.lang.String value)
                throws IllegalPropertyValueException,
                       PropertyIsReadOnlyException
Sets the "backend" property.

Identifies the backend accessed by the workflow element.

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

Parameters:
value - The value of the "backend" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Local Backend Workflow Element is not being initialized.

getJavaClass

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

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

Specified by:
getJavaClass in interface WorkflowElementCfgClient
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 Local Backend Workflow Element implementation.

Specified by:
setJavaClass in interface WorkflowElementCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.