Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
RegistrationDateDerivationGroup |
|
| 1.0;1 |
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.classII.acal.infc; | |
17 | ||
18 | ||
19 | /** | |
20 | * This structure specifies how (and if) the dates in the RegistrationDateGroup | |
21 | * are derived. | |
22 | * | |
23 | * This is a Work in Progress as it currently is only intended to handle the derivation | |
24 | * of dates of nested terms that start or end on the same exact boundary days as the | |
25 | * containing term. | |
26 | * | |
27 | * For example: the start date of classes for the Fall term is the same for courses | |
28 | * that run the entire term as it is for courses that run for only the first half of the term. | |
29 | * This tells us that the derivation of that classes start date in the half-sememster should be | |
30 | * the same as the classes start date in the overall semester. | |
31 | * | |
32 | * | |
33 | * @Author tom | |
34 | * @Since Tue Apr 23 14:22:34 EDT 2011 | |
35 | */ | |
36 | ||
37 | public interface RegistrationDateDerivationGroup { | |
38 | ||
39 | /** | |
40 | * Name: Registration Start Date Term Key | |
41 | * Gets the key of the Term from which the start of the | |
42 | * registration period is derived. If null, then the registration | |
43 | * start date needs to be explicitly set. | |
44 | * | |
45 | * @return a term key | |
46 | */ | |
47 | public String getRegistrationStartDateTermKey(); | |
48 | ||
49 | /** | |
50 | * Name: Registration End Date Term Key | |
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 | */ | |
57 | public String getRegistrationEndDateTermKey(); | |
58 | ||
59 | /** | |
60 | * Name: Class Start Date Term Key | |
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 | */ | |
67 | public String getClassStartDateTermKey(); | |
68 | ||
69 | /** | |
70 | * Name: Class End Date Term Key | |
71 | * Gets the key of the Term from which the end of the class period | |
72 | * is derived. If null, then the class end date needs to be | |
73 | * explicitly set. | |
74 | * | |
75 | * @return a term key | |
76 | */ | |
77 | public String getClassEndDateTermKey(); | |
78 | ||
79 | /** | |
80 | * Name: Add Date Term Key | |
81 | * Gets the key of the Term from which the add date is derived. If | |
82 | * null, then the add date needs to be explicitly set. | |
83 | * | |
84 | * @return a term key | |
85 | */ | |
86 | public String getAddDateTermKey(); | |
87 | ||
88 | /** | |
89 | * Name: Drop Date Term Key | |
90 | * Gets the key of the Term from which the drop date is derived. If | |
91 | * null, then the drop date needs to be explicitly set. | |
92 | * | |
93 | * @return a term key | |
94 | */ | |
95 | public String getDropDateTermKey(); | |
96 | ||
97 | /** | |
98 | * Name: Final Exam Start Date Term Key | |
99 | * Gets the key of the Term from which the start of the final exam | |
100 | * period is derived. If null, then the class start date needs to | |
101 | * be explicitly set. | |
102 | * | |
103 | * @return a term key | |
104 | */ | |
105 | public String getFinalExamStartDateTermKey(); | |
106 | ||
107 | /** | |
108 | * Name: Final Exam End Date Term Key | |
109 | * Gets the key of the Term from which the end of the final exam | |
110 | * period is derived. If null, then the class end date needs to be | |
111 | * explicitly set. | |
112 | * | |
113 | * @return a term key | |
114 | */ | |
115 | public String getFinalExamEndDateTermKey(); | |
116 | ||
117 | /** | |
118 | * Name: Grading Start Date Term Key | |
119 | * Gets the key of the Term from which the start of the grading | |
120 | * period is derived. If null, then the class start date needs to | |
121 | * be explicitly set. | |
122 | * | |
123 | * @return a term key | |
124 | */ | |
125 | public String getGradingStartDateTermKey(); | |
126 | ||
127 | /** | |
128 | * Name: Grading End Date Term Key | |
129 | * Gets the key of the Term from which the end of the grading | |
130 | * period is derived. If null, then the class end date needs to be | |
131 | * explicitly set. | |
132 | * | |
133 | * @return a term key | |
134 | */ | |
135 | public String getGradingEndDateTermKey(); | |
136 | } |