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