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.krms.api.repository.action;
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 the contract for an {@link ActionDefinition}
025 *
026 * @see ActionDefinition
027 * @see org.kuali.rice.krms.framework.engine.Action
028 *
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 */
031public interface ActionDefinitionContract extends Identifiable, Versioned {
032
033        /**
034         * Returns the name of the Action
035         *
036         * <p>
037         * name - the name of the Action
038         * </p>
039         * @return the name of the Action
040         */
041        public String getName();
042
043        /**
044         * Returns the namespace of the Action
045         *
046         * <p>
047         * The namespace of the Action
048         * </p>
049         * @return the namespace of the Action
050         */
051        public String getNamespace();
052
053    /**
054     * Returns the description for what the parameter is used for.  This can be null or a blank string.
055     *
056     * @return the description of the Action
057     */
058        public String getDescription();
059
060        /**
061         * Returns the KrmsType of the Action
062         *
063         * @return id for KRMS type related of the Action
064         */
065        public String getTypeId();
066        
067        /**
068         * Returns the id of the rule associated with the action
069         * 
070         * @return id for the Rule associated with the action.
071         */
072        public String getRuleId();
073        
074        /**
075         * Returns the sequence number of the  action
076         * 
077         * @return sequence number of the action.
078         */
079        public Integer getSequenceNumber();
080        
081        /**
082         * Returns a set of attributes associated with the
083         * Action.  The attributes are represented as name/value pairs.
084         * 
085         * @return a set of ActionAttribute objects.
086         */
087        public Map<String, String> getAttributes();
088        
089
090}