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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.CountryStringAttributeSyntaxCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Country String
038 * Attribute Syntax settings.
039 * <p>
040 * Country String Attribute Syntaxes define an attribute syntax for
041 * storing country codes.
042 */
043public interface CountryStringAttributeSyntaxCfgClient extends AttributeSyntaxCfgClient {
044
045  /**
046   * Get the configuration definition associated with this Country String Attribute Syntax.
047   *
048   * @return Returns the configuration definition associated with this Country String Attribute Syntax.
049   */
050  ManagedObjectDefinition<? extends CountryStringAttributeSyntaxCfgClient, ? extends CountryStringAttributeSyntaxCfg> definition();
051
052
053
054  /**
055   * Gets the "java-class" property.
056   * <p>
057   * Specifies the fully-qualified name of the Java class that
058   * provides the Country String Attribute Syntax implementation.
059   *
060   * @return Returns the value of the "java-class" property.
061   */
062  String getJavaClass();
063
064
065
066  /**
067   * Sets the "java-class" property.
068   * <p>
069   * Specifies the fully-qualified name of the Java class that
070   * provides the Country String Attribute Syntax implementation.
071   * <p>
072   * This property is read-only and can only be modified during
073   * creation of a Country String Attribute Syntax.
074   *
075   * @param value The value of the "java-class" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   * @throws PropertyException
079   *           If this Country String Attribute Syntax is not being initialized.
080   */
081  void setJavaClass(String value) throws PropertyException, PropertyException;
082
083
084
085  /**
086   * Gets the "strict-format" property.
087   * <p>
088   * Indicates whether or not country code values are required to
089   * strictly comply with the standard definition for this syntax.
090   * <p>
091   * When set to false, country codes will not be validated and, as a
092   * result any string containing 2 characters will be acceptable.
093   *
094   * @return Returns the value of the "strict-format" property.
095   */
096  boolean isStrictFormat();
097
098
099
100  /**
101   * Sets the "strict-format" property.
102   * <p>
103   * Indicates whether or not country code values are required to
104   * strictly comply with the standard definition for this syntax.
105   * <p>
106   * When set to false, country codes will not be validated and, as a
107   * result any string containing 2 characters will be acceptable.
108   *
109   * @param value The value of the "strict-format" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   */
113  void setStrictFormat(Boolean value) throws PropertyException;
114
115}