| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Atp |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2010 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.atp.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 19 | ||
| 20 | import java.util.Date; | |
| 21 | ||
| 22 | ||
| 23 | /** | |
| 24 | * Information about an Academic Time Period. | |
| 25 | * | |
| 26 | * @Author tom | |
| 27 | * @Since Tue Apr 05 14:22:34 EDT 2011 | |
| 28 | */ | |
| 29 | ||
| 30 | public interface Atp | |
| 31 | extends IdEntity { | |
| 32 | ||
| 33 | /** | |
| 34 | * Gets a display code for this ATP. | |
| 35 | * | |
| 36 | * @name Code | |
| 37 | */ | |
| 38 | public String getCode(); | |
| 39 | ||
| 40 | /** | |
| 41 | * Date and time the academic time period became effective. This | |
| 42 | * does not provide a bound on date ranges or milestones | |
| 43 | * associated with this time period, but instead indicates the | |
| 44 | * time period proper. This is a similar concept to the effective | |
| 45 | * date on enumerated values. When an expiration date has been | |
| 46 | * specified, this field must be less than or equal to the | |
| 47 | * expiration date. | |
| 48 | * | |
| 49 | * @name Start Date | |
| 50 | * @required | |
| 51 | */ | |
| 52 | public Date getStartDate(); | |
| 53 | ||
| 54 | /** | |
| 55 | * Date and time the academic time period expires. This does not | |
| 56 | * provide a bound on date ranges or milestones associated with | |
| 57 | * this time period, but instead indicates the time period | |
| 58 | * proper. If specified, this must be greater than or equal to the | |
| 59 | * effective date. If this field is not specified, then no | |
| 60 | * expiration date has been currently defined and should | |
| 61 | * automatically be considered greater than the effective date. | |
| 62 | * | |
| 63 | * @name End Date | |
| 64 | * @required | |
| 65 | */ | |
| 66 | public Date getEndDate(); | |
| 67 | ||
| 68 | /** | |
| 69 | * The adminsitrative organization responsible for maintaining | |
| 70 | * this time period. | |
| 71 | * | |
| 72 | * @name AdminOrg Id | |
| 73 | */ | |
| 74 | public String getAdminOrgId(); | |
| 75 | } |