Coverage Report

Coverage Report - org.kuali.student.enrollment.acal.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.enrollment.acal.infc;
 
 import java.util.Date;
 
 import org.kuali.student.r2.common.infc.DateRange;
 
 
 /**
  * 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 value is 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: Registration Date Derivation Group
      * Gets the date derivation structure for the Registration
      * dats.
      *
      * @return the registration derivation date group
      */
     public RegistrationDateDerivationGroup getRegistrationDateDerivationGroup();
 
 
     /**
      * Name: Term Key
      * Gets the key identifying the term for this date group.
      *
      * @return the term key
      * @readOnly on updates
      */
     public String getTermKey();
 
     /**
      * Name: Registration Date Range
      * Gets the registration period.
      *
      * @return the registration period
      */
     public DateRange getRegistrationDateRange();
 
     /**
      * Name: Class Date Range
      * Gets the instructional class period.
      *
      * @return the class period
      */
     public DateRange getClassDateRange();
 
     /**
      * 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 Date Range
      * Gets the he Final Exam Period.
      *
      * @return the final exam period
      */
     public DateRange getFinalExamDateRange();
 
     /**
      * Name: Grading Date Range
      * Gets the grading period.
      *
      * @return the grading period
      */
     public DateRange getGradingDateRange();
 }

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		import java.util.Date;
19
20		import org.kuali.student.r2.common.infc.DateRange;
21
22
23		/**
24		* A cluster of hardened dates pertinent to an academic term.
25		*
26		* A Date Group is a short cut to accessing a set of KeyDates dates
27		* relating to a Term. An RegistrationDateGroup is available for all
28		* Terms by default and does not explicitly need to be created.
29		*
30		* The dates in this group map to KeyDates. If a KeyDate does not
31		* exist, then the return value is null. An update of this structure
32		* will update the corresponding KeyDate if it exists, or create one
33		* of the appropriate Type if it does not exist.
34		*
35		* The KeyDate Type is used to link a specific KeyDate with one of the
36		* elements in this structure. For example, getRegistrationStartDate()
37		* returns the starting date of the range in a KeyDate of type
38		* kuali.apt.milestone.RegistrationPeriod for the associated term.
39		*
40		* @author tom
41		* @since Tue Apr 05 14:22:34 EDT 2011
42		*/
43
44		public interface RegistrationDateGroup {
45
46		/**
47		* Name: Registration Date Derivation Group
48		* Gets the date derivation structure for the Registration
49		* dats.
50		*
51		* @return the registration derivation date group
52		*/
53		public RegistrationDateDerivationGroup getRegistrationDateDerivationGroup();
54
55
56		/**
57		* Name: Term Key
58		* Gets the key identifying the term for this date group.
59		*
60		* @return the term key
61		* @readOnly on updates
62		*/
63		public String getTermKey();
64
65		/**
66		* Name: Registration Date Range
67		* Gets the registration period.
68		*
69		* @return the registration period
70		*/
71		public DateRange getRegistrationDateRange();
72
73		/**
74		* Name: Class Date Range
75		* Gets the instructional class period.
76		*
77		* @return the class period
78		*/
79		public DateRange getClassDateRange();
80
81		/**
82		* Name: Add Date
83		* Last Date to Add a Course
84		*
85		* @return add date
86		*/
87		public Date getAddDate();
88
89		/**
90		* Name: Drop Date
91		* Last date to drop a course
92		*
93		* @return drop date
94		*/
95		public Date getDropDate();
96
97		/**
98		* Name: Final Exam Date Range
99		* Gets the he Final Exam Period.
100		*
101		* @return the final exam period
102		*/
103		public DateRange getFinalExamDateRange();
104
105		/**
106		* Name: Grading Date Range
107		* Gets the grading period.
108		*
109		* @return the grading period
110		*/
111		public DateRange getGradingDateRange();
112		}