1 PACKAGE hr_rate_values_api AS
2 /* $Header: pypgrapi.pkh 120.1 2005/10/02 02:32:48 aroussel $ */
3 /*#
4 * This package contains APIs to create and maintain Grade Rate Values and
5 * Grade Scale Rate Values.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Rate Value
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------------< create_rate_value >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates Grade Rate Values and Grade Scale Rate Values.
18 *
19 * To create Assignment Rate Values, use the Create Assignment Rate Value API.
20 * To create Grade Rate Values, use the Create Grade Rate Value API. To create
21 * Pay Rate Values, use the Create Pay Scale Value API. This API is now
22 * out-of-date however it has been provided to you for backward compatibility
23 * support and will be removed in the future. Oracle recommends you to modify
24 * existing calling programs in advance of the support being withdrawn thus
25 * avoiding any
26 *
27 * <p><b>Licensing</b><br>
28 * This API is licensed for use with Human Resources.
29 *
30 * <p><b>Prerequisites</b><br>
31 * The Pay Rate, Grade and Pay Scale must already exist.
32 *
33 * <p><b>Post Success</b><br>
34 * The Rate Value will have been created.
35 *
36 * <p><b>Post Failure</b><br>
37 * The Rate Value will not be created and an error will be raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_effective_date Determines when the DateTrack operation comes into
42 * force.
43 * @param p_business_group_id The business group under which the pay rate will
44 * be created.
45 * @param p_rate_id Uniquely identifies the pay rate to which this rate value
46 * belongs.
47 * @param p_grade_or_spinal_point_id Uniquely identifies the grade (for direct
48 * grade compensation relationships), or uniquely identifies the Pay Scale (for
49 * indirect grade compensation relationships).
50 * @param p_rate_type The type of pay rate value: Grade Rate Value or Grade
51 * Scale Rate Value. Valid values are defined by the 'RATE_TYPE' lookup type.
52 * @param p_currency_code The currency of the rate value.
53 * @param p_maximum The maximum allowable rate value.
54 * @param p_mid_value The mid-range rate value.
55 * @param p_minimum The minimum allowable rate value.
56 * @param p_sequence The sequence of this rate value in relation to other rate
57 * values within the pay rate.
58 * @param p_value The actual rate for this grade or pay scale.
59 * @param p_grade_rule_id If p_validate is false, then this uniquely identifies
60 * the Rate Value. If p_validate is true, then this is set to null.
61 * @param p_object_version_number If p_validate is false, then set to the
62 * version number of the created Rate Value record. If p_validate is true, then
63 * the value will be null.
64 * @param p_effective_start_date If p_validate is false, then set to the
65 * earliest effective start date for the created Rate Value. If p_validate is
66 * true, then set to null.
67 * @param p_effective_end_date If p_validate is false, then set to the
68 * effective end date for the created Rate Value. If p_validate is true, then
69 * set to null.
70 * @rep:displayname Create Rate Value
71 * @rep:category BUSINESS_ENTITY PER_CWK_RATE
72 * @rep:category BUSINESS_ENTITY PER_GRADE
73 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
74 * @rep:scope public
75 * @rep:lifecycle active
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 PROCEDURE create_rate_value
82 (p_validate IN BOOLEAN DEFAULT FALSE
83 ,p_effective_date IN DATE
84 ,p_business_group_id IN NUMBER
85 ,p_rate_id IN NUMBER
86 ,p_grade_or_spinal_point_id IN NUMBER
87 ,p_rate_type IN VARCHAR2
88 ,p_currency_code IN VARCHAR2 DEFAULT NULL
89 ,p_maximum IN VARCHAR2 DEFAULT NULL
90 ,p_mid_value IN VARCHAR2 DEFAULT NULL
91 ,p_minimum IN VARCHAR2 DEFAULT NULL
92 ,p_sequence IN NUMBER DEFAULT NULL
93 ,p_value IN VARCHAR2 DEFAULT NULL
94 ,p_grade_rule_id OUT NOCOPY NUMBER
95 ,p_object_version_number OUT NOCOPY NUMBER
96 ,p_effective_start_date OUT NOCOPY DATE
97 ,p_effective_end_date OUT NOCOPY DATE);
98 --
99 -- ----------------------------------------------------------------------------
100 -- |----------------------------< update_rate_value >-------------------------|
101 -- ----------------------------------------------------------------------------
102 --
103 -- {Start Of Comments}
104 /*#
105 * This API updates Grade Rate Values and Grade Scale Rate Values.
106 *
107 * To update Assignment Rate Values, use the Update Assignment Rate Value API.
108 * To update Grade Rate Values, use the Update Grade Rate Value API. To update
109 * Pay Rate Values, use the Update Pay Scale Value API. This API is now
110 * out-of-date however it has been provided to you for backward compatibility
111 * support and will be removed in the future. Oracle recommends you to modify
112 * existing calling programs in advance of the support being withdrawn thus
113 * avoiding any potential disruption.
114 *
115 * <p><b>Licensing</b><br>
116 * This API is licensed for use with Human Resources.
117 *
118 * <p><b>Prerequisites</b><br>
119 * The Rate Value that is being updated must already exist.
120 *
121 * <p><b>Post Success</b><br>
122 * The Rate Value will have been updated.
123 *
124 * <p><b>Post Failure</b><br>
125 * The Rate Value will not be updated and an error will be raised.
126 * @param p_validate If true, then validation alone will be performed and the
127 * database will remain unchanged. If false and all validation checks pass,
128 * then the database will be modified.
129 * @param p_grade_rule_id Uniquely identifies the Rate Value that is being
130 * updated.
131 * @param p_effective_date Determines when the DateTrack operation comes into
132 * force.
133 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
134 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
135 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
136 * depend on the dates of previous record changes and the effective date of
137 * this change.
138 * @param p_currency_code The currency of the rate value.
139 * @param p_maximum The maximum allowable rate value.
140 * @param p_mid_value The mid-range rate value.
141 * @param p_minimum The minimum allowable rate value.
142 * @param p_sequence The sequence of this rate value in relation to other rate
143 * values within the pay rate.
144 * @param p_value The actual rate for this grade or pay scale.
145 * @param p_object_version_number Pass in the current version number of the
146 * Rate Value to be updated. When the API completes if p_validate is false,
147 * will be set to the new version number of the updated Rate Value. If
148 * p_validate is true will be set to the same value which was passed in.
149 * @param p_effective_start_date If p_validate is false, then set to the
150 * effective start date on the updated Rate Value row which now exists as of
151 * the effective date. If p_validate is true, then set to null.
152 * @param p_effective_end_date If p_validate is false, then set to the
153 * effective end date on the updated Rate Value row which now exists as of the
154 * effective date. If p_validate is true, then set to null.
155 * @rep:displayname Update Rate Value
156 * @rep:category BUSINESS_ENTITY PER_CWK_RATE
157 * @rep:category BUSINESS_ENTITY PER_GRADE
158 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
159 * @rep:scope public
160 * @rep:lifecycle active
161 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
162 */
163 --
164 -- {End Of Comments}
165 --
166 PROCEDURE update_rate_value
167 (p_validate IN BOOLEAN DEFAULT FALSE
168 ,p_grade_rule_id IN NUMBER
169 ,p_effective_date IN DATE
170 ,p_datetrack_mode IN VARCHAR2
171 ,p_currency_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
172 ,p_maximum IN VARCHAR2 DEFAULT hr_api.g_varchar2
173 ,p_mid_value IN VARCHAR2 DEFAULT hr_api.g_varchar2
174 ,p_minimum IN VARCHAR2 DEFAULT hr_api.g_varchar2
175 ,p_sequence IN NUMBER DEFAULT hr_api.g_number
176 ,p_value IN VARCHAR2 DEFAULT hr_api.g_varchar2
177 ,p_object_version_number IN OUT NOCOPY NUMBER
178 ,p_effective_start_date OUT NOCOPY DATE
179 ,p_effective_end_date OUT NOCOPY DATE);
180 --
181 -- ----------------------------------------------------------------------------
182 -- |----------------------------< delete_rate_value >-------------------------|
183 -- ----------------------------------------------------------------------------
184 --
185 -- {Start Of Comments}
186 /*#
187 * This API deletes Grade Rate Values and Grade Scale Rate Values.
188 *
189 * To delete Assignment Rate Values, use the Delete Assignment Rate Value API.
190 * To delete Grade Rate Values, use the Delete Grade Rate Value API. To delete
191 * Pay Rate Values, use the Delete Pay Scale Value API. This API is now
192 * out-of-date however it has been provided to you for backward compatibility
193 * support and will be removed in the future. Oracle recommends you to modify
194 * existing calling programs in advance of the support being withdrawn thus
195 * avoiding any potential disruption.
196 *
197 * <p><b>Licensing</b><br>
198 * This API is licensed for use with Human Resources.
199 *
200 * <p><b>Prerequisites</b><br>
201 * The Rate Value that is being deleted must already exist.
202 *
203 * <p><b>Post Success</b><br>
204 * The Rate Value will have been deleted.
205 *
206 * <p><b>Post Failure</b><br>
207 * The Rate Value will not be deleted and an error will be raised.
208 * @param p_validate If true, then validation alone will be performed and the
209 * database will remain unchanged. If false and all validation checks pass,
210 * then the database will be modified.
211 * @param p_grade_rule_id Uniquely identifies the Rate Value that is being
212 * deleted.
213 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
214 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
215 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
216 * on the dates of previous record changes and the effective date of this
217 * change.
218 * @param p_effective_date Determines when the DateTrack operation comes into
219 * force.
220 * @param p_object_version_number Current version number of the Rate Value to
221 * be deleted.
222 * @param p_effective_start_date If p_validate is false, then set to the
223 * effective start date for the deleted Rate Value row which now exists as of
224 * the effective date. If p_validate is true or all row instances have been
225 * deleted then set to null.
226 * @param p_effective_end_date If p_validate is false, then set to the
227 * effective end date for the deleted Rate Value row which now exists as of the
228 * effective date. If p_validate is true or all row instances have been deleted
229 * then set to null.
230 * @rep:displayname Delete Rate Value
231 * @rep:category BUSINESS_ENTITY PER_CWK_RATE
232 * @rep:category BUSINESS_ENTITY PER_GRADE
233 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
234 * @rep:scope public
235 * @rep:lifecycle active
236 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
237 */
238 --
239 -- {End Of Comments}
240 --
241 PROCEDURE delete_rate_value
242 (p_validate IN BOOLEAN DEFAULT FALSE
243 ,p_grade_rule_id IN NUMBER
244 ,p_datetrack_mode IN VARCHAR2
245 ,p_effective_date IN DATE
246 ,p_object_version_number IN OUT NOCOPY NUMBER
247 ,p_effective_start_date OUT NOCOPY DATE
248 ,p_effective_end_date OUT NOCOPY DATE
249 );
250 --
251 -- ----------------------------------------------------------------------------
252 -- |-----------------------< create_assignment_rate_value >-------------------|
253 -- ----------------------------------------------------------------------------
254 --
255 -- {Start Of Comments}
256 /*#
257 * This API creates Assignment Rate Values.
258 *
259 * Use this API to create Assignment Rate Values, (rates for a particular
260 * contingent worker assignment).
261 *
262 * <p><b>Licensing</b><br>
263 * This API is licensed for use with Human Resources.
264 *
265 * <p><b>Prerequisites</b><br>
266 * The Assignment Rate Type must already exist. The assignment must be
267 * effective and must be a contingent worker assignment.
268 *
269 * <p><b>Post Success</b><br>
270 * The assignment rate value will have been created.
271 *
272 * <p><b>Post Failure</b><br>
273 * The assignment rate value will not be created and an error will be raised.
274 * @param p_validate If true, then validation alone will be performed and the
275 * database will remain unchanged. If false and all validation checks pass,
276 * then the database will be modified.
277 * @param p_effective_date Determines when the DateTrack operation comes into
278 * force.
279 * @param p_business_group_id The business group under which the assignment
280 * rate will be created.
281 * @param p_rate_id Uniquely identifies the assignment rate type to which this
282 * rate value belongs.
283 * @param p_assignment_id Uniquely identifies the assignment for which you
284 * create the Assignment Rate Value record.
285 * @param p_rate_type The type of pay rate value. This should be 'A' for
286 * Assignment; valid values are defined by the 'RATE_TYPE' lookup type.
287 * @param p_currency_code The currency of the rate value.
288 * @param p_value The actual rate paid to this Assignment.
289 * @param p_grade_rule_id If p_validate is false, then this uniquely identifies
290 * the Assignment Rate Type. If p_validate is true, then this is set to null.
291 * @param p_object_version_number If p_validate is false, then set to the
292 * version number of the created Assignment Rate Value record. If p_validate is
293 * true, then the value will be null.
294 * @param p_effective_start_date If p_validate is false, then set to the
295 * earliest effective start date for the created Assignment Rate Value. If
296 * p_validate is true, then set to null.
297 * @param p_effective_end_date If p_validate is false, then set to the
298 * effective end date for the created Assignment Rate Value. If p_validate is
299 * true, then set to null.
300 * @rep:displayname Create Assignment Rate Value
301 * @rep:category BUSINESS_ENTITY PER_CWK_RATE
302 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
303 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
304 * @rep:scope public
305 * @rep:lifecycle active
306 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
307 */
308 --
309 -- {End Of Comments}
310 --
311 PROCEDURE create_assignment_rate_value
312 (p_validate IN BOOLEAN DEFAULT FALSE
313 ,p_effective_date IN DATE
314 ,p_business_group_id IN NUMBER
315 ,p_rate_id IN NUMBER
316 ,p_assignment_id IN NUMBER
317 ,p_rate_type IN VARCHAR2
318 ,p_currency_code IN VARCHAR2 DEFAULT NULL
319 ,p_value IN VARCHAR2
320 ,p_grade_rule_id OUT NOCOPY NUMBER
321 ,p_object_version_number OUT NOCOPY NUMBER
322 ,p_effective_start_date OUT NOCOPY DATE
323 ,p_effective_end_date OUT NOCOPY DATE);
324 --
325 -- ----------------------------------------------------------------------------
326 -- |-----------------------< update_assignment_rate_value >-------------------|
327 -- ----------------------------------------------------------------------------
328 --
329 -- {Start Of Comments}
330 /*#
331 * This API updates Assignment Rate Values.
332 *
333 * Use this API to update Assignment Rate Values (rates for a particular
334 * contingent worker assignment). Assignment rates are date tracked so you can
335 * maintain a history of rates.
336 *
337 * <p><b>Licensing</b><br>
338 * This API is licensed for use with Human Resources.
339 *
340 * <p><b>Prerequisites</b><br>
341 * The Rate Value that is being updated must already exist.
342 *
343 * <p><b>Post Success</b><br>
344 * The Rate Value will have been updated.
345 *
346 * <p><b>Post Failure</b><br>
347 * The Rate Value will not be updated and an error will be raised.
348 * @param p_validate If true, then validation alone will be performed and the
349 * database will remain unchanged. If false and all validation checks pass,
350 * then the database will be modified.
351 * @param p_grade_rule_id Uniquely identifies the Rate Value that is being
352 * updated.
353 * @param p_effective_date Determines when the DateTrack operation comes into
354 * force.
355 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
356 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
360 * @param p_currency_code The currency of the rate value.
357 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
358 * depend on the dates of previous record changes and the effective date of
359 * this change.
361 * @param p_value The actual rate paid to this Assignment.
362 * @param p_object_version_number Pass in the current version number of the
363 * Rate Value to be updated. When the API completes if p_validate is false,
364 * will be set to the new version number of the updated Rate Value. If
365 * p_validate is true will be set to the same value which was passed in.
366 * @param p_effective_start_date If p_validate is false, then set to the
367 * effective start date on the updated Rate Value row which now exists as of
368 * the effective date. If p_validate is true, then set to null.
369 * @param p_effective_end_date If p_validate is false, then set to the
370 * effective end date on the updated Rate Value row which now exists as of the
371 * effective date. If p_validate is true, then set to null.
372 * @rep:displayname Update Assignment Rate Value
373 * @rep:category BUSINESS_ENTITY PER_CWK_RATE
374 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
375 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
376 * @rep:scope public
377 * @rep:lifecycle active
378 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
379 */
380 --
381 -- {End Of Comments}
382 --
383 PROCEDURE update_assignment_rate_value
384 (p_validate IN BOOLEAN DEFAULT FALSE
385 ,p_grade_rule_id IN NUMBER
386 ,p_effective_date IN DATE
387 ,p_datetrack_mode IN VARCHAR2
388 ,p_currency_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
389 ,p_value IN VARCHAR2 DEFAULT hr_api.g_varchar2
390 ,p_object_version_number IN OUT NOCOPY NUMBER
391 ,p_effective_start_date OUT NOCOPY DATE
392 ,p_effective_end_date OUT NOCOPY DATE);
393 --
394 -- ----------------------------------------------------------------------------
395 -- |----------------------------------< lck >---------------------------------|
396 -- ----------------------------------------------------------------------------
397 -- {Start Of Comments}
398 --
399 -- Description:
400 --
401 -- Prerequisites:
402 --
403 --
404 -- In Parameters:
405 -- Name Reqd Type Description
406 -- p_grade_rule_id Yes number PK of record
407 -- p_object_version_number Yes number OVN of record
408 -- p_effective_date Yes date Session Date.
409 -- p_datetrack_mode Yes varchar2 Datetrack mode.
410 --
411 -- Post Success:
412 --
413 -- Name Type Description
414 -- p_validation_start_date Yes Derived Effective Start Date.
415 -- p_validation_end_date Yes Derived Effective End Date.
416 --
417 -- Post Failure:
418 --
419 -- Access Status:
420 -- Public.
421 --
422 -- {End Of Comments}
423 --
424 PROCEDURE lck
425 (p_grade_rule_id IN NUMBER
426 ,p_object_version_number IN NUMBER
427 ,p_effective_date IN DATE
428 ,p_datetrack_mode IN VARCHAR2
429 ,p_validation_start_date OUT NOCOPY DATE
430 ,p_validation_end_date OUT NOCOPY DATE );
431 --
432 END hr_rate_values_api;
[Home] [Help]