| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Schedule |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2011 The Kuali Foundation Licensed under the Educational | |
| 3 | * Community License, Version 2.0 (the "License"); you may not use | |
| 4 | * this file except in compliance with the License. You may obtain a | |
| 5 | * 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, software | |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 12 | * 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.scheduling.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.DateRange; | |
| 19 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 20 | import org.kuali.student.r2.core.scheduling.dto.ScheduleComponentInfo; | |
| 21 | ||
| 22 | import java.util.List; | |
| 23 | ||
| 24 | ||
| 25 | /** | |
| 26 | * Information about a Schedule. | |
| 27 | * | |
| 28 | * @author tom | |
| 29 | * @since Thu Nov 3 14:22:34 EDT 2011 | |
| 30 | */ | |
| 31 | ||
| 32 | public interface Schedule extends IdEntity { | |
| 33 | ||
| 34 | /** | |
| 35 | * The ATP Id. Schedule Components are applied to this ATP. | |
| 36 | * | |
| 37 | * @name Atp Id | |
| 38 | * @required | |
| 39 | */ | |
| 40 | public String getAtpId(); | |
| 41 | ||
| 42 | /** | |
| 43 | * The Schedule Components. These provide a list of Time Slots | |
| 44 | * coupled with Room locations. | |
| 45 | * | |
| 46 | * @name Schedule Components | |
| 47 | */ | |
| 48 | public List<ScheduleComponentInfo> getScheduleComponents(); | |
| 49 | ||
| 50 | /** | |
| 51 | * A list of blackout dates where a meeting time implied by the | |
| 52 | * ScheduleComponent is skipped. | |
| 53 | * | |
| 54 | * @name Blackout Dates | |
| 55 | * @deprecated Should this point to a shared set (not really | |
| 56 | * deprecated, but ignorable for now. | |
| 57 | */ | |
| 58 | public List<? extends DateRange> getBlackoutDates(); | |
| 59 | ||
| 60 | /** | |
| 61 | * A list of Milestone Ids where a meeting time that occurs | |
| 62 | * within a Milestone is considered a blackout date. Milestones of | |
| 63 | * any of the Milestone Types that exist in the related ATP are | |
| 64 | * used to determine the blackout dates. | |
| 65 | * | |
| 66 | * @name Blackout Milestone Ids | |
| 67 | * @deprecated Should this point to a shared set (think about the common case of lectures usually having the same non-instructional days)? | |
| 68 | */ | |
| 69 | public List<String> getBlackoutMilestoneIds(); | |
| 70 | ||
| 71 | /** | |
| 72 | * A list of one-time MeetingTimes to add to this Schedule. | |
| 73 | * | |
| 74 | * @name Meeting Times | |
| 75 | */ | |
| 76 | public List<? extends MeetingTime> getAdditionalMeetingTimes(); | |
| 77 | } |