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.std.server.AccountStatusNotificationHandlerCfg;
035    
036    
037    
038    /**
039     * A client-side interface for reading and modifying Account Status
040     * Notification Handler settings.
041     * <p>
042     * Account Status Notification Handlers are invoked to provide
043     * notification to users in some form (for example, by an email
044     * message) when the status of a user's account has changed in some
045     * way. The Account Status Notification Handler can be used to notify
046     * the user and/or administrators of the change.
047     */
048    public interface AccountStatusNotificationHandlerCfgClient extends ConfigurationClient {
049    
050      /**
051       * Get the configuration definition associated with this Account Status Notification Handler.
052       *
053       * @return Returns the configuration definition associated with this Account Status Notification Handler.
054       */
055      ManagedObjectDefinition<? extends AccountStatusNotificationHandlerCfgClient, ? extends AccountStatusNotificationHandlerCfg> definition();
056    
057    
058    
059      /**
060       * Gets the "enabled" property.
061       * <p>
062       * Indicates whether the Account Status Notification Handler is
063       * enabled. Only enabled handlers are invoked whenever a related
064       * event occurs in the server.
065       *
066       * @return Returns the value of the "enabled" property.
067       */
068      Boolean isEnabled();
069    
070    
071    
072      /**
073       * Sets the "enabled" property.
074       * <p>
075       * Indicates whether the Account Status Notification Handler is
076       * enabled. Only enabled handlers are invoked whenever a related
077       * event occurs in the server.
078       *
079       * @param value The value of the "enabled" property.
080       * @throws IllegalPropertyValueException
081       *           If the new value is invalid.
082       */
083      void setEnabled(boolean value) throws IllegalPropertyValueException;
084    
085    
086    
087      /**
088       * Gets the "java-class" property.
089       * <p>
090       * Specifies the fully-qualified name of the Java class that
091       * provides the Account Status Notification Handler implementation.
092       *
093       * @return Returns the value of the "java-class" property.
094       */
095      String getJavaClass();
096    
097    
098    
099      /**
100       * Sets the "java-class" property.
101       * <p>
102       * Specifies the fully-qualified name of the Java class that
103       * provides the Account Status Notification Handler implementation.
104       *
105       * @param value The value of the "java-class" property.
106       * @throws IllegalPropertyValueException
107       *           If the new value is invalid.
108       */
109      void setJavaClass(String value) throws IllegalPropertyValueException;
110    
111    }