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 java.util.Collection;
032    import java.util.SortedSet;
033    import org.opends.server.admin.IllegalPropertyValueException;
034    import org.opends.server.admin.ManagedObjectDefinition;
035    import org.opends.server.admin.std.server.UserDefinedVirtualAttributeCfg;
036    
037    
038    
039    /**
040     * A client-side interface for reading and modifying User Defined
041     * Virtual Attribute settings.
042     * <p>
043     * The User Defined Virtual Attribute creates virtual attributes with
044     * user-defined values in entries that match the criteria defined in
045     * the plug-in's configuration.
046     */
047    public interface UserDefinedVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
048    
049      /**
050       * Get the configuration definition associated with this User Defined Virtual Attribute.
051       *
052       * @return Returns the configuration definition associated with this User Defined Virtual Attribute.
053       */
054      ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient, ? extends UserDefinedVirtualAttributeCfg> definition();
055    
056    
057    
058      /**
059       * Gets the "java-class" property.
060       * <p>
061       * Specifies the fully-qualified name of the virtual attribute
062       * provider class that generates the attribute values.
063       *
064       * @return Returns the value of the "java-class" property.
065       */
066      String getJavaClass();
067    
068    
069    
070      /**
071       * Sets the "java-class" property.
072       * <p>
073       * Specifies the fully-qualified name of the virtual attribute
074       * provider class that generates the attribute values.
075       *
076       * @param value The value of the "java-class" property.
077       * @throws IllegalPropertyValueException
078       *           If the new value is invalid.
079       */
080      void setJavaClass(String value) throws IllegalPropertyValueException;
081    
082    
083    
084      /**
085       * Gets the "value" property.
086       * <p>
087       * Specifies the values to be included in the virtual attribute.
088       *
089       * @return Returns the values of the "value" property.
090       */
091      SortedSet<String> getValue();
092    
093    
094    
095      /**
096       * Sets the "value" property.
097       * <p>
098       * Specifies the values to be included in the virtual attribute.
099       *
100       * @param values The values of the "value" property.
101       * @throws IllegalPropertyValueException
102       *           If one or more of the new values are invalid.
103       */
104      void setValue(Collection<String> values) throws IllegalPropertyValueException;
105    
106    }