| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ActivityOffering |
|
| 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.Date; | |
| 20 | import java.util.List; | |
| 21 | ||
| 22 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 23 | import org.kuali.student.r2.common.infc.IdNamelessEntity; | |
| 24 | ||
| 25 | /** | |
| 26 | * Individual activity offerings correspond to events in a scheduling | |
| 27 | * system, each with a meeting pattern. | |
| 28 | * | |
| 29 | * @author Kamal | |
| 30 | */ | |
| 31 | public interface ActivityOffering extends IdEntity { | |
| 32 | ||
| 33 | /** | |
| 34 | * Format offering Id used to create this activity | |
| 35 | * | |
| 36 | * @name Format Offering Id | |
| 37 | * @required | |
| 38 | * @readonly | |
| 39 | */ | |
| 40 | public String getFormatOfferingId(); | |
| 41 | ||
| 42 | /** | |
| 43 | * Canonical activity whose instance is this activity offering. | |
| 44 | * | |
| 45 | * @name Activity Id | |
| 46 | * @required | |
| 47 | * @readonly | |
| 48 | */ | |
| 49 | public String getActivityId(); | |
| 50 | ||
| 51 | /** | |
| 52 | * Academic term the activity is being offered in. | |
| 53 | * | |
| 54 | * Same as course offering term or a nested term of course | |
| 55 | * offering. | |
| 56 | * | |
| 57 | * @name Term Id | |
| 58 | * @required | |
| 59 | * @readonly | |
| 60 | * @impl map to Lui.getAtpId | |
| 61 | */ | |
| 62 | public String getTermId(); | |
| 63 | ||
| 64 | /** | |
| 65 | * Alphanumeric character that identifies the section of the | |
| 66 | * course offering. | |
| 67 | * | |
| 68 | * @name Activity Code | |
| 69 | */ | |
| 70 | public String getActivityCode(); | |
| 71 | ||
| 72 | /** | |
| 73 | * Gets the schedule Id for this offering. | |
| 74 | * | |
| 75 | * @name Schedule Id | |
| 76 | * @impl maps to Scheduling service not implemented | |
| 77 | */ | |
| 78 | public String getScheduleId(); | |
| 79 | ||
| 80 | /** | |
| 81 | * Indicates that the course is an Honors Course. | |
| 82 | * | |
| 83 | * @name Is Honors Offering | |
| 84 | * @required | |
| 85 | */ | |
| 86 | public Boolean getIsHonorsOffering(); | |
| 87 | ||
| 88 | /** | |
| 89 | * The options/scales that indicate the allowable grades that can | |
| 90 | * be awarded. If the value is set here then the canonical course | |
| 91 | * must have a grading option set on the canonical activity. | |
| 92 | * | |
| 93 | * @name Grading Option Keys | |
| 94 | * @impl maps to Lui.gradingOptions | |
| 95 | */ | |
| 96 | public List<String> getGradingOptionKeys(); | |
| 97 | ||
| 98 | /** | |
| 99 | * Instructors for the activity. This list should be constrained | |
| 100 | * by the instructors listed on the course offering. | |
| 101 | * | |
| 102 | * @name Instructors | |
| 103 | * @impl maps to Lui.instructors | |
| 104 | */ | |
| 105 | public List<? extends OfferingInstructor> getInstructors(); | |
| 106 | ||
| 107 | /********************** Final Exam Information ******************/ | |
| 108 | /** | |
| 109 | * Start time of final exam | |
| 110 | * @name Final Exam StartTime | |
| 111 | */ | |
| 112 | public Date getFinalExamStartTime(); | |
| 113 | ||
| 114 | /** | |
| 115 | * End time of final exam. | |
| 116 | * @name Final Exam EndTime | |
| 117 | */ | |
| 118 | public Date getFinalExamEndTime(); | |
| 119 | ||
| 120 | /** | |
| 121 | * Space code where final exam will be conducted | |
| 122 | * @name Final Exam Space Code | |
| 123 | */ | |
| 124 | public String getFinalExamSpaceCode(); | |
| 125 | ||
| 126 | /********************* Delivery Logistics **********************/ | |
| 127 | /** | |
| 128 | * When/for how long does the offering meet in class. Calculated | |
| 129 | * by system based on meeting times; may be validated against | |
| 130 | * canonical. The unit is hours. | |
| 131 | * | |
| 132 | * @name Weekly Inclass Contact Hours | |
| 133 | */ | |
| 134 | public String getWeeklyInclassContactHours(); | |
| 135 | ||
| 136 | /** | |
| 137 | * When/for how long does the offering meet out of class. Entered | |
| 138 | * by Scheduler. The unit is hours. | |
| 139 | * | |
| 140 | * @name Weekly Outofclass Contact Hours | |
| 141 | */ | |
| 142 | public String getWeeklyOutofclassContactHours(); | |
| 143 | ||
| 144 | /** | |
| 145 | * When/for how long does the offering meet in total. Calculated | |
| 146 | * by system based as sum of In Class and Out of Class hours. The | |
| 147 | * unit is hours. | |
| 148 | * | |
| 149 | * @name Weekly Total Contac Hours | |
| 150 | */ | |
| 151 | public String getWeeklyTotalContactHours(); | |
| 152 | ||
| 153 | /** | |
| 154 | * Total maximum number of "seats" or enrollment slots that can be | |
| 155 | * filled for the offering. | |
| 156 | * | |
| 157 | * @name Maximum Enrollment | |
| 158 | * @impl maps to Lui.maximumEnrollment | |
| 159 | */ | |
| 160 | public Integer getMaximumEnrollment(); | |
| 161 | ||
| 162 | /** | |
| 163 | * Total minimum number of seats that must be filled for the | |
| 164 | * offering not to be canceled. | |
| 165 | * | |
| 166 | * @name Minimum Enrollment | |
| 167 | * @impl maps to Lui.minimumEnrollment | |
| 168 | */ | |
| 169 | public Integer getMinimumEnrollment(); | |
| 170 | ||
| 171 | /** | |
| 172 | * Is maximum enrollment estimate flag | |
| 173 | * @name Is Maximum Enrollment Estimate Flag | |
| 174 | * | |
| 175 | */ | |
| 176 | public Boolean getIsMaxEnrollmentEstimate(); | |
| 177 | ||
| 178 | /** | |
| 179 | * Is there an instructor evaluation for this activity offering | |
| 180 | * @name Instructor Evaluation Flag | |
| 181 | * | |
| 182 | */ | |
| 183 | public Boolean getIsEvaluated(); | |
| 184 | } |