001 /*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License"). You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.client;
028
029
030
031 import org.opends.server.admin.IllegalPropertyValueException;
032 import org.opends.server.admin.ManagedObjectDefinition;
033 import org.opends.server.admin.PropertyIsReadOnlyException;
034 import org.opends.server.admin.std.server.TelephoneNumberAttributeSyntaxCfg;
035
036
037
038 /**
039 * A client-side interface for reading and modifying Telephone Number
040 * Attribute Syntax settings.
041 * <p>
042 * Telephone Number Attribute Syntaxes define an attribute syntax for
043 * storing telephone number information.
044 */
045 public interface TelephoneNumberAttributeSyntaxCfgClient extends AttributeSyntaxCfgClient {
046
047 /**
048 * Get the configuration definition associated with this Telephone Number Attribute Syntax.
049 *
050 * @return Returns the configuration definition associated with this Telephone Number Attribute Syntax.
051 */
052 ManagedObjectDefinition<? extends TelephoneNumberAttributeSyntaxCfgClient, ? extends TelephoneNumberAttributeSyntaxCfg> definition();
053
054
055
056 /**
057 * Gets the "java-class" property.
058 * <p>
059 * Specifies the fully-qualified name of the Java class that
060 * provides the Telephone Number Attribute Syntax implementation.
061 *
062 * @return Returns the value of the "java-class" property.
063 */
064 String getJavaClass();
065
066
067
068 /**
069 * Sets the "java-class" property.
070 * <p>
071 * Specifies the fully-qualified name of the Java class that
072 * provides the Telephone Number Attribute Syntax implementation.
073 * <p>
074 * This property is read-only and can only be modified during
075 * creation of a Telephone Number Attribute Syntax.
076 *
077 * @param value The value of the "java-class" property.
078 * @throws IllegalPropertyValueException
079 * If the new value is invalid.
080 * @throws PropertyIsReadOnlyException
081 * If this Telephone Number Attribute Syntax is not being initialized.
082 */
083 void setJavaClass(String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException;
084
085
086
087 /**
088 * Gets the "strict-format" property.
089 * <p>
090 * Indicates whether to require telephone number values to strictly
091 * comply with the standard definition for this syntax.
092 *
093 * @return Returns the value of the "strict-format" property.
094 */
095 boolean isStrictFormat();
096
097
098
099 /**
100 * Sets the "strict-format" property.
101 * <p>
102 * Indicates whether to require telephone number values to strictly
103 * comply with the standard definition for this syntax.
104 *
105 * @param value The value of the "strict-format" property.
106 * @throws IllegalPropertyValueException
107 * If the new value is invalid.
108 */
109 void setStrictFormat(Boolean value) throws IllegalPropertyValueException;
110
111 }