Coverage Report

Coverage Report - org.kuali.rice.krms.api.repository.rule.RuleDefinitionContract

Classes in this File

 package org.kuali.rice.krms.api.repository.rule;
 
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
 import org.kuali.rice.core.api.mo.common.Identifiable;
 import org.kuali.rice.core.api.mo.common.Versioned;
 import org.kuali.rice.krms.api.repository.action.ActionDefinitionContract;
 import org.kuali.rice.krms.api.repository.proposition.PropositionDefinitionContract;
 
 public interface RuleDefinitionContract extends Identifiable, Versioned {
     /**
      * This is the name of the Rule 
      * <p>
      * name - the name of the Rule
      * </p>
      * @return the name of the Rule
      */
     public String getName();
 
     /**
      * This is the description of the Rule 
      * <p>
      * description - the description of the Rule
      * </p>
      * @return the description of the Rule
      */
     public String getDescription();
 
         /**
          * This is the namespace of the Rule 
          * <p>
          * The namespace of the Rule
          * </p>
          * @return the namespace of the Rule
          */
         public String getNamespace();
 
         /**
          * This is the KrmsType of the Rule
          *
          * @return id for KRMS type related of the Rule
          */
         public String getTypeId();
         
         /**
          * This method returns the ID of the Proposition associated with the rule.
          * <p>
          * Each Rule has exactly one Proposition associated with it.
          * <p>
          * @return the id of the Proposition associated with the Rule
          */
         public String getPropId();
         
         /**
          * This method returns the Proposition associated with the rule.
          * <p>
          * Each Rule has exactly one Proposition associated with it.
          * <p>
          * @return an immutable represtentation of the Proposition associated with the Rule
          */
         public PropositionDefinitionContract getProposition();
         
         /**
          * This method returns a list of Actions associated with the Rule.
          * <p>
          * A Rule may have zero or more Actions associated with it.
          * <p>
          * @return An ordered list of Actions associated with a Rule.
          */
         public List<? extends ActionDefinitionContract> getActions();
 
         /**
          * This method returns a Map of attributes associated with the 
          * Rule. The attributes are represented as name/value pairs.
          * 
          * @return a Map<String,String> of RuleAttribute objects.
          */
         public Map<String, String> getAttributes();
         
 }

1		package org.kuali.rice.krms.api.repository.rule;
2
3		import java.util.List;
4		import java.util.Map;
5		import java.util.Set;
6
7		import org.kuali.rice.core.api.mo.common.Identifiable;
8		import org.kuali.rice.core.api.mo.common.Versioned;
9		import org.kuali.rice.krms.api.repository.action.ActionDefinitionContract;
10		import org.kuali.rice.krms.api.repository.proposition.PropositionDefinitionContract;
11
12		public interface RuleDefinitionContract extends Identifiable, Versioned {
13		/**
14		* This is the name of the Rule
15		* <p>
16		* name - the name of the Rule
17		* </p>
18		* @return the name of the Rule
19		*/
20		public String getName();
21
22		/**
23		* This is the description of the Rule
24		* <p>
25		* description - the description of the Rule
26		* </p>
27		* @return the description of the Rule
28		*/
29		public String getDescription();
30
31		/**
32		* This is the namespace of the Rule
33		* <p>
34		* The namespace of the Rule
35		* </p>
36		* @return the namespace of the Rule
37		*/
38		public String getNamespace();
39
40		/**
41		* This is the KrmsType of the Rule
42		*
43		* @return id for KRMS type related of the Rule
44		*/
45		public String getTypeId();
46
47		/**
48		* This method returns the ID of the Proposition associated with the rule.
49		* <p>
50		* Each Rule has exactly one Proposition associated with it.
51		* <p>
52		* @return the id of the Proposition associated with the Rule
53		*/
54		public String getPropId();
55
56		/**
57		* This method returns the Proposition associated with the rule.
58		* <p>
59		* Each Rule has exactly one Proposition associated with it.
60		* <p>
61		* @return an immutable represtentation of the Proposition associated with the Rule
62		*/
63		public PropositionDefinitionContract getProposition();
64
65		/**
66		* This method returns a list of Actions associated with the Rule.
67		* <p>
68		* A Rule may have zero or more Actions associated with it.
69		* <p>
70		* @return An ordered list of Actions associated with a Rule.
71		*/
72		public List<? extends ActionDefinitionContract> getActions();
73
74		/**
75		* This method returns a Map of attributes associated with the
76		* Rule. The attributes are represented as name/value pairs.
77		*
78		* @return a Map<String,String> of RuleAttribute objects.
79		*/
80		public Map<String, String> getAttributes();
81
82		}