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.enrollment.acal.infc;
17
18 import java.util.Date;
19
20 import org.kuali.student.r2.common.infc.IdEntity;
21
22
23 /**
24 * Information about a milestone for an AcademicCalendar.
25 *
26 * @author tom
27 * @since Tue Apr 05 14:22:34 EDT 2011
28 */
29
30 public interface AcalEvent
31 extends IdEntity {
32
33 /**
34 * Tests if this key date is an all day event. An all-day event
35 * does not have a meaningful time component in the date.
36 *
37 * @name Is All Day
38 * @required
39 */
40 public Boolean getIsAllDay();
41
42 /**
43 * Tests if this key date has a date range.
44 *
45 * @return true if the end date is different than the start
46 * date, false if the start end end date are the same
47 * @name Is Date Range
48 * @required
49 */
50 public Boolean getIsDateRange();
51
52 /**
53 * The start date and time of the key date.
54 *
55 * @name Start Date
56 */
57 public Date getStartDate();
58
59 /**
60 * The end date and time of the key date. The end
61 * date must be equal to or greater that the start.
62 *
63 * @name End Date
64 */
65 public Date getEndDate();
66 }