Coverage Report

Coverage Report - org.kuali.rice.krms.api.repository.action.ActionDefinitionContract

Classes in this File

 /**
  * Copyright 2005-2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.krms.api.repository.action;
 
 import org.kuali.rice.core.api.mo.common.Identifiable;
 import org.kuali.rice.core.api.mo.common.Versioned;
 
 import java.util.Map;
 
 public interface ActionDefinitionContract extends Identifiable, Versioned {
 
         /**
          * This is the name of the Action 
          *
          * <p>
          * name - the name of the Action
          * </p>
          * @return the name of the Action
          */
         public String getName();
 
         /**
          * This is the namespace of the Action 
          *
          * <p>
          * The namespace of the Action
          * </p>
          * @return the namespace of the Action
          */
         public String getNamespace();
 
     /**
      * This is the description for what the parameter is used for.  This can be null or a blank string.
      * @return description
      */
         public String getDescription();
 
         /**
          * This is the KrmsType of the Action
          *
          * @return id for KRMS type related of the Action
          */
         public String getTypeId();
         
         /**
          * This method returns the id of the rule associated with the action
          * 
          * @return id for the Rule associated with the action.
          */
         public String getRuleId();
         
         /**
          * This method returns the id of the rule associated with the action
          * 
          * @return id for the Rule associated with the action.
          */
         public Integer getSequenceNumber();
         
         /**
          * This method returns a set of attributes associated with the 
          * Action.  The attributes are represented as name/value pairs.
          * 
          * @return a set of ActionAttribute objects.
          */
         public Map<String, String> getAttributes();
         
 
 }

1		/**
2		* Copyright 2005-2011 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.krms.api.repository.action;
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		public interface ActionDefinitionContract extends Identifiable, Versioned {
24
25		/**
26		* This is the name of the Action
27		*
28		* <p>
29		* name - the name of the Action
30		* </p>
31		* @return the name of the Action
32		*/
33		public String getName();
34
35		/**
36		* This is the namespace of the Action
37		*
38		* <p>
39		* The namespace of the Action
40		* </p>
41		* @return the namespace of the Action
42		*/
43		public String getNamespace();
44
45		/**
46		* This is the description for what the parameter is used for. This can be null or a blank string.
47		* @return description
48		*/
49		public String getDescription();
50
51		/**
52		* This is the KrmsType of the Action
53		*
54		* @return id for KRMS type related of the Action
55		*/
56		public String getTypeId();
57
58		/**
59		* This method returns the id of the rule associated with the action
60		*
61		* @return id for the Rule associated with the action.
62		*/
63		public String getRuleId();
64
65		/**
66		* This method returns the id of the rule associated with the action
67		*
68		* @return id for the Rule associated with the action.
69		*/
70		public Integer getSequenceNumber();
71
72		/**
73		* This method returns a set of attributes associated with the
74		* Action. The attributes are represented as name/value pairs.
75		*
76		* @return a set of ActionAttribute objects.
77		*/
78		public Map<String, String> getAttributes();
79
80
81		}