Coverage Report

Coverage Report - org.kuali.student.enrollment.lpr.infc.LprTransactionItem

Classes in this File

 package org.kuali.student.enrollment.lpr.infc;
 
 import java.util.List;
 
 import org.kuali.student.r2.common.infc.IdEntity;
 
 /**
  * A transaction item represents a request for creating a new relation of a
  * person (student) to a LUI. The transaction item also handle removing,
  * updating, swapping out an old LUI for a new LUI for a person.
  * 
  * @author Kuali Student Team (sambit)
  */
 
 public interface LprTransactionItem extends IdEntity {
 
     /**
      * The type of the transaction item.
      * 
      * The types of LPR transaction item  are things like ADD, UPDATE, DROP,
      * and SWAP
      * 
      * @name Type Key
      */
     @Override
     public String getTypeKey();
 
     /**
      * The state of this transaction item
      * 
      * The states of the LPR transaction item are things like DRAFT, SUBMITTED,
      * and FAILED. etc
      * 
      * @name State Key
      */
     @Override
     public String getStateKey();
 
     /**
      * The person id for whom this request is to generate or update the lpr
      * 
      * @name Person Id
      */
     public String getPersonId();
 
     /**
      * The LUI id for a new relation request.
      * 
      * @name New LUI Id
      */
     public String getNewLuiId();
 
     /**
      * The existing LUI id for an existing relation remove or change requests.
      * 
      * @Existing LUI Id
      */
     public String getExistingLuiId();
 
     /**
      * Specify the various request (or registration ) options for creating this
      * relationship.
      * 
      * @name Request Options
      */
     public List<? extends RequestOption> getRequestOptions();
 
     /**
      * Returns the result for this transaction item once it has been processed.
      * 
      * @name LPR Transaction Item Result
      */
     public LprTransactionItemResult getLprTransactionItemResult();
 
     /**
      * The keys of the result values groups to be applied to the LPR
      * once created.
      * 
      * For example, setting the grading option to pass/fail or the credits to 3
      * for a course.
      * 
      * @name Result Values Group Keys
      */
     public List<String> getResultValuesGroupKeys();
 
     /**
      * A transaction item group id used to link together LPR transaction items of the
      * related LUIs (if any) created as part of a single transaction item.
      * 
      * Note: this field is deprecated
      * It was added at the last minute for core-slice as a way to group together 
      * the resulting LPRs so they can be searched later but this 
      * approach will be refactored out.
      * 
      * @name Group Id
      */
     @Deprecated
     public String getGroupId();
 
 }

1		package org.kuali.student.enrollment.lpr.infc;
2
3		import java.util.List;
4
5		import org.kuali.student.r2.common.infc.IdEntity;
6
7		/**
8		* A transaction item represents a request for creating a new relation of a
9		* person (student) to a LUI. The transaction item also handle removing,
10		* updating, swapping out an old LUI for a new LUI for a person.
11		*
12		* @author Kuali Student Team (sambit)
13		*/
14
15		public interface LprTransactionItem extends IdEntity {
16
17		/**
18		* The type of the transaction item.
19		*
20		* The types of LPR transaction item are things like ADD, UPDATE, DROP,
21		* and SWAP
22		*
23		* @name Type Key
24		*/
25		@Override
26		public String getTypeKey();
27
28		/**
29		* The state of this transaction item
30		*
31		* The states of the LPR transaction item are things like DRAFT, SUBMITTED,
32		* and FAILED. etc
33		*
34		* @name State Key
35		*/
36		@Override
37		public String getStateKey();
38
39		/**
40		* The person id for whom this request is to generate or update the lpr
41		*
42		* @name Person Id
43		*/
44		public String getPersonId();
45
46		/**
47		* The LUI id for a new relation request.
48		*
49		* @name New LUI Id
50		*/
51		public String getNewLuiId();
52
53		/**
54		* The existing LUI id for an existing relation remove or change requests.
55		*
56		* @Existing LUI Id
57		*/
58		public String getExistingLuiId();
59
60		/**
61		* Specify the various request (or registration ) options for creating this
62		* relationship.
63		*
64		* @name Request Options
65		*/
66		public List<? extends RequestOption> getRequestOptions();
67
68		/**
69		* Returns the result for this transaction item once it has been processed.
70		*
71		* @name LPR Transaction Item Result
72		*/
73		public LprTransactionItemResult getLprTransactionItemResult();
74
75		/**
76		* The keys of the result values groups to be applied to the LPR
77		* once created.
78		*
79		* For example, setting the grading option to pass/fail or the credits to 3
80		* for a course.
81		*
82		* @name Result Values Group Keys
83		*/
84		public List<String> getResultValuesGroupKeys();
85
86		/**
87		* A transaction item group id used to link together LPR transaction items of the
88		* related LUIs (if any) created as part of a single transaction item.
89		*
90		* Note: this field is deprecated
91		* It was added at the last minute for core-slice as a way to group together
92		* the resulting LPRs so they can be searched later but this
93		* approach will be refactored out.
94		*
95		* @name Group Id
96		*/
97		@Deprecated
98		public String getGroupId();
99
100		}