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.ConfigurationClient;
032    import org.opends.server.admin.IllegalPropertyValueException;
033    import org.opends.server.admin.ManagedObjectDefinition;
034    import org.opends.server.admin.PropertyIsReadOnlyException;
035    import org.opends.server.admin.std.server.AttributeSyntaxCfg;
036    
037    
038    
039    /**
040     * A client-side interface for reading and modifying Attribute Syntax
041     * settings.
042     * <p>
043     * Attribute Syntaxes define the type of data that may be stored in an
044     * attribute with that syntax. A syntax is generally associated with a
045     * set of matching rules that indicate how to perform matching
046     * operations against values of that syntax.
047     */
048    public interface AttributeSyntaxCfgClient extends ConfigurationClient {
049    
050      /**
051       * Get the configuration definition associated with this Attribute Syntax.
052       *
053       * @return Returns the configuration definition associated with this Attribute Syntax.
054       */
055      ManagedObjectDefinition<? extends AttributeSyntaxCfgClient, ? extends AttributeSyntaxCfg> definition();
056    
057    
058    
059      /**
060       * Gets the "enabled" property.
061       * <p>
062       * Indicates whether the Attribute Syntax is enabled.
063       *
064       * @return Returns the value of the "enabled" property.
065       */
066      Boolean isEnabled();
067    
068    
069    
070      /**
071       * Sets the "enabled" property.
072       * <p>
073       * Indicates whether the Attribute Syntax is enabled.
074       *
075       * @param value The value of the "enabled" property.
076       * @throws IllegalPropertyValueException
077       *           If the new value is invalid.
078       */
079      void setEnabled(boolean value) throws IllegalPropertyValueException;
080    
081    
082    
083      /**
084       * Gets the "java-class" property.
085       * <p>
086       * Specifies the fully-qualified name of the Java class that
087       * provides the Attribute Syntax implementation.
088       *
089       * @return Returns the value of the "java-class" property.
090       */
091      String getJavaClass();
092    
093    
094    
095      /**
096       * Sets the "java-class" property.
097       * <p>
098       * Specifies the fully-qualified name of the Java class that
099       * provides the Attribute Syntax implementation.
100       * <p>
101       * This property is read-only and can only be modified during
102       * creation of a Attribute Syntax.
103       *
104       * @param value The value of the "java-class" property.
105       * @throws IllegalPropertyValueException
106       *           If the new value is invalid.
107       * @throws PropertyIsReadOnlyException
108       *           If this Attribute Syntax is not being initialized.
109       */
110      void setJavaClass(String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException;
111    
112    }