| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| CourseWaitlistEntry |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2010 The Kuali Foundation Licensed under the Educational Community | |
| 3 | * License, Version 2.0 (the "License"); you may not use this file except in | |
| 4 | * compliance with the License. You may obtain a copy of the License at | |
| 5 | * http://www.osedu.org/licenses/ECL-2.0 Unless required by applicable law or | |
| 6 | * agreed to in writing, software distributed under the License is distributed | |
| 7 | * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | |
| 8 | * express or implied. See the License for the specific language governing | |
| 9 | * permissions and limitations under the License. | |
| 10 | */ | |
| 11 | ||
| 12 | package org.kuali.student.enrollment.coursewaitlist.infc; | |
| 13 | ||
| 14 | import java.util.Date; | |
| 15 | ||
| 16 | import org.kuali.student.r2.common.infc.Relationship; | |
| 17 | ||
| 18 | /** | |
| 19 | * Represents a single student in the course waitlist. Contains information such | |
| 20 | * as student id, the waitlist option (reg group id and clearing strategy) and | |
| 21 | * the student's position in the waitlist. As more seats become available the | |
| 22 | * students in the waitlist are moved to the course. | |
| 23 | * <P> | |
| 24 | * Implementation Notes: | |
| 25 | * It is represented by an LPR at Class I level, when a student actually | |
| 26 | * registers for the course the LPR is a RegGroupRegistration | |
| 27 | * | |
| 28 | * @Author sambit | |
| 29 | * @Since Tue May 10 14:22:34 EDT 2011 | |
| 30 | */ | |
| 31 | ||
| 32 | public interface CourseWaitlistEntry extends Relationship { | |
| 33 | ||
| 34 | /** | |
| 35 | * Returns the student id in waitlist entry waitlisted. | |
| 36 | * @readOnly on updates | |
| 37 | */ | |
| 38 | public String getStudentId(); | |
| 39 | ||
| 40 | /** | |
| 41 | * Returns the position of this entry in the waitlist for a particular | |
| 42 | * waitlist option. | |
| 43 | * | |
| 44 | * This is not directly updatable on the data object, use service operations | |
| 45 | * to change the student's position in the list | |
| 46 | * | |
| 47 | * @readOnly | |
| 48 | */ | |
| 49 | public Integer getPosition(); | |
| 50 | ||
| 51 | /** | |
| 52 | * Returns true if the student has checked in to the waitlist. Used to track | |
| 53 | * if the student is still interested in being in the wailist. | |
| 54 | * | |
| 55 | */ | |
| 56 | public Date getLastCheckedIn(); | |
| 57 | ||
| 58 | /** | |
| 59 | * Returns the reg group id for this waitlist entry. A waitlist entry should | |
| 60 | * always be on tied to a single reg group. | |
| 61 | * | |
| 62 | */ | |
| 63 | public String getRegGroupId(); | |
| 64 | ||
| 65 | /** | |
| 66 | * | |
| 67 | * Course offering id that contains the | |
| 68 | * | |
| 69 | * @readOnly on updates | |
| 70 | */ | |
| 71 | public String getCourseOfferingId(); | |
| 72 | } |