Coverage Report

Coverage Report - org.kuali.student.enrollment.courseofferingset.infc.SocRolloverResult

Classes in this File

 /*
  * Copyright 2010 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.osedu.org/licenses/ECL-2.0
  *
  * 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.student.enrollment.courseofferingset.infc;
 
 import java.util.List;
 import org.kuali.student.r2.common.infc.IdNamelessEntity;
 import org.kuali.student.r2.common.infc.RichText;
 
 /**
  * Read only object that holds the results of a rollover process
  * 
  * @author nwright
  */
 public interface SocRolloverResult
         extends IdNamelessEntity {
 
     /**
      * The id of the source soc
      * 
      * @name Source Soc Id
      * @readOnly
      * @required
      * @impl set during the #rolloverSoc operation
      */
     public String getSourceSocId();
 
       /**
      * Academic target term of the courses that were rolled over
      * 
      * @name Target Term Id
      * @readOnly
      * @required
      * @impl set during the #rolloverSoc operation
      */
     public String getTargetTermId();
 
     /**
      * Option Keys specified to control the rollover process
      *     
      * @name Option Keys
      * @readOnly
      * @required
      * @impl set during the #rolloverSoc operation
      */
     public List<String> getOptionKeys();
 
     /**
      * The id of the target Soc
      * 
      * Note: this Soc could have already existed or it may have been created 
      * based on the source soc but for the new term.
      * 
      * @name Target Soc Id
      * @readOnly
      * @required
      * @impl set during the #rolloverSoc operation
      */
     public String getTargetSocId();
 
   
     /**
      * Number of items processed
      *     
      * @name Items Processed
      * @impl set during the #rolloverSoc operation
      */
     public Integer getItemsProcessed();
 
     /**
      * Number of items expected to be processed
      *     
      * @name Items Expected
      * @impl set during the #rolloverSoc operation
      */
     public Integer getItemsExpected();
 
     /**
      * Messages describing details of the status.
      * 
      * Often left null if the status is that it is complete.
      * 
      * @name Message
      * @impl set during the #rolloverSoc operation
      */
     public RichText getMessage();
 
     /**
      * Number of items created 
      *     
      * @name Items Expected
      * @readOnly 
      * @impl calculation based on items with status of success
      */
     public Integer getItemsCreated();
 
     /**
      * Number of items skipped (not rolled over)
      *     
      * @name Items Expected
      * @readOnly 
      * @impl calculation based on items with status of success
      */
     public Integer getItemsSkipped();
     
     /**
      * Get the target term Id
      *     
      * @name Source Term Id
      * @readOnly 
      * @impl calculation based on the source SOC
      */
     public String getSourceTermId();
 }

1		/*
2		* Copyright 2010 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the
5		* "License"); you may not use this file except in compliance with the
6		* License. You may obtain a copy of the License at
7		*
8		* http://www.osedu.org/licenses/ECL-2.0
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
13		* implied. See the License for the specific language governing
14		* permissions and limitations under the License.
15		*/
16		package org.kuali.student.enrollment.courseofferingset.infc;
17
18		import java.util.List;
19		import org.kuali.student.r2.common.infc.IdNamelessEntity;
20		import org.kuali.student.r2.common.infc.RichText;
21
22		/**
23		* Read only object that holds the results of a rollover process
24		*
25		* @author nwright
26		*/
27		public interface SocRolloverResult
28		extends IdNamelessEntity {
29
30		/**
31		* The id of the source soc
32		*
33		* @name Source Soc Id
34		* @readOnly
35		* @required
36		* @impl set during the #rolloverSoc operation
37		*/
38		public String getSourceSocId();
39
40		/**
41		* Academic target term of the courses that were rolled over
42		*
43		* @name Target Term Id
44		* @readOnly
45		* @required
46		* @impl set during the #rolloverSoc operation
47		*/
48		public String getTargetTermId();
49
50		/**
51		* Option Keys specified to control the rollover process
52		*
53		* @name Option Keys
54		* @readOnly
55		* @required
56		* @impl set during the #rolloverSoc operation
57		*/
58		public List<String> getOptionKeys();
59
60		/**
61		* The id of the target Soc
62		*
63		* Note: this Soc could have already existed or it may have been created
64		* based on the source soc but for the new term.
65		*
66		* @name Target Soc Id
67		* @readOnly
68		* @required
69		* @impl set during the #rolloverSoc operation
70		*/
71		public String getTargetSocId();
72
73
74		/**
75		* Number of items processed
76		*
77		* @name Items Processed
78		* @impl set during the #rolloverSoc operation
79		*/
80		public Integer getItemsProcessed();
81
82		/**
83		* Number of items expected to be processed
84		*
85		* @name Items Expected
86		* @impl set during the #rolloverSoc operation
87		*/
88		public Integer getItemsExpected();
89
90		/**
91		* Messages describing details of the status.
92		*
93		* Often left null if the status is that it is complete.
94		*
95		* @name Message
96		* @impl set during the #rolloverSoc operation
97		*/
98		public RichText getMessage();
99
100		/**
101		* Number of items created
102		*
103		* @name Items Expected
104		* @readOnly
105		* @impl calculation based on items with status of success
106		*/
107		public Integer getItemsCreated();
108
109		/**
110		* Number of items skipped (not rolled over)
111		*
112		* @name Items Expected
113		* @readOnly
114		* @impl calculation based on items with status of success
115		*/
116		public Integer getItemsSkipped();
117
118		/**
119		* Get the target term Id
120		*
121		* @name Source Term Id
122		* @readOnly
123		* @impl calculation based on the source SOC
124		*/
125		public String getSourceTermId();
126		}