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.timehourdetail;
17
18
19
20 /**
21 * <p>TimeHourDetailRendererContract interface</p>
22 *
23 */
24 public interface TimeHourDetailRendererContract {
25
26 /**
27 * The TimeHourDetail object associated with the TimeHourDetailRenderer
28 *
29 * <p>
30 * timeHourDetail of a TimeHourDetailRenderer
31 * <p>
32 *
33 * @return timeHourDetail for TimeHourDetailRenderer
34 */
35 public TimeHourDetailContract getTimeHourDetail();
36
37 /**
38 * The id of the TimeHourDetail object associated with the TimeHourDetailRenderer
39 *
40 * <p>
41 * timeHourDetail.getTkTimeHourDetailId() of a TimeHourDetailRenderer
42 * <p>
43 *
44 * @return timeHourDetail.getTkTimeHourDetailId() for TimeHourDetailRenderer
45 */
46 public String getTkTimeHourDetailId();
47
48 /**
49 * The EarnCode name of the TimeHourDetail object associated with the TimeHourDetailRenderer
50 *
51 * <p>
52 * timeHourDetail.getEarnCode() of a TimeHourDetailRenderer
53 * <p>
54 *
55 * @return timeHourDetail.getEarnCode() for TimeHourDetailRenderer
56 */
57 public String getTitle();
58
59 /**
60 * The hours of the TimeHourDetail object associated with the TimeHourDetailRenderer
61 *
62 * <p>
63 * timeHourDetail.getHours().toString() of a TimeHourDetailRenderer
64 * <p>
65 *
66 * @return timeHourDetail.getHours().toString() for TimeHourDetailRenderer
67 */
68 public String getHours();
69
70 /**
71 * The amount of the TimeHourDetail object associated with the TimeHourDetailRenderer
72 *
73 * <p>
74 * timeHourDetail.getAmount().toString() of a TimeHourDetailRenderer
75 * <p>
76 *
77 * @return timeHourDetail.getAmount().toString() for TimeHourDetailRenderer
78 */
79 public String getAmount();
80
81 /**
82 * The holiday description associated with the TimeHourDetailRenderer
83 *
84 * <p>
85 * holiday description of a TimeHourDetailRenderer
86 * <p>
87 *
88 * @return holiday description for TimeHourDetailRenderer
89 */
90 public String getHolidayName();
91
92 /**
93 * TODO: Put a better comment
94 * The overtimeEarnCode flag associated with the TimeHourDetailRenderer
95 *
96 * <p>
97 * overtimeEarnCode flag of a TimeHourDetailRenderer
98 * <p>
99 *
100 * @return overtimeEarnCode flag for TimeHourDetailRenderer
101 */
102 public boolean isOvertimeEarnCode();
103
104 }