| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| RegistrationGroup |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2010 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the Educational Community License, Version 2.0 (the | |
| 5 | * "License"); you may not use this file except in compliance with the | |
| 6 | * License. You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.osedu.org/licenses/ECL-2.0 | |
| 9 | * | |
| 10 | * Unless required by applicable law or agreed to in writing, software | |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 13 | * implied. See the License for the specific language governing | |
| 14 | * permissions and limitations under the License. | |
| 15 | */ | |
| 16 | ||
| 17 | package org.kuali.student.enrollment.courseoffering.infc; | |
| 18 | ||
| 19 | import java.util.List; | |
| 20 | ||
| 21 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 22 | import org.kuali.student.r2.common.infc.TimeAmount; | |
| 23 | ||
| 24 | /** | |
| 25 | * Registration group are the physical entities that students will try | |
| 26 | * to register into. A RegistrationGroup is used to group individual | |
| 27 | * activity offerings based on the canonical format. | |
| 28 | * | |
| 29 | * @author Kamal | |
| 30 | */ | |
| 31 | ||
| 32 | public interface RegistrationGroup | |
| 33 | extends IdEntity { | |
| 34 | ||
| 35 | /** | |
| 36 | * Course offering for this registration group. | |
| 37 | * | |
| 38 | * @name CourseOffering Id | |
| 39 | * @required | |
| 40 | * @readOnly | |
| 41 | * @impl Maps to the lui Id of the courseOffering retrieved from | |
| 42 | * luiluirelation of type courseoffering to registration | |
| 43 | * group. | |
| 44 | */ | |
| 45 | public String getCourseOfferingId(); | |
| 46 | ||
| 47 | /** | |
| 48 | * Academic term the registration group is being offered | |
| 49 | * in. Should be same as CourseOffering unless changed, then must | |
| 50 | * be nested term of courseOffering. | |
| 51 | * | |
| 52 | * @name Term id | |
| 53 | * @required | |
| 54 | * @impl maps to Lui.getAtpId() | |
| 55 | */ | |
| 56 | public String getTermId(); | |
| 57 | ||
| 58 | /** | |
| 59 | * Activity Offerings for the registration group. This list should | |
| 60 | * be constrained by the canonical format and the activity | |
| 61 | * offerings listed in the course offering. | |
| 62 | * | |
| 63 | * @name ActivityOffering Ids | |
| 64 | * @required | |
| 65 | * @impl Maps to the lui Ids of the activityOffering retrieved | |
| 66 | * from luiluirelation of type activityOffering to | |
| 67 | * registration group. | |
| 68 | */ | |
| 69 | public List<String> getActivityOfferingIds(); | |
| 70 | ||
| 71 | /** | |
| 72 | * Canonical format to which this registration group belong to. | |
| 73 | * | |
| 74 | * @name Format Id | |
| 75 | * @impl This maps the the version dependent id of the format | |
| 76 | * clu. Stored as cluId in Lui. | |
| 77 | */ | |
| 78 | public String getFormatOfferingId(); | |
| 79 | ||
| 80 | /** | |
| 81 | * Uniquely identifies an instance of the course for the purposes | |
| 82 | * of registration. | |
| 83 | * | |
| 84 | * @name Registration Code | |
| 85 | * @impl maps to lui code in Lui | |
| 86 | */ | |
| 87 | public String getRegistrationCode(); | |
| 88 | ||
| 89 | /** | |
| 90 | * Indicates that the entire course offering is an Honors Course. | |
| 91 | * | |
| 92 | * @name Is Honors Offering | |
| 93 | * @required | |
| 94 | */ | |
| 95 | public Boolean getIsHonorsOffering(); | |
| 96 | ||
| 97 | /** | |
| 98 | * Total maximum number of "seats" or enrollment slots that can be | |
| 99 | * filled for the offering. Constrained by smallest activity | |
| 100 | * enrollment. | |
| 101 | * | |
| 102 | * @name Maximum Enrollment | |
| 103 | * @impl maps to Lui.maximumEnrollment | |
| 104 | */ | |
| 105 | public Integer getMaximumEnrollment(); | |
| 106 | ||
| 107 | /** | |
| 108 | * Total minimum number of seats that must be filled for the | |
| 109 | * offering not to be canceled. Constrained by smallest activity | |
| 110 | * enrollment. | |
| 111 | * | |
| 112 | * @name Minimum Enrollment | |
| 113 | * @impl maps to Lui.minimumEnrollment | |
| 114 | */ | |
| 115 | public Integer getMinimumEnrollment(); | |
| 116 | ||
| 117 | /** | |
| 118 | * Indicates whether a RegistrationGroup has a waitlist. | |
| 119 | * | |
| 120 | * @name Has Waitlist | |
| 121 | * @required | |
| 122 | * @impl maps to Lui.hasWaitlist | |
| 123 | */ | |
| 124 | public Boolean getHasWaitlist(); | |
| 125 | ||
| 126 | /** | |
| 127 | * Indicates the type of waitlist as it relates to processing | |
| 128 | * students on and off. | |
| 129 | * | |
| 130 | * @name Waitlist Type | |
| 131 | * @impl maps to Lui.waitlistTypeKey | |
| 132 | */ | |
| 133 | public String getWaitlistTypeKey(); | |
| 134 | ||
| 135 | /** | |
| 136 | * Maximum number of students to be allowed on the wait list. | |
| 137 | * | |
| 138 | * @name Waitlist Maximum | |
| 139 | * @impl maps to Lui.waitlistMaximum | |
| 140 | */ | |
| 141 | public Integer getWaitlistMaximum(); | |
| 142 | ||
| 143 | /** | |
| 144 | * Indicates if the waitlist requires checkin. | |
| 145 | * | |
| 146 | * @name Is Waitlist Checkin Required | |
| 147 | * @required | |
| 148 | * @impl maps to Lui.isWaitlistCheckinRequired | |
| 149 | */ | |
| 150 | public Boolean getIsWaitlistCheckinRequired(); | |
| 151 | ||
| 152 | /** | |
| 153 | * Frequency for the waitlist checkin. | |
| 154 | * | |
| 155 | * @name Waitlist Checkin Frequency | |
| 156 | * @impl maps to Lui.waitlistCheckinFrequency | |
| 157 | */ | |
| 158 | public TimeAmount getWaitlistCheckinFrequency(); | |
| 159 | } |