1 /**
2 * Copyright 2004-2013 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.paystep;
17
18 import java.math.BigDecimal;
19
20 import org.kuali.kpme.core.api.bo.HrBusinessObjectContract;
21
22 /**
23 * <p>PayStepContract interface</p>
24 *
25 */
26 public interface PayStepContract extends HrBusinessObjectContract {
27
28 /**
29 * The text field used to identify the PayStep
30 *
31 * <p>
32 * payStep of a PayStep
33 * </p>
34 *
35 * @return payStep for PayStep
36 */
37 public String getPayStep();
38
39 /**
40 * The institution the PayStep is associated with
41 *
42 * <p>
43 * institution of a PayStep
44 * </p>
45 *
46 * @return institution for PayStep
47 */
48 public String getInstitution();
49
50 /**
51 * The location the PayStep is associated with
52 *
53 * <p>
54 * location of a PayStep
55 * </p>
56 *
57 * @return location for PayStep
58 */
59 public String getLocation();
60
61 /**
62 * The salary group the PayStep is associated with
63 *
64 * <p>
65 * salaryGroup of a PayStep
66 * </p>
67 *
68 * @return salaryGroup for PayStep
69 */
70 public String getSalaryGroup();
71
72 /**
73 * The pay group the PayStep is associated with
74 *
75 * <p>
76 * payGrade of a PayStep
77 * </p>
78 *
79 * @return payGrade for PayStep
80 */
81 public String getPayGrade();
82
83 /**
84 * The order that the steps are applied
85 *
86 * <p>
87 * stepNumber of a PayStep
88 * </p>
89 *
90 * @return stepNumber for PayStep
91 */
92 public int getStepNumber();
93
94 /**
95 * The compensation rate that will be applied to the position's pay rate
96 *
97 * <p>
98 * compRate of a PayStep
99 * </p>
100 *
101 * @return compRate for PayStep
102 */
103 public BigDecimal getCompRate();
104
105 /**
106 * The amount of time from position incumbent's service date to when the step is applied
107 *
108 * <p>
109 * serviceAmount of a PayStep
110 * </p>
111 *
112 * @return serviceAmount for PayStep
113 */
114 public int getServiceAmount();
115
116 /**
117 * The unit of measurement for time to apply the step
118 *
119 * <p>
120 * serviceUnit of a PayStep
121 * </p>
122 *
123 * @return serviceUnit for PayStep
124 */
125 public String getServiceUnit();
126
127 /**
128 * The primary key of a PayStep entry saved in a database
129 *
130 * <p>
131 * pmPayStepId of a PayStep
132 * <p>
133 *
134 * @return pmPayStepId for PayStep
135 */
136 public String getPmPayStepId();
137
138 }