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.leave.override;
17
18 import org.kuali.kpme.core.api.accrualcategory.AccrualCategoryContract;
19 import org.kuali.kpme.core.api.bo.HrBusinessObjectContract;
20 import org.kuali.kpme.core.api.principal.PrincipalHRAttributesContract;
21 import org.kuali.kpme.tklm.api.common.TkConstants;
22 import org.kuali.rice.kim.api.identity.Person;
23
24 /**
25 * <p>EmployeeOverrideContract interface</p>
26 *
27 */
28 public interface EmployeeOverrideContract extends HrBusinessObjectContract {
29 public static final String CACHE_NAME = TkConstants.Namespace.NAMESPACE_PREFIX + "EmployeeOverride";
30 /**
31 * The primary key of an EmployeeOverride entry saved in a database
32 *
33 * <p>
34 * lmEmployeeOverrideId of an EmployeeOverride
35 * <p>
36 *
37 * @return lmEmployeeOverrideId for EmployeeOverride
38 */
39 public String getLmEmployeeOverrideId();
40
41 /**
42 * The principalID of the employee whom the system overrides the AccrtualCategory limits for
43 *
44 * <p>
45 * principalId of an EmployeeOverride
46 * </p>
47 *
48 * @return principalId for EmployeeOverride
49 */
50 public String getPrincipalId();
51
52 /**
53 * The principalName of the employee whom the system overrides the AccrtualCategory limits for
54 *
55 * <p>
56 * principal.getName() of an EmployeeOverride
57 * <p>
58 *
59 * @return principal.getName() for EmployeeOverride
60 */
61 public String getName();
62
63 /**
64 * The AccuralCategory object associated with the EmployeeOverride
65 *
66 * <p>
67 * accrualCategoryObj of an EmployeeOverride
68 * <p>
69 *
70 * @return accrualCategoryObj for EmployeeOverride
71 */
72 public AccrualCategoryContract getAccrualCategoryObj();
73
74 /**
75 * The AccrualCategory limit used for the Employee
76 *
77 * <p>
78 * overrideType of an EmployeeOverride
79 * </p>
80 *
81 * @return overrideType for EmployeeOverride
82 */
83 public String getOverrideType();
84
85 /**
86 * The descripton of a reason for the EmployeeOverride
87 *
88 * <p>
89 * description of an EmployeeOverride
90 * </p>
91 *
92 * @return description for EmployeeOverride
93 */
94 public String getDescription();
95
96 /**
97 * The AccrualCategory name associated with the EmployeeOverride
98 *
99 * <p>
100 * accrualCategory of an EmployeeOverride
101 * <p>
102 *
103 * @return accrualCategory for EmployeeOverride
104 */
105 public String getAccrualCategory();
106
107 /**
108 * The LeavePlan name associated with the Principal ID and AccrualCategory
109 *
110 * <p>
111 * leavePlan of an EmployeeOverride
112 * <p>
113 *
114 * @return leavePlan for EmployeeOverride
115 */
116 public String getLeavePlan();
117
118 /**
119 * The new limit value to be used for the AccrualCategory
120 *
121 * <p>
122 * overrideValue of an EmployeeOverride
123 * <p>
124 *
125 * @return overrideValue for EmployeeOverride
126 */
127 public Long getOverrideValue();
128
129 /**
130 * The Person object associated with the EmployeeOverride
131 *
132 * <p>
133 * principal of an EmployeeOverride
134 * <p>
135 *
136 * @return principal for EmployeeOverride
137 */
138 public Person getPrincipal();
139
140 /**
141 * The PrincipalHRAttributes object associated with the EmployeeOverride
142 *
143 * <p>
144 * principalHRAttrObj of an EmployeeOverride
145 * <p>
146 *
147 * @return principalHRAttrObj for EmployeeOverride
148 */
149 public PrincipalHRAttributesContract getPrincipalHRAttrObj();
150
151 }