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.WorkflowElementCfg;
036
037
038
039 /**
040 * A client-side interface for reading and modifying Workflow Element
041 * settings.
042 * <p>
043 * Workflow Elements implement a single processing step in a Work
044 * Flow.
045 */
046 public interface WorkflowElementCfgClient extends ConfigurationClient {
047
048 /**
049 * Get the configuration definition associated with this Workflow Element.
050 *
051 * @return Returns the configuration definition associated with this Workflow Element.
052 */
053 ManagedObjectDefinition<? extends WorkflowElementCfgClient, ? extends WorkflowElementCfg> definition();
054
055
056
057 /**
058 * Gets the "enabled" property.
059 * <p>
060 * Indicates whether the Workflow Element is enabled for use in the
061 * server.
062 * <p>
063 * If a Workflow Element is not enabled, then its contents are not
064 * accessible when processing operations.
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 Workflow Element is enabled for use in the
076 * server.
077 * <p>
078 * If a Workflow Element is not enabled, then its contents are not
079 * accessible when processing operations.
080 *
081 * @param value The value of the "enabled" property.
082 * @throws IllegalPropertyValueException
083 * If the new value is invalid.
084 */
085 void setEnabled(boolean value) throws IllegalPropertyValueException;
086
087
088
089 /**
090 * Gets the "java-class" property.
091 * <p>
092 * Specifies the fully-qualified name of the Java class that
093 * provides the Workflow Element implementation.
094 *
095 * @return Returns the value of the "java-class" property.
096 */
097 String getJavaClass();
098
099
100
101 /**
102 * Sets the "java-class" property.
103 * <p>
104 * Specifies the fully-qualified name of the Java class that
105 * provides the Workflow Element implementation.
106 *
107 * @param value The value of the "java-class" property.
108 * @throws IllegalPropertyValueException
109 * If the new value is invalid.
110 */
111 void setJavaClass(String value) throws IllegalPropertyValueException;
112
113
114
115 /**
116 * Gets the "workflow-element-id" property.
117 * <p>
118 * Provides a name that identifies the associated Workflow Element .
119 * <p>
120 * The name must be unique among all Workflow Elements in the
121 * server.
122 *
123 * @return Returns the value of the "workflow-element-id" property.
124 */
125 String getWorkflowElementId();
126
127
128
129 /**
130 * Sets the "workflow-element-id" property.
131 * <p>
132 * Provides a name that identifies the associated Workflow Element .
133 * <p>
134 * The name must be unique among all Workflow Elements in the
135 * server.
136 * <p>
137 * This property is read-only and can only be modified during
138 * creation of a Workflow Element.
139 *
140 * @param value The value of the "workflow-element-id" property.
141 * @throws IllegalPropertyValueException
142 * If the new value is invalid.
143 * @throws PropertyIsReadOnlyException
144 * If this Workflow Element is not being initialized.
145 */
146 void setWorkflowElementId(String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException;
147
148 }