org.opends.server.admin.std.meta
Class WorkflowCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<WorkflowCfgClient,WorkflowCfg>
          extended by org.opends.server.admin.std.meta.WorkflowCfgDefn

public final class WorkflowCfgDefn
extends ManagedObjectDefinition<WorkflowCfgClient,WorkflowCfg>

An interface for querying the Workflow managed object definition meta information.

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
 WorkflowCfgClient createClientConfiguration(ManagedObject<? extends WorkflowCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 WorkflowCfg createServerConfiguration(ServerManagedObject<? extends WorkflowCfg> impl)
          Creates a server configuration view of the provided server managed object.
 DNPropertyDefinition getBaseDNPropertyDefinition()
          Get the "base-dn" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static WorkflowCfgDefn getInstance()
          Get the Workflow configuration definition singleton.
 java.lang.Class<WorkflowCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 AggregationPropertyDefinition<WorkflowElementCfgClient,WorkflowElementCfg> getWorkflowElementPropertyDefinition()
          Get the "workflow-element" property definition.
 StringPropertyDefinition getWorkflowIdPropertyDefinition()
          Get the "workflow-id" property definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static WorkflowCfgDefn getInstance()
Get the Workflow configuration definition singleton.

Returns:
Returns the Workflow configuration definition singleton.

createClientConfiguration

public WorkflowCfgClient createClientConfiguration(ManagedObject<? extends WorkflowCfgClient> impl)
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:
createClientConfiguration in class ManagedObjectDefinition<WorkflowCfgClient,WorkflowCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public WorkflowCfg createServerConfiguration(ServerManagedObject<? extends WorkflowCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<WorkflowCfgClient,WorkflowCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<WorkflowCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<WorkflowCfgClient,WorkflowCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getBaseDNPropertyDefinition

public DNPropertyDefinition getBaseDNPropertyDefinition()
Get the "base-dn" property definition.

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

Returns:
Returns the "base-dn" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

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 "enabled" property definition.

getWorkflowElementPropertyDefinition

public AggregationPropertyDefinition<WorkflowElementCfgClient,WorkflowElementCfg> getWorkflowElementPropertyDefinition()
Get the "workflow-element" property definition.

Specifies the root Work Flow Element in the Workflow .

Returns:
Returns the "workflow-element" property definition.

getWorkflowIdPropertyDefinition

public StringPropertyDefinition getWorkflowIdPropertyDefinition()
Get the "workflow-id" property definition.

Provides a name that identifies the Workflow.

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

Returns:
Returns the "workflow-id" property definition.