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

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
AttributeTypeDescriptionAttributeSyntaxCfgClient, DirectoryStringAttributeSyntaxCfgClient, TelephoneNumberAttributeSyntaxCfgClient

public interface AttributeSyntaxCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Attribute Syntax settings.

Attribute Syntaxes define the type of data that may be stored in an attribute with that syntax. A syntax is generally associated with a set of matching rules that indicate how to perform matching operations against values of that syntax.


Method Summary
 ManagedObjectDefinition<? extends AttributeSyntaxCfgClient,? extends AttributeSyntaxCfg> definition()
          Get the configuration definition associated with this Attribute Syntax.
 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 AttributeSyntaxCfgClient,? extends AttributeSyntaxCfg> definition()
Get the configuration definition associated with this Attribute Syntax.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Attribute Syntax.

isEnabled

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

Indicates whether the Attribute Syntax is enabled.

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

setEnabled

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

Indicates whether the Attribute Syntax is enabled.

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 Attribute Syntax implementation.

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

setJavaClass

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

Specifies the fully-qualified name of the Java class that provides the Attribute Syntax implementation.

This property is read-only and can only be modified during creation of a Attribute Syntax.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Attribute Syntax is not being initialized.