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