1 /**
2 * Copyright 2004-2014 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.tklm.api.time.calendar;
17
18 import java.util.List;
19
20 import org.kuali.kpme.core.api.calendar.web.CalendarDayContract;
21 import org.kuali.kpme.tklm.api.leave.block.LeaveBlockContract;
22 import org.kuali.kpme.tklm.api.leave.block.LeaveBlockRendererContract;
23 import org.kuali.kpme.tklm.api.time.timeblock.TimeBlockContract;
24 import org.kuali.kpme.tklm.api.time.timeblock.web.TimeBlockRendererContract;
25
26 /**
27 * <p>TkCalendarWeekContract interface</p>
28 *
29 */
30 public interface TkCalendarDayContract extends CalendarDayContract {
31
32 /**
33 * The list of TimeBlock objects associated with the TkCalendarDay
34 *
35 * <p>
36 * timeblocks of a TkCalendarDay
37 * </p>
38 *
39 * @return timeblocks for TkCalendarDay
40 */
41 public List<? extends TimeBlockContract> getTimeblocks();
42
43 /**
44 * The list of TimeBlockRenderer objects associated with the TkCalendarDay
45 *
46 * <p>
47 * blockRenderers of a TkCalendarDay
48 * </p>
49 *
50 * @return blockRenderers for TkCalendarDay
51 */
52 public List<? extends TimeBlockRendererContract> getBlockRenderers();
53
54 /**
55 * The dayNumberString associated with the TkCalendarDay
56 *
57 * <p>
58 * dayNumberString of a TkCalendarDay
59 * </p>
60 *
61 * @return dayNumberString for TkCalendarDay
62 */
63 public String getDayNumberString();
64
65 /**
66 * TODO: Make sure this comment is right
67 * The gray flag to indicate if a calendar day is greyed out or not
68 *
69 * <p>
70 * gray of a TkCalendarDay
71 * </p>
72 *
73 * @return Y if a calendar day is greyed out, N if not
74 */
75 public Boolean getGray();
76
77 /**
78 * The list of LeaveBlock objects associated with the TkCalendarDay
79 *
80 * <p>
81 * leaveBlocks of a TkCalendarDay
82 * </p>
83 *
84 * @return leaveBlocks for TkCalendarDay
85 */
86 public List<? extends LeaveBlockContract> getLeaveBlocks();
87
88 /**
89 * The list of LeaveBlockRenderer objects associated with the TkCalendarDay
90 *
91 * <p>
92 * leaveBlockRenderers of a TkCalendarDay
93 * </p>
94 *
95 * @return leaveBlockRenderers for TkCalendarDay
96 */
97 public List<? extends LeaveBlockRendererContract> getLeaveBlockRenderers();
98
99 }