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.IllegalPropertyValueException;
032    import org.opends.server.admin.ManagedObjectDefinition;
033    import org.opends.server.admin.PropertyIsReadOnlyException;
034    import org.opends.server.admin.std.server.LocalBackendWorkflowElementCfg;
035    
036    
037    
038    /**
039     * A client-side interface for reading and modifying Local Backend
040     * Workflow Element settings.
041     * <p>
042     * The Local Backend Workflow Element provides access to a backend.
043     */
044    public interface LocalBackendWorkflowElementCfgClient extends WorkflowElementCfgClient {
045    
046      /**
047       * Get the configuration definition associated with this Local Backend Workflow Element.
048       *
049       * @return Returns the configuration definition associated with this Local Backend Workflow Element.
050       */
051      ManagedObjectDefinition<? extends LocalBackendWorkflowElementCfgClient, ? extends LocalBackendWorkflowElementCfg> definition();
052    
053    
054    
055      /**
056       * Gets the "backend" property.
057       * <p>
058       * Identifies the backend accessed by the workflow element.
059       *
060       * @return Returns the value of the "backend" property.
061       */
062      String getBackend();
063    
064    
065    
066      /**
067       * Sets the "backend" property.
068       * <p>
069       * Identifies the backend accessed by the workflow element.
070       * <p>
071       * This property is read-only and can only be modified during
072       * creation of a Local Backend Workflow Element.
073       *
074       * @param value The value of the "backend" property.
075       * @throws IllegalPropertyValueException
076       *           If the new value is invalid.
077       * @throws PropertyIsReadOnlyException
078       *           If this Local Backend Workflow Element is not being initialized.
079       */
080      void setBackend(String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException;
081    
082    
083    
084      /**
085       * Gets the "java-class" property.
086       * <p>
087       * Specifies the fully-qualified name of the Java class that
088       * provides the Local Backend Workflow Element implementation.
089       *
090       * @return Returns the value of the "java-class" property.
091       */
092      String getJavaClass();
093    
094    
095    
096      /**
097       * Sets the "java-class" property.
098       * <p>
099       * Specifies the fully-qualified name of the Java class that
100       * provides the Local Backend Workflow Element implementation.
101       *
102       * @param value The value of the "java-class" property.
103       * @throws IllegalPropertyValueException
104       *           If the new value is invalid.
105       */
106      void setJavaClass(String value) throws IllegalPropertyValueException;
107    
108    }