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.server;
028    
029    
030    
031    import org.opends.server.admin.Configuration;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    
034    
035    
036    /**
037     * A server-side interface for querying Workflow Element settings.
038     * <p>
039     * Workflow Elements implement a single processing step in a Work
040     * Flow.
041     */
042    public interface WorkflowElementCfg extends Configuration {
043    
044      /**
045       * Gets the configuration class associated with this Workflow Element.
046       *
047       * @return Returns the configuration class associated with this Workflow Element.
048       */
049      Class<? extends WorkflowElementCfg> configurationClass();
050    
051    
052    
053      /**
054       * Register to be notified when this Workflow Element is changed.
055       *
056       * @param listener
057       *          The Workflow Element configuration change listener.
058       */
059      void addChangeListener(ConfigurationChangeListener<WorkflowElementCfg> listener);
060    
061    
062    
063      /**
064       * Deregister an existing Workflow Element configuration change listener.
065       *
066       * @param listener
067       *          The Workflow Element configuration change listener.
068       */
069      void removeChangeListener(ConfigurationChangeListener<WorkflowElementCfg> listener);
070    
071    
072    
073      /**
074       * Gets the "enabled" property.
075       * <p>
076       * Indicates whether the Workflow Element is enabled for use in the
077       * server.
078       * <p>
079       * If a Workflow Element is not enabled, then its contents are not
080       * accessible when processing operations.
081       *
082       * @return Returns the value of the "enabled" property.
083       */
084      boolean isEnabled();
085    
086    
087    
088      /**
089       * Gets the "java-class" property.
090       * <p>
091       * Specifies the fully-qualified name of the Java class that
092       * provides the Workflow Element implementation.
093       *
094       * @return Returns the value of the "java-class" property.
095       */
096      String getJavaClass();
097    
098    
099    
100      /**
101       * Gets the "workflow-element-id" property.
102       * <p>
103       * Provides a name that identifies the associated Workflow Element .
104       * <p>
105       * The name must be unique among all Workflow Elements in the
106       * server.
107       *
108       * @return Returns the value of the "workflow-element-id" property.
109       */
110      String getWorkflowElementId();
111    
112    }