org.opends.server.admin.std.client
Interface MatchingRuleCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
ApproximateMatchingRuleCfgClient, EqualityMatchingRuleCfgClient, OrderingMatchingRuleCfgClient, SubstringMatchingRuleCfgClient

public interface MatchingRuleCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Matching Rule settings.

Matching Rules define a set of rules for performing matching operations against assertion values.


Method Summary
 ManagedObjectDefinition<? extends MatchingRuleCfgClient,? extends MatchingRuleCfg> definition()
          Get the configuration definition associated with this Matching Rule.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends MatchingRuleCfgClient,? extends MatchingRuleCfg> definition()
Get the configuration definition associated with this Matching Rule.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Matching Rule.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Matching Rule is enabled for use.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Matching Rule is enabled for use.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.