1 Package hr_pay_scale_api as
2 /* $Header: peppsapi.pkh 120.1 2005/10/02 02:22:11 aroussel $ */
3 /*#
4 * This package contains APIs that maintain pay scales.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Scale
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_pay_scale >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a pay scale.
17 *
18 * A pay scale consists of one or more points. Note: points are maintained by
19 * the package HR Pay Scale Point APIs.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A business group must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * A pay scale will be created.
29 *
30 * <p><b>Post Failure</b><br>
31 * A pay scale will not be created and an error will be raised.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_business_group_id Uniquely identifies which business group in which
36 * the pay scale will be created.
37 * @param p_name The name of the pay scale. It must be unique within the
38 * business group.
39 * @param p_effective_date Reference date for validating lookup values are
40 * applicable during the start to end active date range. This date does not
41 * determine when the changes take effect.
42 * @param p_comments Comment text.
43 * @param p_increment_frequency When paired with increment period, this
44 * indicates how long it should take for an employee to move from one point to
45 * the next in the pay scale. This is informational only. No other processing,
46 * such as grade step progression, makes use of this information.
47 * @param p_increment_period The time period to which increment frequency
48 * applies, e.g., month, year. Valid values are defined by the FREQUENCY lookup
49 * type.
50 * @param p_last_automatic_increment_dat Date that the increment progression
51 * points process was last run against this pay scale. Only this process can
52 * call the API, which it does by specifying a value for this parameter.
53 * @param p_request_id When the API is executed from a concurrent program set
54 * to the concurrent request identifier.
55 * @param p_program_application_id When the API is executed from a concurrent
56 * program set to the program's Application.
57 * @param p_program_id When the API is executed from a concurrent program set
58 * to the program's identifier.
59 * @param p_program_update_date When the API is executed from a concurrent
60 * program set to when the program was ran.
61 * @param p_attribute_category This context value determines which flexfield
62 * structure to use with the descriptive flexfield segments.
63 * @param p_attribute1 Descriptive flexfield segment.
64 * @param p_attribute2 Descriptive flexfield segment.
65 * @param p_attribute3 Descriptive flexfield segment.
66 * @param p_attribute4 Descriptive flexfield segment.
67 * @param p_attribute5 Descriptive flexfield segment.
68 * @param p_attribute6 Descriptive flexfield segment.
69 * @param p_attribute7 Descriptive flexfield segment.
70 * @param p_attribute8 Descriptive flexfield segment.
71 * @param p_attribute9 Descriptive flexfield segment.
72 * @param p_attribute10 Descriptive flexfield segment.
73 * @param p_attribute11 Descriptive flexfield segment.
74 * @param p_attribute12 Descriptive flexfield segment.
75 * @param p_attribute13 Descriptive flexfield segment.
76 * @param p_attribute14 Descriptive flexfield segment.
77 * @param p_attribute15 Descriptive flexfield segment.
78 * @param p_attribute16 Descriptive flexfield segment.
79 * @param p_attribute17 Descriptive flexfield segment.
80 * @param p_attribute18 Descriptive flexfield segment.
81 * @param p_attribute19 Descriptive flexfield segment.
82 * @param p_attribute20 Descriptive flexfield segment.
83 * @param p_information_category This context value determines which flexfield
84 * structure to use with the developer descriptive flexfield segments.
85 * @param p_information1 Developer descriptive flexfield segment.
86 * @param p_information2 Developer descriptive flexfield segment.
87 * @param p_information3 Developer descriptive flexfield segment.
88 * @param p_information4 Developer descriptive flexfield segment.
89 * @param p_information5 Developer descriptive flexfield segment.
90 * @param p_information6 Developer descriptive flexfield segment.
91 * @param p_information7 Developer descriptive flexfield segment.
92 * @param p_information8 Developer descriptive flexfield segment.
93 * @param p_information9 Developer descriptive flexfield segment.
94 * @param p_information10 Developer descriptive flexfield segment.
95 * @param p_information11 Developer descriptive flexfield segment.
96 * @param p_information12 Developer descriptive flexfield segment.
97 * @param p_information13 Developer descriptive flexfield segment.
98 * @param p_information14 Developer descriptive flexfield segment.
99 * @param p_information15 Developer descriptive flexfield segment.
100 * @param p_information16 Developer descriptive flexfield segment.
101 * @param p_information17 Developer descriptive flexfield segment.
102 * @param p_information18 Developer descriptive flexfield segment.
103 * @param p_information19 Developer descriptive flexfield segment.
104 * @param p_information20 Developer descriptive flexfield segment.
105 * @param p_information21 Developer descriptive flexfield segment.
106 * @param p_information22 Developer descriptive flexfield segment.
107 * @param p_information23 Developer descriptive flexfield segment.
108 * @param p_information24 Developer descriptive flexfield segment.
109 * @param p_information25 Developer descriptive flexfield segment.
110 * @param p_information26 Developer descriptive flexfield segment.
111 * @param p_information27 Developer descriptive flexfield segment.
112 * @param p_information28 Developer descriptive flexfield segment.
113 * @param p_information29 Developer descriptive flexfield segment.
114 * @param p_information30 Developer descriptive flexfield segment.
115 * @param p_parent_spine_id If p_validate is false, uniquely identifies the pay
116 * scale created. If p_validate is true, set to null.
117 * @param p_object_version_number If p_validate is false, then set to the
118 * version number of the created pay scale. If p_validate is true, then the
119 * value will be null.
120 * @rep:displayname Create Pay Scale
121 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
122 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
123 * @rep:scope public
124 * @rep:lifecycle active
125 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
126 */
127 --
128 -- {End Of Comments}
129 --
130 procedure create_pay_scale
131 (p_validate in boolean default false
132 ,p_business_group_id in number
133 ,p_name in varchar2
134 ,p_effective_date in date default null
135 ,p_comments in varchar2 default null
136 ,p_increment_frequency in number default null
137 ,p_increment_period in varchar2 default null
138 ,p_last_automatic_increment_dat in date default null
139 ,p_request_id in number default null
140 ,p_program_application_id in number default null
141 ,p_program_id in number default null
142 ,p_program_update_date in date default null
143 ,p_attribute_category in varchar2 default null
144 ,p_attribute1 in varchar2 default null
145 ,p_attribute2 in varchar2 default null
146 ,p_attribute3 in varchar2 default null
147 ,p_attribute4 in varchar2 default null
148 ,p_attribute5 in varchar2 default null
149 ,p_attribute6 in varchar2 default null
150 ,p_attribute7 in varchar2 default null
151 ,p_attribute8 in varchar2 default null
152 ,p_attribute9 in varchar2 default null
153 ,p_attribute10 in varchar2 default null
154 ,p_attribute11 in varchar2 default null
155 ,p_attribute12 in varchar2 default null
156 ,p_attribute13 in varchar2 default null
157 ,p_attribute14 in varchar2 default null
158 ,p_attribute15 in varchar2 default null
159 ,p_attribute16 in varchar2 default null
160 ,p_attribute17 in varchar2 default null
161 ,p_attribute18 in varchar2 default null
162 ,p_attribute19 in varchar2 default null
163 ,p_attribute20 in varchar2 default null
164 ,p_information_category in varchar2 default null
165 ,p_information1 in varchar2 default null
166 ,p_information2 in varchar2 default null
167 ,p_information3 in varchar2 default null
168 ,p_information4 in varchar2 default null
169 ,p_information5 in varchar2 default null
170 ,p_information6 in varchar2 default null
171 ,p_information7 in varchar2 default null
172 ,p_information8 in varchar2 default null
173 ,p_information9 in varchar2 default null
174 ,p_information10 in varchar2 default null
175 ,p_information11 in varchar2 default null
176 ,p_information12 in varchar2 default null
177 ,p_information13 in varchar2 default null
178 ,p_information14 in varchar2 default null
179 ,p_information15 in varchar2 default null
180 ,p_information16 in varchar2 default null
181 ,p_information17 in varchar2 default null
182 ,p_information18 in varchar2 default null
183 ,p_information19 in varchar2 default null
184 ,p_information20 in varchar2 default null
185 ,p_information21 in varchar2 default null
186 ,p_information22 in varchar2 default null
187 ,p_information23 in varchar2 default null
188 ,p_information24 in varchar2 default null
189 ,p_information25 in varchar2 default null
190 ,p_information26 in varchar2 default null
191 ,p_information27 in varchar2 default null
192 ,p_information28 in varchar2 default null
193 ,p_information29 in varchar2 default null
194 ,p_information30 in varchar2 default null
195 ,p_parent_spine_id out nocopy number
196 ,p_object_version_number out nocopy number
197 );
198 --
199 -- ----------------------------------------------------------------------------
200 -- |-----------------------------< update_pay_scale >-------------------------|
201 -- ----------------------------------------------------------------------------
202 --
203 -- {Start Of Comments}
204 /*#
205 * This API updates a pay scale.
206 *
207 * A pay scale consists of one or more points. Points are maintained by the
208 * package HR Pay Scale Point APIs.
209 *
210 * <p><b>Licensing</b><br>
211 * This API is licensed for use with Human Resources.
212 *
213 * <p><b>Prerequisites</b><br>
214 * A pay scale must exist.
215 *
216 * <p><b>Post Success</b><br>
217 * The pay scale will be updated.
218 *
219 * <p><b>Post Failure</b><br>
220 * The pay scale will not be updated and an error will be raised.
221 * @param p_validate If true, then validation alone will be performed and the
222 * database will remain unchanged. If false and all validation checks pass,
223 * then the database will be modified.
224 * @param p_parent_spine_id Uniquely identifies the pay scale to be updated.
225 * @param p_business_group_id The business group in which the pay scale exists.
226 * This cannot be updated.
227 * @param p_name The name of the pay scale. It must be unique within the
228 * business group.
229 * @param p_effective_date Reference date for validating lookup values are
230 * applicable during the start to end active date range. This date does not
231 * determine when the changes take effect.
232 * @param p_comments Comment text.
233 * @param p_increment_frequency When paired with increment period, this
234 * indicates how long it should take for an employee to move from one point to
235 * the next in the pay scale. This is informational only. No other processing,
236 * such as grade step progression, makes use of this information.
237 * @param p_increment_period The time period for which increment frequency
238 * applies, e.g., month, year. Valid values are defined by the FREQUENCY lookup
239 * type.
240 * @param p_last_automatic_increment_dat Date that the increment progression
241 * points process was last run against this pay scale. Only this process can
242 * call the API, which it does by specifying a value for this parameter.
243 * @param p_request_id When the API is executed from a concurrent program set
244 * to the concurrent request identifier.
245 * @param p_program_application_id When the API is executed from a concurrent
246 * program set to the program's Application.
247 * @param p_program_id When the API is executed from a concurrent program set
248 * to the program's identifier.
249 * @param p_program_update_date When the API is executed from a concurrent
250 * program set to when the program was ran.
251 * @param p_attribute_category This context value determines which flexfield
252 * structure to use with the descriptive flexfield segments.
253 * @param p_attribute1 Descriptive flexfield segment.
254 * @param p_attribute2 Descriptive flexfield segment.
255 * @param p_attribute3 Descriptive flexfield segment.
256 * @param p_attribute4 Descriptive flexfield segment.
257 * @param p_attribute5 Descriptive flexfield segment.
258 * @param p_attribute6 Descriptive flexfield segment.
259 * @param p_attribute7 Descriptive flexfield segment.
260 * @param p_attribute8 Descriptive flexfield segment.
261 * @param p_attribute9 Descriptive flexfield segment.
262 * @param p_attribute10 Descriptive flexfield segment.
263 * @param p_attribute11 Descriptive flexfield segment.
264 * @param p_attribute12 Descriptive flexfield segment.
265 * @param p_attribute13 Descriptive flexfield segment.
266 * @param p_attribute14 Descriptive flexfield segment.
267 * @param p_attribute15 Descriptive flexfield segment.
268 * @param p_attribute16 Descriptive flexfield segment.
269 * @param p_attribute17 Descriptive flexfield segment.
270 * @param p_attribute18 Descriptive flexfield segment.
271 * @param p_attribute19 Descriptive flexfield segment.
272 * @param p_attribute20 Descriptive flexfield segment.
273 * @param p_information_category This context value determines which flexfield
274 * structure to use with the developer descriptive flexfield segments.
275 * @param p_information1 Developer descriptive flexfield segment.
276 * @param p_information2 Developer descriptive flexfield segment.
277 * @param p_information3 Developer descriptive flexfield segment.
278 * @param p_information4 Developer descriptive flexfield segment.
279 * @param p_information5 Developer descriptive flexfield segment.
280 * @param p_information6 Developer descriptive flexfield segment.
281 * @param p_information7 Developer descriptive flexfield segment.
282 * @param p_information8 Developer descriptive flexfield segment.
283 * @param p_information9 Developer descriptive flexfield segment.
284 * @param p_information10 Developer descriptive flexfield segment.
285 * @param p_information11 Developer descriptive flexfield segment.
286 * @param p_information12 Developer descriptive flexfield segment.
287 * @param p_information13 Developer descriptive flexfield segment.
288 * @param p_information14 Developer descriptive flexfield segment.
289 * @param p_information15 Developer descriptive flexfield segment.
290 * @param p_information16 Developer descriptive flexfield segment.
291 * @param p_information17 Developer descriptive flexfield segment.
292 * @param p_information18 Developer descriptive flexfield segment.
293 * @param p_information19 Developer descriptive flexfield segment.
294 * @param p_information20 Developer descriptive flexfield segment.
295 * @param p_information21 Developer descriptive flexfield segment.
296 * @param p_information22 Developer descriptive flexfield segment.
297 * @param p_information23 Developer descriptive flexfield segment.
298 * @param p_information24 Developer descriptive flexfield segment.
299 * @param p_information25 Developer descriptive flexfield segment.
300 * @param p_information26 Developer descriptive flexfield segment.
301 * @param p_information27 Developer descriptive flexfield segment.
302 * @param p_information28 Developer descriptive flexfield segment.
303 * @param p_information29 Developer descriptive flexfield segment.
304 * @param p_information30 Developer descriptive flexfield segment.
305 * @param p_object_version_number Pass in the current version number of the pay
306 * scale to be updated. When the process completes if p_validate is false, will
307 * be set to the new version number of the updated pay scale. If p_validate is
308 * true will be set to the same value which was passed in.
309 * @rep:displayname Update Pay Scale
310 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
311 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
312 * @rep:scope public
313 * @rep:lifecycle active
314 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
315 */
316 --
317 -- {End Of Comments}
318 --
319 procedure update_pay_scale
320 (p_validate in boolean default false
321 ,p_parent_spine_id in number
322 ,p_business_group_id in number default hr_api.g_number
323 ,p_name in varchar2 default hr_api.g_varchar2
324 ,p_effective_date in date default hr_api.g_date
325 ,p_comments in varchar2 default hr_api.g_varchar2
326 ,p_increment_frequency in number default hr_api.g_number
327 ,p_increment_period in varchar2 default hr_api.g_varchar2
328 ,p_last_automatic_increment_dat in date default hr_api.g_date
329 ,p_request_id in number default hr_api.g_number
330 ,p_program_application_id in number default hr_api.g_number
331 ,p_program_id in number default hr_api.g_number
332 ,p_program_update_date in date default hr_api.g_date
333 ,p_attribute_category in varchar2 default hr_api.g_varchar2
334 ,p_attribute1 in varchar2 default hr_api.g_varchar2
335 ,p_attribute2 in varchar2 default hr_api.g_varchar2
336 ,p_attribute3 in varchar2 default hr_api.g_varchar2
337 ,p_attribute4 in varchar2 default hr_api.g_varchar2
338 ,p_attribute5 in varchar2 default hr_api.g_varchar2
339 ,p_attribute6 in varchar2 default hr_api.g_varchar2
340 ,p_attribute7 in varchar2 default hr_api.g_varchar2
341 ,p_attribute8 in varchar2 default hr_api.g_varchar2
342 ,p_attribute9 in varchar2 default hr_api.g_varchar2
343 ,p_attribute10 in varchar2 default hr_api.g_varchar2
344 ,p_attribute11 in varchar2 default hr_api.g_varchar2
345 ,p_attribute12 in varchar2 default hr_api.g_varchar2
346 ,p_attribute13 in varchar2 default hr_api.g_varchar2
347 ,p_attribute14 in varchar2 default hr_api.g_varchar2
348 ,p_attribute15 in varchar2 default hr_api.g_varchar2
349 ,p_attribute16 in varchar2 default hr_api.g_varchar2
350 ,p_attribute17 in varchar2 default hr_api.g_varchar2
351 ,p_attribute18 in varchar2 default hr_api.g_varchar2
352 ,p_attribute19 in varchar2 default hr_api.g_varchar2
353 ,p_attribute20 in varchar2 default hr_api.g_varchar2
354 ,p_information_category in varchar2 default hr_api.g_varchar2
355 ,p_information1 in varchar2 default hr_api.g_varchar2
356 ,p_information2 in varchar2 default hr_api.g_varchar2
357 ,p_information3 in varchar2 default hr_api.g_varchar2
358 ,p_information4 in varchar2 default hr_api.g_varchar2
359 ,p_information5 in varchar2 default hr_api.g_varchar2
360 ,p_information6 in varchar2 default hr_api.g_varchar2
361 ,p_information7 in varchar2 default hr_api.g_varchar2
362 ,p_information8 in varchar2 default hr_api.g_varchar2
363 ,p_information9 in varchar2 default hr_api.g_varchar2
364 ,p_information10 in varchar2 default hr_api.g_varchar2
365 ,p_information11 in varchar2 default hr_api.g_varchar2
366 ,p_information12 in varchar2 default hr_api.g_varchar2
367 ,p_information13 in varchar2 default hr_api.g_varchar2
368 ,p_information14 in varchar2 default hr_api.g_varchar2
369 ,p_information15 in varchar2 default hr_api.g_varchar2
370 ,p_information16 in varchar2 default hr_api.g_varchar2
371 ,p_information17 in varchar2 default hr_api.g_varchar2
372 ,p_information18 in varchar2 default hr_api.g_varchar2
373 ,p_information19 in varchar2 default hr_api.g_varchar2
374 ,p_information20 in varchar2 default hr_api.g_varchar2
375 ,p_information21 in varchar2 default hr_api.g_varchar2
376 ,p_information22 in varchar2 default hr_api.g_varchar2
377 ,p_information23 in varchar2 default hr_api.g_varchar2
378 ,p_information24 in varchar2 default hr_api.g_varchar2
379 ,p_information25 in varchar2 default hr_api.g_varchar2
380 ,p_information26 in varchar2 default hr_api.g_varchar2
381 ,p_information27 in varchar2 default hr_api.g_varchar2
382 ,p_information28 in varchar2 default hr_api.g_varchar2
383 ,p_information29 in varchar2 default hr_api.g_varchar2
384 ,p_information30 in varchar2 default hr_api.g_varchar2
385 ,p_object_version_number in out nocopy number
386 );
387 --
388 -- ----------------------------------------------------------------------------
389 -- |-----------------------------< delete_pay_scale >-------------------------|
390 -- ----------------------------------------------------------------------------
391 --
392 -- {Start Of Comments}
393 /*#
394 * This API deletes a pay scale.
395 *
396 * A pay scale consists of one or more points. Points are maintained by the
397 * package HR Pay Scale Point APIs.
398 *
399 * <p><b>Licensing</b><br>
400 * This API is licensed for use with Human Resources.
401 *
402 * <p><b>Prerequisites</b><br>
403 * A pay scale must exist. You cannot delete a pay scale if it contains any
404 * points; delete the points first.
405 *
406 * <p><b>Post Success</b><br>
407 * The pay scale will be deleted
408 *
409 * <p><b>Post Failure</b><br>
410 * The pay scale will not be deleted and an error will be raised.
411 * @param p_validate If true, then validation alone will be performed and the
412 * database will remain unchanged. If false and all validation checks pass,
413 * then the database will be modified.
414 * @param p_parent_spine_id Uniquely identifies the pay scale to be deleted.
415 * @param p_object_version_number Current version number of the pay scale to be
416 * deleted
417 * @rep:displayname Delete Pay Scale
418 * @rep:category BUSINESS_ENTITY HR_PAY_SCALE
419 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
420 * @rep:scope public
421 * @rep:lifecycle active
422 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
423 */
424 --
425 -- {End Of Comments}
426 --
427 procedure delete_pay_scale
428 (p_validate in boolean default false
429 ,p_parent_spine_id in number
430 ,p_object_version_number in number
431 );
432
433 --
434 end hr_pay_scale_api;
435 --
[Home] [Help]