org.opends.server.admin

Class AggregationPropertyDefinition.Builder<C extends ConfigurationClient,S extends Configuration>

java.lang.Object

org.opends.server.admin.PropertyDefinition.AbstractBuilder<String,AggregationPropertyDefinition<C,S>>

org.opends.server.admin.AggregationPropertyDefinition.Builder<C,S>

Type Parameters:

C - The type of client managed object configuration that this aggregation property definition refers to.

S - The type of server managed object configuration that this aggregation property definition refers to.

Enclosing class:

AggregationPropertyDefinition<C extends ConfigurationClient,S extends Configuration>

public static class AggregationPropertyDefinition.Builder<C extends ConfigurationClient,S extends Configuration>
extends PropertyDefinition.AbstractBuilder<String,AggregationPropertyDefinition<C,S>>

An interface for incrementally constructing aggregation property definitions.

Method Summary

Methods

Modifier and Type	Method and Description
protected AggregationPropertyDefinition<C,S>	buildInstance(AbstractManagedObjectDefinition<?,?> d, String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction, DefaultBehaviorProvider<String> defaultBehavior) Build a property definition based on the properties of this builder.
void	setParentPath(String pathString) Sets the name of the managed object which is the parent of the aggregated managed objects.
void	setRelationDefinition(String rdName) Sets the relation in the parent managed object which contains the aggregated managed objects.
void	setTargetIsEnabledCondition(Condition condition) Sets the condition which is used to determine if a referenced managed object is enabled.
void	setTargetNeedsEnablingCondition(Condition condition) Sets the condition which is used to determine whether or not referenced managed objects need to be enabled.

Methods inherited from class org.opends.server.admin.PropertyDefinition.AbstractBuilder

getInstance, setAdministratorAction, setDefaultBehaviorProvider, setOption

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setParentPath

public final void setParentPath(String pathString)

Sets the name of the managed object which is the parent of the aggregated managed objects.

This must be defined before the property definition can be built.

Parameters:

pathString - The string representation of the managed object path specifying the parent of the aggregated managed objects.

setRelationDefinition

public final void setRelationDefinition(String rdName)

Sets the relation in the parent managed object which contains the aggregated managed objects.

This must be defined before the property definition can be built.

Parameters:

rdName - The name of a relation in the parent managed object which contains the aggregated managed objects.

setTargetIsEnabledCondition

public final void setTargetIsEnabledCondition(Condition condition)

Sets the condition which is used to determine if a referenced managed object is enabled. By default referenced managed objects are assumed to always be enabled.

Parameters:

condition - The condition which is used to determine if a referenced managed object is enabled.

setTargetNeedsEnablingCondition

public final void setTargetNeedsEnablingCondition(Condition condition)

Sets the condition which is used to determine whether or not referenced managed objects need to be enabled. By default referenced managed objects must always be enabled.

Parameters:

condition - The condition which is used to determine whether or not referenced managed objects need to be enabled.

buildInstance

protected AggregationPropertyDefinition<C,S> buildInstance(AbstractManagedObjectDefinition<?,?> d,
                                               String propertyName,
                                               EnumSet<PropertyOption> options,
                                               AdministratorAction adminAction,
                                               DefaultBehaviorProvider<String> defaultBehavior)

Build a property definition based on the properties of this builder.

Specified by:

buildInstance in class PropertyDefinition.AbstractBuilder<String,AggregationPropertyDefinition<C extends ConfigurationClient,S extends Configuration>>

Parameters:

d - The managed object definition associated with this property definition.

propertyName - The property name.

options - Options applicable to this definition.

adminAction - The administrator action.

defaultBehavior - The default behavior provider.

Returns:

The new property definition.