org.opends.server.admin.std.server

Interface CollationMatchingRuleCfg

All Superinterfaces:

Configuration, MatchingRuleCfg

public interface CollationMatchingRuleCfg
extends MatchingRuleCfg

A server-side interface for querying Collation Matching Rule settings.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener) Register to be notified when this Collation Matching Rule is changed.
Class<? extends CollationMatchingRuleCfg>	configurationClass() Gets the configuration class associated with this Collation Matching Rule.
SortedSet<String>	getCollation() Gets the "collation" property.
String	getJavaClass() Gets the "java-class" property.
SortedSet<CollationMatchingRuleCfgDefn.MatchingRuleType>	getMatchingRuleType() Gets the "matching-rule-type" property.
void	removeCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener) Deregister an existing Collation Matching Rule configuration change listener.

Methods inherited from interface org.opends.server.admin.std.server.MatchingRuleCfg

addChangeListener, isEnabled, removeChangeListener

Methods inherited from interface org.opends.server.admin.Configuration

dn

Method Detail

configurationClass

Class<? extends CollationMatchingRuleCfg> configurationClass()

Gets the configuration class associated with this Collation Matching Rule.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface MatchingRuleCfg

Returns:

Returns the configuration class associated with this Collation Matching Rule.

addCollationChangeListener

void addCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener)

Register to be notified when this Collation Matching Rule is changed.

Parameters:

listener - The Collation Matching Rule configuration change listener.

removeCollationChangeListener

void removeCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener)

Deregister an existing Collation Matching Rule configuration change listener.

Parameters:

listener - The Collation Matching Rule configuration change listener.

getCollation

SortedSet<String> getCollation()

Gets the "collation" property.

the set of supported locales

Collation must be specified using the syntax: LOCALE:OID

Returns:

Returns an unmodifiable set containing the values of the "collation" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Collation Matching Rule implementation.

Specified by:

getJavaClass in interface MatchingRuleCfg

Returns:

Returns the value of the "java-class" property.

getMatchingRuleType

SortedSet<CollationMatchingRuleCfgDefn.MatchingRuleType> getMatchingRuleType()

Gets the "matching-rule-type" property.

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

Returns:

Returns an unmodifiable set containing the values of the "matching-rule-type" property.