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.WorkflowCfg; 036 import org.opends.server.types.DN; 037 038 039 040 /** 041 * A client-side interface for reading and modifying Workflow 042 * settings. 043 * <p> 044 * The Workflow is a list of processing steps (Work Flow Elements) 045 * that are applied to data as it is retrieved from the Directory 046 * Server. 047 */ 048 public interface WorkflowCfgClient extends ConfigurationClient { 049 050 /** 051 * Get the configuration definition associated with this Workflow. 052 * 053 * @return Returns the configuration definition associated with this Workflow. 054 */ 055 ManagedObjectDefinition<? extends WorkflowCfgClient, ? extends WorkflowCfg> definition(); 056 057 058 059 /** 060 * Gets the "base-dn" property. 061 * <p> 062 * Specifies the base DN of the data targeted by the Workflow . 063 * 064 * @return Returns the value of the "base-dn" property. 065 */ 066 DN getBaseDN(); 067 068 069 070 /** 071 * Sets the "base-dn" property. 072 * <p> 073 * Specifies the base DN of the data targeted by the Workflow . 074 * 075 * @param value The value of the "base-dn" property. 076 * @throws IllegalPropertyValueException 077 * If the new value is invalid. 078 */ 079 void setBaseDN(DN value) throws IllegalPropertyValueException; 080 081 082 083 /** 084 * Gets the "enabled" property. 085 * <p> 086 * Indicates whether the Workflow is enabled for use in the server. 087 * <p> 088 * If a Workflow is not enabled, then its contents are not 089 * accessible when processing operations. 090 * 091 * @return Returns the value of the "enabled" property. 092 */ 093 Boolean isEnabled(); 094 095 096 097 /** 098 * Sets the "enabled" property. 099 * <p> 100 * Indicates whether the Workflow is enabled for use in the server. 101 * <p> 102 * If a Workflow is not enabled, then its contents are not 103 * accessible when processing operations. 104 * 105 * @param value The value of the "enabled" property. 106 * @throws IllegalPropertyValueException 107 * If the new value is invalid. 108 */ 109 void setEnabled(boolean value) throws IllegalPropertyValueException; 110 111 112 113 /** 114 * Gets the "workflow-element" property. 115 * <p> 116 * Specifies the root Work Flow Element in the Workflow . 117 * 118 * @return Returns the value of the "workflow-element" property. 119 */ 120 String getWorkflowElement(); 121 122 123 124 /** 125 * Sets the "workflow-element" property. 126 * <p> 127 * Specifies the root Work Flow Element in the Workflow . 128 * 129 * @param value The value of the "workflow-element" property. 130 * @throws IllegalPropertyValueException 131 * If the new value is invalid. 132 */ 133 void setWorkflowElement(String value) throws IllegalPropertyValueException; 134 135 136 137 /** 138 * Gets the "workflow-id" property. 139 * <p> 140 * Provides a name that identifies the Workflow. 141 * <p> 142 * The name must be unique among all Workflows in the server. 143 * 144 * @return Returns the value of the "workflow-id" property. 145 */ 146 String getWorkflowId(); 147 148 149 150 /** 151 * Sets the "workflow-id" property. 152 * <p> 153 * Provides a name that identifies the Workflow. 154 * <p> 155 * The name must be unique among all Workflows in the server. 156 * <p> 157 * This property is read-only and can only be modified during 158 * creation of a Workflow. 159 * 160 * @param value The value of the "workflow-id" property. 161 * @throws IllegalPropertyValueException 162 * If the new value is invalid. 163 * @throws PropertyIsReadOnlyException 164 * If this Workflow is not being initialized. 165 */ 166 void setWorkflowId(String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException; 167 168 }