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.core.api.leaveplan;
17
18 import java.sql.Time;
19
20 import org.kuali.kpme.core.api.bo.HrBusinessObjectContract;
21
22 /**
23 * <p>LeavePlanContract interface.</p>
24 *
25 */
26 public interface LeavePlanContract extends HrBusinessObjectContract {
27
28 /**
29 * The date batch job should run to create a carry over leave block
30 * for each accrual category balance from the prior year under a LeavePlan
31 *
32 * <p>
33 * batchPriorYearCarryOverStartDate of a LeavePlan
34 * <p>
35 *
36 * @return batchPriorYearCarryOverStartDate for LeavePlan
37 */
38 public String getBatchPriorYearCarryOverStartDate();
39
40 /**
41 * The Time batch job should run to create a carry over leave block
42 * for each accrual category balance from the prior year under a LeavePlan
43 *
44 * <p>
45 * batchPriorYearCarryOverStartTime of a LeavePlan
46 * <p>
47 *
48 * @return batchPriorYearCarryOverStartTime for LeavePlan
49 */
50 public Time getBatchPriorYearCarryOverStartTime();
51
52 /**
53 * The Number of months to build accruals for for a LeavePlan
54 *
55 * <p>
56 * planningMonths of a LeavePlan
57 * <p>
58 *
59 * @return planningMonths for LeavePlan
60 */
61 public String getPlanningMonths();
62
63 /**
64 * The Primary Key of a LeavePlan entry saved in a database
65 *
66 * <p>
67 * lmLeavePlanId of an LeavePlan
68 * <p>
69 *
70 * @return lmLeavePlanId for LeavePlan
71 */
72 public String getLmLeavePlanId();
73
74 /**
75 * The name of a LeavePlan
76 *
77 * <p>
78 * leavePlan field of a LeavePlan
79 * <p>
80 *
81 * @return leavePlan for LeavePlan
82 */
83 public String getLeavePlan();
84
85 /**
86 * The description of a LeavePlan
87 *
88 * <p>
89 * description of a LeavePlan
90 * <p>
91 *
92 * @return description for LeavePlan
93 */
94 public String getDescr();
95
96 /**
97 * The Month and Day (MM/DD) of the start of the year for a LeavePlan
98 *
99 * <p>
100 * calendarYearStart of a LeavePlan
101 * <p>
102 *
103 * @return calendarYearStart for LeavePlan
104 */
105 public String getCalendarYearStart() ;
106
107 /**
108 * The history flag of a LeavePlan
109 *
110 * <p>
111 * history flag of a LeavePlan
112 * <p>
113 *
114 * @return Y if on, N if not
115 */
116 public Boolean getHistory();
117 }