Coverage Report

Coverage Report - org.kuali.student.core.academiccalendar.infc.RegistrationDateGroup

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.core.academiccalendar.infc;
 
 import java.util.Date;
 
 
 /**
  * A cluster of hardened dates pertinent to an academic term.
  *
  * A Date Group is a short cut to accessing a set of KeyDates dates
  * relating to a Term. An RegistrationDateGroup is available for all
  * Terms by default and does not explicitly need to be created.
  *
  * The dates in this group map to KeyDates. If a KeyDate does not
  * exist, then the return valueis null. An update of this structure
  * will update the corresponding KeyDate if it exists, or create one
  * of the appropriate Type if it does not exist.
  *
  * The KeyDate Type is used to link a specific KeyDate with one of the
  * elements in this structure. For example, getRegistrationStartDate()
  * returns the starting date of the range in a KeyDate of type
  * kuali.apt.milestone.RegistrationPeriod for the associated term.
  *
  * @Author tom
  * @Since Tue Apr 05 14:22:34 EDT 2011
  */ 
 
 public interface RegistrationDateGroup {
 
     /**
      * Name: Term Key
      *
      * The key identifying the term for this date group.
      *
      * @return the term key
      */
     public String getTermKey();
 
     /**
      * Name: Registration Start Date
      *
      * The beginning of the registration period
      *
      * @return the registration start date
      */
     public Date getRegistrationStartDate();
 
     /**
      * Name: Registration End Date
      * Gets the registration end date.
      *
      * @return the registration end date
      */
     public Date getRegistrationEndDate();
 
     /**
      * Name: Classes Start Date
      * Gets the class start date.
      *
      * @return the class start date
      */
     public Date getClassStartDate();
 
     /**
      * Name: Class End
      *
      * End of Classes
      *
      * @return the class end date
      */
     public Date getClassEndDate();
 
     /**
      * Name: Add Date
      *
      * Last Date to Add a Course
      *
      * @return add date
      */
     public Date getAddDate();
 
     /**
      * Name: Drop Date
      *
      * Last date to drop a course
      *
      * @return drop date
      */
     public Date getDropDate();
 
     /**
      * Name: Final Exam Start Date
      *
      * Beginning of the Final Exam Period
      *
      * @return the final exam start date
      */
     public Date getFinalExamStartDate();
 
     /**
      * Name: Final Exam End
      *
      * The end of the final exam period
      *
      * @return the final exam end date
      */
     public Date getFinalExamEndDate();
 
     /**
      * Name: Grading Start Date
      *
      * Beginnig of Grading period.
      *
      * @return the grading start date
      */
     public Date getGradingStartDate();
 
     /**
      * Name: Grading End Date
      *
      * Last day to submit grades without them being considered late.
      *
      * @return the grading end date
      */
     public Date getGradingEndDate();
 }

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.core.academiccalendar.infc;
17
18		import java.util.Date;
19
20
21		/**
22		* A cluster of hardened dates pertinent to an academic term.
23		*
24		* A Date Group is a short cut to accessing a set of KeyDates dates
25		* relating to a Term. An RegistrationDateGroup is available for all
26		* Terms by default and does not explicitly need to be created.
27		*
28		* The dates in this group map to KeyDates. If a KeyDate does not
29		* exist, then the return valueis null. An update of this structure
30		* will update the corresponding KeyDate if it exists, or create one
31		* of the appropriate Type if it does not exist.
32		*
33		* The KeyDate Type is used to link a specific KeyDate with one of the
34		* elements in this structure. For example, getRegistrationStartDate()
35		* returns the starting date of the range in a KeyDate of type
36		* kuali.apt.milestone.RegistrationPeriod for the associated term.
37		*
38		* @Author tom
39		* @Since Tue Apr 05 14:22:34 EDT 2011
40		*/
41
42		public interface RegistrationDateGroup {
43
44		/**
45		* Name: Term Key
46		*
47		* The key identifying the term for this date group.
48		*
49		* @return the term key
50		*/
51		public String getTermKey();
52
53		/**
54		* Name: Registration Start Date
55		*
56		* The beginning of the registration period
57		*
58		* @return the registration start date
59		*/
60		public Date getRegistrationStartDate();
61
62		/**
63		* Name: Registration End Date
64		* Gets the registration end date.
65		*
66		* @return the registration end date
67		*/
68		public Date getRegistrationEndDate();
69
70		/**
71		* Name: Classes Start Date
72		* Gets the class start date.
73		*
74		* @return the class start date
75		*/
76		public Date getClassStartDate();
77
78		/**
79		* Name: Class End
80		*
81		* End of Classes
82		*
83		* @return the class end date
84		*/
85		public Date getClassEndDate();
86
87		/**
88		* Name: Add Date
89		*
90		* Last Date to Add a Course
91		*
92		* @return add date
93		*/
94		public Date getAddDate();
95
96		/**
97		* Name: Drop Date
98		*
99		* Last date to drop a course
100		*
101		* @return drop date
102		*/
103		public Date getDropDate();
104
105		/**
106		* Name: Final Exam Start Date
107		*
108		* Beginning of the Final Exam Period
109		*
110		* @return the final exam start date
111		*/
112		public Date getFinalExamStartDate();
113
114		/**
115		* Name: Final Exam End
116		*
117		* The end of the final exam period
118		*
119		* @return the final exam end date
120		*/
121		public Date getFinalExamEndDate();
122
123		/**
124		* Name: Grading Start Date
125		*
126		* Beginnig of Grading period.
127		*
128		* @return the grading start date
129		*/
130		public Date getGradingStartDate();
131
132		/**
133		* Name: Grading End Date
134		*
135		* Last day to submit grades without them being considered late.
136		*
137		* @return the grading end date
138		*/
139		public Date getGradingEndDate();
140		}