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.salarygroup;
17
18 import java.math.BigDecimal;
19 import java.util.Set;
20
21 import org.kuali.kpme.core.api.mo.EffectiveKeyContract;
22 import org.kuali.kpme.core.api.mo.KpmeEffectiveKeyedSetDataTransferObject;
23 import org.kuali.kpme.core.api.util.HrApiConstants;
24
25 /**
26 * <p>SalaryGroupContract interface.</p>
27 *
28 */
29 public interface SalaryGroupContract extends KpmeEffectiveKeyedSetDataTransferObject {
30
31 public static final String CACHE_NAME = HrApiConstants.CacheNamespace.NAMESPACE_PREFIX + "SalaryGroup";
32
33 /**
34 * The set of EffectiveKeyContract objects that hold the aggregate "white-list" of groupkeys
35 * for this PostionReportGroupContract object.
36 *
37 */
38 @Override
39 public Set<? extends EffectiveKeyContract> getEffectiveKeySet();
40
41 /**
42 * The Primary Key of a SalaryGroup entry saved in a database
43 *
44 * <p>
45 * hrSalGroupId of a SalaryGroup
46 * <p>
47 *
48 * @return hrSalGroupId for SalaryGroup
49 */
50 public String getHrSalGroupId();
51
52 /**
53 * Text field used to identify the salary group
54 *
55 * <p>
56 * hrSalGroup of a SalaryGroup
57 * <p>
58 *
59 * @return hrSalGroup for SalaryGroup
60 */
61 public String getHrSalGroup();
62
63 /**
64 * Description of the salary group
65 *
66 * <p>
67 * descr of a SalaryGroup
68 * <p>
69 *
70 * @return descr for SalaryGroup
71 */
72 public String getDescr();
73
74 /**
75 * The name of the institution the salary group is associated with.
76 *
77 * <p>
78 * institution of a SalaryGroup
79 * <p>
80 *
81 * @return institution for SalaryGroup
82 */
83 public String getInstitution();
84
85 /**
86 * Maximum percentage of time worked for the SalaryGroup. When defining individual positions and jobs,
87 * the percent time will be less than the Salary Group's Percent Time. Percentage will be entered.
88 * Uses: leave accrual, payroll calculations, FTE reporting, etc...
89 * i.e. 40 hours per week is 100% percent time, 20 hours per week is 50% percent time
90 *
91 * <p>
92 * percentTime of a SalaryGroup
93 * <p>
94 *
95 * @return percentTime for SalaryGroup
96 */
97 public BigDecimal getPercentTime();
98
99 /**
100 * Flag indicating if the SalaryGroup is eligible for benefits
101 *
102 * <p>
103 * benefitsEligible of a SalaryGroup
104 * <p>
105 *
106 * @return Y if eligible for benefits, N if not
107 */
108 public String getBenefitsEligible();
109
110 /**
111 * Flag indicating if the SalaryGroup is eligible for leave benefits
112 *
113 * <p>
114 * leaveEligible of a SalaryGroup
115 * <p>
116 *
117 * @return Y if eligible for leave benefits, N if not
118 */
119 public String getLeaveEligible();
120
121 /**
122 * The name of the LeavePlan the salary group is associated with.
123 *
124 * <p>
125 * leavePlan of a SalaryGroup
126 * <p>
127 *
128 * @return leavePlan for SalaryGroup
129 */
130 public String getLeavePlan();
131
132 /**
133 * The name of the Location the salary group is associated with.
134 *
135 * <p>
136 * location of a SalaryGroup
137 * <p>
138 *
139 * @return location for SalaryGroup
140 */
141 public String getLocation();
142 }
143
144