1 /**
2 * Copyright 2004-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.kpme.core.api.calendar;
17
18 import java.sql.Time;
19 import java.util.List;
20
21 import org.kuali.kpme.core.api.calendar.entry.CalendarEntryContract;
22 import org.kuali.rice.krad.bo.PersistableBusinessObject;
23
24 /**
25 * <p>CalendarContract interface</p>
26 *
27 */
28 public interface CalendarContract extends PersistableBusinessObject {
29
30 /**
31 * The primary Key of a Calendar entry saved in a database
32 *
33 * <p>
34 * hrCalendarId of a Calendar
35 * <p>
36 *
37 * @return hrCalendarId for a Calendar
38 */
39 public String getHrCalendarId();
40
41 /**
42 * The text field used to define the calendar entry for pay or leave reporting periods
43 *
44 * <p>
45 * calendarName of a Calendar
46 * </p>
47 *
48 * @return calendarName of Calendar
49 */
50 public String getCalendarName();
51
52 /**
53 * The Text field used to indicate calendar is to be used for pay or leave reporting periods
54 *
55 * <p>
56 * calendarTypes of a Calendar
57 * </p>
58 *
59 * @return calendarTypes of Calendar
60 */
61 public String getCalendarTypes();
62
63 /**
64 * The list of CalendarEntry object the Calendar is associated with
65 *
66 * <p>
67 * calendarEntries of a Calendar
68 * </p>
69 *
70 * @return calendarEntries of Calendar
71 */
72 public List<? extends CalendarEntryContract> getCalendarEntries();
73
74 /**
75 * The Text field used to describe the calendar
76 *
77 * <p>
78 * calendarDescriptions of a Calendar
79 * </p>
80 *
81 * @return calendarDescriptions of Calendar
82 */
83 public String getCalendarDescriptions();
84
85 /**
86 * The value that determines the FLSA period for overtime calculations
87 *
88 * <p>
89 * flsaBeginDay of a Calendar
90 * </p>
91 *
92 * @return flsaBeginDay for Calendar
93 */
94 public String getFlsaBeginDay();
95
96 /**
97 * The time of day when FLSA period begins
98 *
99 * <p>
100 * flsaBeginTime of a Calendar
101 * </p>
102 *
103 * @return flsaBeginTime for Calendar
104 */
105 public Time getFlsaBeginTime();
106
107 /**
108 * The FLSA start day the Calendar is associated with
109 *
110 * <p>
111 * org.joda.time.DateTimeConstants.MONDAY
112 * ...
113 * org.joda.time.DateTimeConstants.SUNDAY
114 * </p>
115 *
116 * @return an int representing the FLSA start day, sourced from org.joda.time.DateTimeConstants in the interval [1,7]
117 */
118 public int getFlsaBeginDayConstant();
119
120 }