| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| RegistrationDateGroup |
|
| 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 | 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 registratiob derivation date group | |
| 52 | */ | |
| 53 | public RegistrationDateDerivationGroup getRegistrationDateDerivationGroup(); | |
| 54 | ||
| 55 | /** | |
| 56 | * Name: Term Key | |
| 57 | * Gets the key identifying the term for this date group. | |
| 58 | * | |
| 59 | * @return the term key | |
| 60 | */ | |
| 61 | public String getTermKey(); | |
| 62 | ||
| 63 | /** | |
| 64 | * Name: Registration Date Range | |
| 65 | * Gets the registration period. | |
| 66 | * | |
| 67 | * @return the registration period | |
| 68 | */ | |
| 69 | public DateRange getRegistrationDateRange(); | |
| 70 | ||
| 71 | /** | |
| 72 | * Name: Class Date Range | |
| 73 | * Gets the instructional class period. | |
| 74 | * | |
| 75 | * @return the class period | |
| 76 | */ | |
| 77 | public DateRange getClassDateRange(); | |
| 78 | ||
| 79 | /** | |
| 80 | * Name: Add Date | |
| 81 | * Last Date to Add a Course | |
| 82 | * | |
| 83 | * @return add date | |
| 84 | */ | |
| 85 | public Date getAddDate(); | |
| 86 | ||
| 87 | /** | |
| 88 | * Name: Drop Date | |
| 89 | * Last date to drop a course | |
| 90 | * | |
| 91 | * @return drop date | |
| 92 | */ | |
| 93 | public Date getDropDate(); | |
| 94 | ||
| 95 | /** | |
| 96 | * Name: Final Exam Date Range | |
| 97 | * Gets the he Final Exam Period. | |
| 98 | * | |
| 99 | * @return the final exam period | |
| 100 | */ | |
| 101 | public DateRange getFinalExamDateRange(); | |
| 102 | ||
| 103 | /** | |
| 104 | * Name: Grading Date Range | |
| 105 | * Gets the grading period. | |
| 106 | * | |
| 107 | * @return the grading period | |
| 108 | */ | |
| 109 | public DateRange getGradingDateRange(); | |
| 110 | } |