001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.api.extension;
017
018import org.kuali.rice.core.api.mo.common.Identifiable;
019import org.kuali.rice.core.api.mo.common.Versioned;
020
021import java.util.Map;
022
023/**
024 * Defines an extension to some component of Kuali Enterprise Workflow.
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface ExtensionDefinitionContract extends Identifiable, Versioned {
029
030    String getName();
031
032    String getApplicationId();
033
034    String getLabel();
035
036    String getDescription();
037
038    /**
039     * The "type" of extension definition.  For example, attributes types are defined in:
040     * {@link org.kuali.rice.kew.api.KewApiConstants#RULE_ATTRIBUTE_TYPES}
041     * @see org.kuali.rice.kew.api.KewApiConstants#RULE_ATTRIBUTE_TYPES
042     * @return the extension definition type
043     */
044    String getType();
045
046    /**
047     * Retrieves the resource descriptor for this extension.  This gives the calling code the
048     * information it needs to locate and execute the extension resource if it needs to. In practice
049     * this is a fully qualified class name.
050     *
051     * @return the resource descriptor for this extension, this value should never be blank or null
052     */
053    String getResourceDescriptor();
054
055    /**
056     * Returns a list of key/value settings that the extension was statically configured with when defined.
057     * @return a list of key/value settings that the extension was statically configured with when defined.
058     */
059    Map<String, String> getConfiguration();
060
061}