|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowCfgClient
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 |
---|
ManagedObjectDefinition<? extends WorkflowCfgClient,? extends WorkflowCfg> definition()
definition
in interface ConfigurationClient
DN getBaseDN()
Specifies the base DN of the data targeted by the Workflow .
void setBaseDN(DN value) throws IllegalPropertyValueException
Specifies the base DN of the data targeted by the Workflow .
value
- The value of the "base-dn" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.Boolean isEnabled()
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.
void setEnabled(boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "enabled" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getWorkflowElement()
Specifies the root Work Flow Element in the Workflow .
void setWorkflowElement(java.lang.String value) throws IllegalPropertyValueException
Specifies the root Work Flow Element in the Workflow .
value
- The value of the "workflow-element" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getWorkflowId()
Provides a name that identifies the Workflow.
The name must be unique among all Workflows in the server.
void setWorkflowId(java.lang.String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException
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.
value
- The value of the "workflow-id" property.
IllegalPropertyValueException
- If the new value is invalid.
PropertyIsReadOnlyException
- If this Workflow is not being initialized.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |