| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ScheduleRequestItem |
|
| 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.HasId; | |
| 19 | ||
| 20 | import java.util.List; | |
| 21 | ||
| 22 | ||
| 23 | /** | |
| 24 | * Information about a Schedule Request Item. | |
| 25 | * | |
| 26 | * @author tom | |
| 27 | * @since Thu Nov 3 14:22:34 EDT 2011 | |
| 28 | */ | |
| 29 | ||
| 30 | public interface ScheduleRequestItem extends HasId { | |
| 31 | ||
| 32 | /** | |
| 33 | * The Schedule Request Id. | |
| 34 | * | |
| 35 | * @name Schedule Request Id | |
| 36 | * @required | |
| 37 | * @readonly | |
| 38 | */ | |
| 39 | public String getScheduleRequestId(); | |
| 40 | ||
| 41 | /** | |
| 42 | * A reference Id for relating the request to an external object | |
| 43 | * to be scheduled. | |
| 44 | * | |
| 45 | * @name Reference Id | |
| 46 | * @required | |
| 47 | */ | |
| 48 | public String getReferenceId(); | |
| 49 | ||
| 50 | /** | |
| 51 | * A reference Type key for relating the request to an external | |
| 52 | * object to be scheduled. | |
| 53 | * | |
| 54 | * @name Reference Type Key | |
| 55 | * @required | |
| 56 | */ | |
| 57 | public String getReferenceTypeKey(); | |
| 58 | ||
| 59 | /** | |
| 60 | * Tests if the data in this request item are requirements or | |
| 61 | * preferences. A requirement fails scheduling if not available. | |
| 62 | * | |
| 63 | * @name Is Requirement | |
| 64 | */ | |
| 65 | public Boolean getIsRequirement(); | |
| 66 | ||
| 67 | /** | |
| 68 | * The Campus Id to specify a Campus. | |
| 69 | * | |
| 70 | * @name Campus Ids | |
| 71 | */ | |
| 72 | public List<String> getCampusIds(); | |
| 73 | ||
| 74 | /** | |
| 75 | * The Building Id to specify a Building. | |
| 76 | * | |
| 77 | * @name Building Ids | |
| 78 | */ | |
| 79 | public List<String> getBuildingIds(); | |
| 80 | ||
| 81 | /** | |
| 82 | * The Room Id to specify a Room. | |
| 83 | * | |
| 84 | * @name Room Ids | |
| 85 | */ | |
| 86 | public List<String> getRoomIds(); | |
| 87 | ||
| 88 | /** | |
| 89 | * The Org Id to specify a Room or Building "owned" by an | |
| 90 | * Organization. | |
| 91 | * | |
| 92 | * @name Org Ids | |
| 93 | */ | |
| 94 | public List<String> getOrgIds(); | |
| 95 | ||
| 96 | /** | |
| 97 | * The Resource Types to specify a Room with types of fixed | |
| 98 | * Resources. | |
| 99 | * | |
| 100 | * @name Resource Type Keys | |
| 101 | */ | |
| 102 | public List<String> getResourceTypeKeys(); | |
| 103 | ||
| 104 | /** | |
| 105 | * The Time Slot Ids to specify a time slot. | |
| 106 | * | |
| 107 | * @name Time Slot Ids | |
| 108 | */ | |
| 109 | public List<String> getTimeSlotIds(); | |
| 110 | } |