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

java.lang.Object
  org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      org.opends.server.admin.ManagedObjectDefinition<WorkflowElementCfgClient,WorkflowElementCfg>
          org.opends.server.admin.std.meta.WorkflowElementCfgDefn

public final class WorkflowElementCfgDefn
extends ManagedObjectDefinition<WorkflowElementCfgClient,WorkflowElementCfg>

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

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

Method Summary

WorkflowElementCfgClient	createClientConfiguration(ManagedObject<? extends WorkflowElementCfgClient> impl) Creates a client configuration view of the provided managed object.
WorkflowElementCfg	createServerConfiguration(ServerManagedObject<? extends WorkflowElementCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static WorkflowElementCfgDefn	getInstance() Get the Workflow Element configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
java.lang.Class<WorkflowElementCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getWorkflowElementIdPropertyDefinition() Get the "workflow-element-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 WorkflowElementCfgDefn getInstance()

Get the Workflow Element configuration definition singleton.

Returns:

Returns the Workflow Element configuration definition singleton.

createClientConfiguration

public WorkflowElementCfgClient createClientConfiguration(ManagedObject<? extends WorkflowElementCfgClient> 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<WorkflowElementCfgClient,WorkflowElementCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public WorkflowElementCfg createServerConfiguration(ServerManagedObject<? extends WorkflowElementCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<WorkflowElementCfgClient,WorkflowElementCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<WorkflowElementCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<WorkflowElementCfgClient,WorkflowElementCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

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

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getWorkflowElementIdPropertyDefinition

public StringPropertyDefinition getWorkflowElementIdPropertyDefinition()

Get the "workflow-element-id" property definition.

Provides a name that identifies the associated Workflow Element .

The name must be unique among all Workflow Elements in the server.

Returns:

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