1 /**
2 * Copyright 2005-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.api.extension;
17
18 import org.kuali.rice.core.api.mo.common.Identifiable;
19 import org.kuali.rice.core.api.mo.common.Versioned;
20
21 import java.util.Map;
22
23 /**
24 * Defines an extension to some component of Kuali Enterprise Workflow.
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 public interface ExtensionDefinitionContract extends Identifiable, Versioned {
29
30 String getName();
31
32 String getApplicationId();
33
34 String getLabel();
35
36 String getDescription();
37
38 /**
39 * The "type" of extension definition. For example, attributes types are defined in:
40 * {@link org.kuali.rice.kew.api.KewApiConstants#RULE_ATTRIBUTE_TYPES}
41 * @see org.kuali.rice.kew.api.KewApiConstants#RULE_ATTRIBUTE_TYPES
42 * @return the extension definition type
43 */
44 String getType();
45
46 /**
47 * Retrieves the resource descriptor for this extension. This gives the calling code the
48 * information it needs to locate and execute the extension resource if it needs to. In practice
49 * this is a fully qualified class name.
50 *
51 * @return the resource descriptor for this extension, this value should never be blank or null
52 */
53 String getResourceDescriptor();
54
55 /**
56 * Returns a list of key/value settings that the extension was statically configured with when defined.
57 * @return a list of key/value settings that the extension was statically configured with when defined.
58 */
59 Map<String, String> getConfiguration();
60
61 }