| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| AppointmentSlotRule |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2012 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.r2.core.appointment.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.TimeAmount; | |
| 19 | import org.kuali.student.r2.common.infc.TimeOfDay; | |
| 20 | ||
| 21 | import java.util.List; | |
| 22 | ||
| 23 | /** | |
| 24 | * Information about rules used in appointment slot generation | |
| 25 | * | |
| 26 | * @Version 2.0 | |
| 27 | * @Author Sri komandur@uw.edu | |
| 28 | */ | |
| 29 | public interface AppointmentSlotRule { | |
| 30 | /** | |
| 31 | * The weekday codes ("MWF = 2,4,6") | |
| 32 | * | |
| 33 | * @name Weekdays | |
| 34 | * @impl Java standard: Sunday=1 to Saturday=7 | |
| 35 | * @impl When AppointmentSlotRule is specified, this list is expected to have a value. | |
| 36 | */ | |
| 37 | List<Integer> getWeekdays(); | |
| 38 | ||
| 39 | /** | |
| 40 | * Window start time ("9am") | |
| 41 | * | |
| 42 | * @name Start Time Of Day | |
| 43 | * @impl If the slot is open ended, then startTimeOfDay applies only for the first day and it is time portion of the window start date | |
| 44 | */ | |
| 45 | TimeOfDay getStartTimeOfDay(); | |
| 46 | ||
| 47 | /** | |
| 48 | * Window end time ("5pm") | |
| 49 | * | |
| 50 | * @name End Time Of Day | |
| 51 | * @impl If the slot is open ended, then endTimeOfDay applies only for the last day and it is time portion of the window end date | |
| 52 | */ | |
| 53 | TimeOfDay getEndTimeOfDay(); | |
| 54 | ||
| 55 | /** | |
| 56 | * Interval between start times of two consecutive appointment slots ("30 mins") | |
| 57 | * | |
| 58 | * @name Slot Start Interval | |
| 59 | * @impl For the one-slot Appointment Window the slotStartInterval is null | |
| 60 | */ | |
| 61 | TimeAmount getSlotStartInterval(); | |
| 62 | ||
| 63 | /** | |
| 64 | * Duration of the appointment slot ("20 mins") - advertised duration of the slot. The slot duration is not constrained by the window end date/time | |
| 65 | * | |
| 66 | * @name Slot Duration | |
| 67 | * @impl For the one-slot Appointment Window the slotDuration is null | |
| 68 | */ | |
| 69 | TimeAmount getSlotDuration(); | |
| 70 | } |