Coverage Report

Coverage Report - org.kuali.student.enrollment.acal.infc.RegistrationDateDerivationGroup

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.acal.infc;
 
 
 /**
  * This structure specifies how (and if) the dates in the
  * RegistrationDateGroup are derived.
  *
  * This is a Work in Progress as it currently is only intended to
  * handle the derivation of dates of nested terms that start or end on
  * the same exact boundary days as the containing term.
  *
  * For example: the start date of classes for the Fall term is the
  * same for courses that run the entire term as it is for courses that
  * run for only the first half of the term.  This tells us that the
  * derivation of that classes start date in the half-sememster should
  * be the same as the classes start date in the overall semester.
  * 
  * @author tom
  * @since Tue Apr 23 14:22:34 EDT 2011
  */ 
 
 public interface RegistrationDateDerivationGroup {
 
     /**
      * Gets the key of the Term from which the start of the
      * registration period is derived. If null, then the registration
      * start date needs to be explicitly set.
      *
      * @return a term key
      * @name Registration Start Date Term Key
      * @readOnly on update
      */
     public String getRegistrationStartDateTermKey();
 
     /**
      * Gets the key of the Term from which the end of the registration
      * period is derived. If null, then the registration end date
      * needs to be explicitly set.
      *
      * @return a term key
      * @name Registration End Date Term Key
      */
     public String getRegistrationEndDateTermKey();
 
     /**
      * Gets the key of the Term from which the start of the class
      * period is derived. If null, then the class start date needs to
      * be explicitly set.
      *
      * @return a term key
      * @name Class Start Date Term Key
      */
     public String getClassStartDateTermKey();
 
 
     /**
      * Gets the key of the Term from which the end of the class period
      * is derived. If null, then the class end date needs to be
      * explicitly set.
      *
      * @return a term key
      * @name Class End Date Term Key
      */
     public String getClassEndDateTermKey();
     
     /**
      * Gets the key of the Term from which the add date is derived. If
      * null, then the add date needs to be explicitly set.
      *
      * @return a term key
      * @name Add Date Term Key
      */
     public String getAddDateTermKey();
  
 
     /**
      * Name: Drop Date Term Key
      * Gets the key of the Term from which the drop date is derived. If
      * null, then the drop date needs to be explicitly set.
      *
      * @return a term key
      */
     public String getDropDateTermKey();
  
     /**
      * Name: Final Exam Start Date Term Key
      * Gets the key of the Term from which the start of the final exam
      * period is derived. If null, then the class start date needs to
      * be explicitly set.
      *
      * @return a term key
      */
     public String getFinalExamStartDateTermKey();
  
     /**
      * Gets the key of the Term from which the end of the final exam
      * period is derived. If null, then the class end date needs to be
      * explicitly set.
      *
      * @return a term key
      * @name Final Exam End Date Term Key
      */
     public String getFinalExamEndDateTermKey();
  
     /** 
      * Gets the key of the Term from which the start of the grading
      * period is derived. If null, then the class start date needs to
      * be explicitly set.
      *
      * @return a term key
      * @name Grading Start Date Term Key
      */
     public String getGradingStartDateTermKey();
  
     /**
      * Gets the key of the Term from which the end of the grading
      * period is derived. If null, then the class end date needs to be
      * explicitly set.
      *
      * @return a term key
      * @name Grading End Date Term Key
      */
     public String getGradingEndDateTermKey();
  
 }

1		/**
2		* Copyright 2010 The Kuali Foundation Licensed under the
3		* Educational Community License, Version 2.0 (the "License"); you may
4		* not use this file except in compliance with the License. You may
5		* obtain a copy of the License at
6		*
7		* http://www.osedu.org/licenses/ECL-2.0
8		*
9		* Unless required by applicable law or agreed to in writing,
10		* software distributed under the License is distributed on an "AS IS"
11		* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12		* or implied. See the License for the specific language governing
13		* permissions and limitations under the License.
14		*/
15
16		package org.kuali.student.enrollment.acal.infc;
17
18
19		/**
20		* This structure specifies how (and if) the dates in the
21		* RegistrationDateGroup are derived.
22		*
23		* This is a Work in Progress as it currently is only intended to
24		* handle the derivation of dates of nested terms that start or end on
25		* the same exact boundary days as the containing term.
26		*
27		* For example: the start date of classes for the Fall term is the
28		* same for courses that run the entire term as it is for courses that
29		* run for only the first half of the term. This tells us that the
30		* derivation of that classes start date in the half-sememster should
31		* be the same as the classes start date in the overall semester.
32		*
33		* @author tom
34		* @since Tue Apr 23 14:22:34 EDT 2011
35		*/
36
37		public interface RegistrationDateDerivationGroup {
38
39		/**
40		* Gets the key of the Term from which the start of the
41		* registration period is derived. If null, then the registration
42		* start date needs to be explicitly set.
43		*
44		* @return a term key
45		* @name Registration Start Date Term Key
46		* @readOnly on update
47		*/
48		public String getRegistrationStartDateTermKey();
49
50		/**
51		* Gets the key of the Term from which the end of the registration
52		* period is derived. If null, then the registration end date
53		* needs to be explicitly set.
54		*
55		* @return a term key
56		* @name Registration End Date Term Key
57		*/
58		public String getRegistrationEndDateTermKey();
59
60		/**
61		* Gets the key of the Term from which the start of the class
62		* period is derived. If null, then the class start date needs to
63		* be explicitly set.
64		*
65		* @return a term key
66		* @name Class Start Date Term Key
67		*/
68		public String getClassStartDateTermKey();
69
70
71		/**
72		* Gets the key of the Term from which the end of the class period
73		* is derived. If null, then the class end date needs to be
74		* explicitly set.
75		*
76		* @return a term key
77		* @name Class End Date Term Key
78		*/
79		public String getClassEndDateTermKey();
80
81		/**
82		* Gets the key of the Term from which the add date is derived. If
83		* null, then the add date needs to be explicitly set.
84		*
85		* @return a term key
86		* @name Add Date Term Key
87		*/
88		public String getAddDateTermKey();
89
90
91		/**
92		* Name: Drop Date Term Key
93		* Gets the key of the Term from which the drop date is derived. If
94		* null, then the drop date needs to be explicitly set.
95		*
96		* @return a term key
97		*/
98		public String getDropDateTermKey();
99
100		/**
101		* Name: Final Exam Start Date Term Key
102		* Gets the key of the Term from which the start of the final exam
103		* period is derived. If null, then the class start date needs to
104		* be explicitly set.
105		*
106		* @return a term key
107		*/
108		public String getFinalExamStartDateTermKey();
109
110		/**
111		* Gets the key of the Term from which the end of the final exam
112		* period is derived. If null, then the class end date needs to be
113		* explicitly set.
114		*
115		* @return a term key
116		* @name Final Exam End Date Term Key
117		*/
118		public String getFinalExamEndDateTermKey();
119
120		/**
121		* Gets the key of the Term from which the start of the grading
122		* period is derived. If null, then the class start date needs to
123		* be explicitly set.
124		*
125		* @return a term key
126		* @name Grading Start Date Term Key
127		*/
128		public String getGradingStartDateTermKey();
129
130		/**
131		* Gets the key of the Term from which the end of the grading
132		* period is derived. If null, then the class end date needs to be
133		* explicitly set.
134		*
135		* @return a term key
136		* @name Grading End Date Term Key
137		*/
138		public String getGradingEndDateTermKey();
139
140		}