org.opends.server.admin.std.meta

Class CollationMatchingRuleCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<CollationMatchingRuleCfgClient,CollationMatchingRuleCfg>

org.opends.server.admin.std.meta.CollationMatchingRuleCfgDefn

public final class CollationMatchingRuleCfgDefn
extends ManagedObjectDefinition<CollationMatchingRuleCfgClient,CollationMatchingRuleCfg>

An interface for querying the Collation Matching Rule managed object definition meta information.

Collation Matching Rules provide support for locale-specific filtering and indexing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollationMatchingRuleCfgDefn.MatchingRuleType Defines the set of permissable values for the "matching-rule-type" property.

Method Summary

Methods

Modifier and Type	Method and Description
CollationMatchingRuleCfgClient	createClientConfiguration(ManagedObject<? extends CollationMatchingRuleCfgClient> impl) Creates a client configuration view of the provided managed object.
CollationMatchingRuleCfg	createServerConfiguration(ServerManagedObject<? extends CollationMatchingRuleCfg> impl) Creates a server configuration view of the provided server managed object.
StringPropertyDefinition	getCollationPropertyDefinition() Get the "collation" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static CollationMatchingRuleCfgDefn	getInstance() Get the Collation Matching Rule configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
EnumPropertyDefinition<CollationMatchingRuleCfgDefn.MatchingRuleType>	getMatchingRuleTypePropertyDefinition() Get the "matching-rule-type" property definition.
Class<CollationMatchingRuleCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object 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 CollationMatchingRuleCfgDefn getInstance()

Get the Collation Matching Rule configuration definition singleton.

Returns:

Returns the Collation Matching Rule configuration definition singleton.

createClientConfiguration

public CollationMatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends CollationMatchingRuleCfgClient> 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<CollationMatchingRuleCfgClient,CollationMatchingRuleCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<CollationMatchingRuleCfgClient,CollationMatchingRuleCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<CollationMatchingRuleCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<CollationMatchingRuleCfgClient,CollationMatchingRuleCfg>

Returns:

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

getCollationPropertyDefinition

public StringPropertyDefinition getCollationPropertyDefinition()

Get the "collation" property definition.

the set of supported locales

Collation must be specified using the syntax: LOCALE:OID

Returns:

Returns the "collation" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Collation Matching Rule is enabled for use.

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 Collation Matching Rule implementation.

Returns:

Returns the "java-class" property definition.

getMatchingRuleTypePropertyDefinition

public EnumPropertyDefinition<CollationMatchingRuleCfgDefn.MatchingRuleType> getMatchingRuleTypePropertyDefinition()

Get the "matching-rule-type" property definition.

the types of matching rules that should be supported for each locale

Returns:

Returns the "matching-rule-type" property definition.