|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
org.opends.server.schema.TelephoneNumberSyntax
public class TelephoneNumberSyntax
This class implements the telephone number attribute syntax, which is defined in RFC 2252. Note that this can have two modes of operation, depending on its configuration. Most of the time, it will be very lenient when deciding what to accept, and will allow anything but only pay attention to the digits. However, it can also be configured in a "strict" mode, in which case it will only accept values in the E.123 international telephone number format.
Constructor Summary | |
---|---|
TelephoneNumberSyntax()
Creates a new instance of this syntax. |
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(TelephoneNumberAttributeSyntaxCfg configuration)
Applies the configuration changes to this change listener. |
void |
finalizeSyntax()
Performs any finalization that may be necessary for this attribute syntax. |
ApproximateMatchingRule |
getApproximateMatchingRule()
Retrieves the default approximate matching rule that will be used for attributes with this syntax. |
java.lang.String |
getDescription()
Retrieves a description for this attribute syntax. |
EqualityMatchingRule |
getEqualityMatchingRule()
Retrieves the default equality matching rule that will be used for attributes with this syntax. |
java.lang.String |
getOID()
Retrieves the OID for this attribute syntax. |
OrderingMatchingRule |
getOrderingMatchingRule()
Retrieves the default ordering matching rule that will be used for attributes with this syntax. |
SubstringMatchingRule |
getSubstringMatchingRule()
Retrieves the default substring matching rule that will be used for attributes with this syntax. |
java.lang.String |
getSyntaxName()
Retrieves the common name for this attribute syntax. |
void |
initializeSyntax(TelephoneNumberAttributeSyntaxCfg configuration)
Initializes this attribute syntax based on the information in the provided configuration entry. |
boolean |
isConfigurationChangeAcceptable(TelephoneNumberAttributeSyntaxCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
boolean |
valueIsAcceptable(ByteString value,
MessageBuilder invalidReason)
Indicates whether the provided value is acceptable for use in an attribute with this syntax. |
Methods inherited from class org.opends.server.api.AttributeSyntax |
---|
equals, hashCode, isConfigurationAcceptable, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TelephoneNumberSyntax()
initializeSyntax
method.
Method Detail |
---|
public void initializeSyntax(TelephoneNumberAttributeSyntaxCfg configuration) throws ConfigException
initializeSyntax
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
configuration
- The configuration to use to initialize
this attribute syntax.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.public void finalizeSyntax()
finalizeSyntax
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
public java.lang.String getSyntaxName()
getSyntaxName
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
public java.lang.String getOID()
getOID
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
public java.lang.String getDescription()
getDescription
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
public EqualityMatchingRule getEqualityMatchingRule()
getEqualityMatchingRule
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
null
if equality
matches will not be allowed for this type by default.public OrderingMatchingRule getOrderingMatchingRule()
getOrderingMatchingRule
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
null
if ordering
matches will not be allowed for this type by default.public SubstringMatchingRule getSubstringMatchingRule()
getSubstringMatchingRule
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
null
if substring
matches will not be allowed for this type by default.public ApproximateMatchingRule getApproximateMatchingRule()
getApproximateMatchingRule
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
null
if approximate
matches will not be allowed for this type by default.public boolean valueIsAcceptable(ByteString value, MessageBuilder invalidReason)
valueIsAcceptable
in class AttributeSyntax<TelephoneNumberAttributeSyntaxCfg>
value
- The value for which to make the determination.invalidReason
- The buffer to which the invalid reason should be
appended.
true
if the provided value is acceptable for use with
this syntax, or false
if not.public boolean isConfigurationChangeAcceptable(TelephoneNumberAttributeSyntaxCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<TelephoneNumberAttributeSyntaxCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(TelephoneNumberAttributeSyntaxCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<TelephoneNumberAttributeSyntaxCfg>
configuration
- The new configuration containing the changes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |