1 Package hr_pay_scale_value_api as
2 /* $Header: pypsrapi.pkh 120.1 2005/10/02 02:33:23 aroussel $ */
3 /*#
4 * This package contains APIs that will maintain rate values for pay scale
5 * points.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Scale Rate Value
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_pay_scale_value >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a rate value for a defined point on a pay scale.
18 *
19 * You can assign a rate (such as an amount for overtime) to an employee based
20 * on their pay scale point. You can define a rate as a specific value or a
21 * range of values.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A valid pay scale and point must exist as of the start date of the pay scale
28 * rate value.
29 *
30 * <p><b>Post Success</b><br>
31 * A pay scale rate value will be created.
32 *
33 * <p><b>Post Failure</b><br>
34 * A pay scale rate value will not be created and an error will be raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Determines when the DateTrack operation comes into
39 * force
40 * @param p_rate_id If p_validate is false, uniquely identifies the pay scale
41 * rate value created. If p_validate is true, set to null.
42 * @param p_currency_code For pay rates that have the unit of 'MONEY', this
43 * parameter must be set to a value from the column
44 * FND_CURRENCIES.CURRENCY_CODE.
45 * @param p_spinal_point_id The pay scale point for which the rate value is
46 * created.
47 * @param p_value The actual rate value that applies to this pay scale point.
48 * @param p_grade_rule_id If p_validate is false, uniquely identifies the pay
49 * scale rate value created. If p_validate is true, set to null.
50 * @param p_object_version_number If p_validate is false, then set to the
51 * version number of the created pay scale rate value. If p_validate is true,
52 * then the value will be null.
53 * @param p_effective_start_date If p_validate is false, then set to the
54 * earliest effective start date for the created pay scale rate value. If
55 * p_validate is true, then set to null.
56 * @param p_effective_end_date If p_validate is false, then set to the
57 * effective end date for the created pay scale rate value. If p_validate is
58 * true, then set to null.
59 * @rep:displayname Create Pay Scale Rate Value
60 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
61 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
62 * @rep:scope public
63 * @rep:lifecycle active
64 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
65 */
66 --
67 -- {End Of Comments}
68 --
69 procedure create_pay_scale_value
70 (p_validate in boolean default false
71 ,p_effective_date in date
72 ,p_rate_id in number
73 ,p_currency_code in varchar2
74 ,p_spinal_point_id in number
75 ,p_value in varchar2 default null
76 ,p_grade_rule_id out nocopy number
77 ,p_object_version_number out nocopy number
78 ,p_effective_start_date out nocopy date
79 ,p_effective_end_date out nocopy date
80 );
81 --
82 -- ----------------------------------------------------------------------------
83 -- |--------------------------< update_pay_scale_value >----------------------|
84 -- ----------------------------------------------------------------------------
85 --
86 -- {Start Of Comments}
87 /*#
88 * This API updates a rate value for a defined point on a pay scale.
89 *
90 * You can assign a rate (such as an amount for overtime) to an employee based
91 * on their pay scale point. You can define a rate as a specific value or a
92 * range of values.
93 *
94 * <p><b>Licensing</b><br>
95 * This API is licensed for use with Human Resources.
96 *
97 * <p><b>Prerequisites</b><br>
98 * The pay scale rate value must exist on the effective date of the update.
99 *
100 * <p><b>Post Success</b><br>
101 * The pay scale rate value will be updated.
102 *
103 * <p><b>Post Failure</b><br>
104 * The pay scale rate value will not be updated and an error will be raised.
105 * @param p_validate If true, then validation alone will be performed and the
106 * database will remain unchanged. If false and all validation checks pass,
107 * then the database will be modified.
108 * @param p_effective_date Determines when the DateTrack operation comes into
109 * force
110 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
111 * updating the record. You must set to either UPDATE, CORRECTION,
112 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
113 * particular record depend on the dates of previous record changes and the
114 * effective date of this change.
115 * @param p_grade_rule_id Uniquely identifies the pay scale rate value to be
116 * updated.
117 * @param p_object_version_number Pass in the current version number of the pay
118 * scale rate value to be updated. When the API completes if p_validate is
119 * false, will be set to the new version number of the updated pay scale rate
120 * value. If p_validate is true will be set to the same value which was passed
121 * in.
122 * @param p_currency_code For pay rates that have the unit of 'MONEY', this
123 * parameter must be set to a value from the column
124 * FND_CURRENCIES.CURRENCY_CODE.
125 * @param p_maximum Cannot be set for pay scale rate values. Do not pass in.
126 * @param p_mid_value Cannot be set for pay scale rate values. Do not pass in.
127 * @param p_minimum Cannot be set for pay scale rate values. Do not pass in.
128 * @param p_value The actual rate value that applies to this pay scale point.
129 * @param p_effective_start_date If p_validate is false, then set to the
130 * effective start date on the updated pay scale rate value row which now
131 * exists as of the effective date. If p_validate is true, then set to null.
132 * @param p_effective_end_date If p_validate is false, then set to the
133 * effective end date on the updated pay scale rate value row which now exists
134 * as of the effective date. If p_validate is true, then set to null.
135 * @rep:displayname Update Pay Scale Rate Value
136 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
137 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
138 * @rep:scope public
139 * @rep:lifecycle active
140 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
141 */
142 --
143 -- {End Of Comments}
144 --
145 procedure update_pay_scale_value
146 (p_validate in boolean default false
147 ,p_effective_date in date
148 ,p_datetrack_update_mode in varchar2
149 ,p_grade_rule_id in number
150 ,p_object_version_number in out nocopy number
151 ,p_currency_code in varchar2
152 ,p_maximum in varchar2 default null
153 ,p_mid_value in varchar2 default null
154 ,p_minimum in varchar2 default null
155 ,p_value in varchar2 default null
156 ,p_effective_start_date out nocopy date
157 ,p_effective_end_date out nocopy date
158 );
159 --
160 -- ----------------------------------------------------------------------------
161 -- |--------------------------< delete_pay_scale_value >----------------------|
162 -- ----------------------------------------------------------------------------
163 --
164 -- {Start Of Comments}
165 /*#
166 * This API deletes a rate value for a defined point on a pay scale.
167 *
168 * You can assign a rate (such as an amount for overtime) to an employee based
169 * on their pay scale point. You can define a rate as a specific value or a
170 * range of values.
171 *
172 * <p><b>Licensing</b><br>
173 * This API is licensed for use with Human Resources.
174 *
175 * <p><b>Prerequisites</b><br>
176 * The pay scale rate value must exist on the effective date of the delete.
177 *
178 * <p><b>Post Success</b><br>
179 * The pay scale rate value will be deleted.
180 *
181 * <p><b>Post Failure</b><br>
182 * The pay scale rate value will not be deleted and an error will be raised.
183 * @param p_validate If true, then validation alone will be performed and the
184 * database will remain unchanged. If false and all validation checks pass,
185 * then the database will be modified.
186 * @param p_effective_date Determines when the DateTrack operation comes into
187 * force
188 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
189 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
190 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
191 * on the dates of previous record changes and the effective date of this
192 * change.
193 * @param p_grade_rule_id Uniquely identifies the pay scale rate value to be
194 * deleted.
195 * @param p_object_version_number Current version number of the pay scale rate
196 * value to be deleted.
197 * @param p_effective_start_date If p_validate is false, then set to the
198 * effective start date for the deleted pay scale rate value row which now
199 * exists as of the effective date. If p_validate is true or all row instances
200 * have been deleted then set to null.
201 * @param p_effective_end_date If p_validate is false, then set to the
202 * effective end date for the deleted pay scale rate value row which now exists
203 * as of the effective date. If p_validate is true or all row instances have
204 * been deleted then set to null.
205 * @rep:displayname Delete Pay Scale Rate Value
206 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
207 * @rep:scope public
208 * @rep:lifecycle active
209 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
210 */
211 --
212 -- {End Of Comments}
213 --
214 procedure delete_pay_scale_value
215 (p_validate in boolean default false
216 ,p_effective_date in date
217 ,p_datetrack_delete_mode in varchar2
218 ,p_grade_rule_id in number
219 ,p_object_version_number in out nocopy number
220 ,p_effective_start_date out nocopy date
221 ,p_effective_end_date out nocopy date
222 );
223 end hr_pay_scale_value_api;
[Home] [Help]