1 Package hr_grade_step_api as
2 /* $Header: pespsapi.pkh 120.3.12000000.1 2007/01/22 04:39:16 appldev noship $ */
3 /*#
4 * This package contains APIs that maintain grade steps.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Grade Step
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_grade_step >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new grade step for a given grade scale.
17 *
18 * Each grade step within the grade scale is linked to a point in the
19 * associated pay scale.
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 grade scale must exist before a grade step can be created within it. A
26 * point must exist in the associated pay scale.
27 *
28 * <p><b>Post Success</b><br>
29 * A grade step will be created.
30 *
31 * <p><b>Post Failure</b><br>
32 * A grade step will not be created and an error will be raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force
38 * @param p_business_group_id The business group that the grade step is created
39 * in. Must be the same as the business group of the parent grade scale.
40 * @param p_spinal_point_id Uniquely identifies the pay scale point the grade
41 * step is linked to. The pay scale point must be within the pay scale
42 * associated with the parent grade scale.
43 * @param p_grade_spine_id Uniquely identifies the grade scale in which the
44 * grade step is created.
45 * @param p_sequence Must be the same as the sequence of the pay scale point.
46 * @param p_request_id When the API is executed from a concurrent program set
47 * to the concurrent request identifier.
48 * @param p_program_application_id When the API is executed from a concurrent
49 * program set to the program's Application.
50 * @param p_program_id When the API is executed from a concurrent program set
51 * to the program's identifier.
52 * @param p_program_update_date When the API is executed from a concurrent
53 * program set to when the program was ran.
54 * @param p_information_category This context value determines which flexfield
55 * structure to use with the developer descriptive flexfield segments.
56 * @param p_information1 Developer descriptive flexfield segment.
57 * @param p_information2 Developer descriptive flexfield segment.
58 * @param p_information3 Developer descriptive flexfield segment.
59 * @param p_information4 Developer descriptive flexfield segment.
60 * @param p_information5 Developer descriptive flexfield segment.
61 * @param p_information6 Developer descriptive flexfield segment.
62 * @param p_information7 Developer descriptive flexfield segment.
63 * @param p_information8 Developer descriptive flexfield segment.
64 * @param p_information9 Developer descriptive flexfield segment.
65 * @param p_information10 Developer descriptive flexfield segment.
66 * @param p_information11 Developer descriptive flexfield segment.
67 * @param p_information12 Developer descriptive flexfield segment.
68 * @param p_information13 Developer descriptive flexfield segment.
69 * @param p_information14 Developer descriptive flexfield segment.
70 * @param p_information15 Developer descriptive flexfield segment.
71 * @param p_information16 Developer descriptive flexfield segment.
72 * @param p_information17 Developer descriptive flexfield segment.
73 * @param p_information18 Developer descriptive flexfield segment.
74 * @param p_information19 Developer descriptive flexfield segment.
75 * @param p_information20 Developer descriptive flexfield segment.
76 * @param p_information21 Developer descriptive flexfield segment.
77 * @param p_information22 Developer descriptive flexfield segment.
78 * @param p_information23 Developer descriptive flexfield segment.
79 * @param p_information24 Developer descriptive flexfield segment.
80 * @param p_information25 Developer descriptive flexfield segment.
81 * @param p_information26 Developer descriptive flexfield segment.
82 * @param p_information27 Developer descriptive flexfield segment.
83 * @param p_information28 Developer descriptive flexfield segment.
84 * @param p_information29 Developer descriptive flexfield segment.
85 * @param p_information30 Developer descriptive flexfield segment.
86 * @param p_step_id If p_validate is false, uniquely identifies the grade step
87 * created. If p_validate is true, set to null.
88 * @param p_effective_start_date If p_validate is false, then set to the
89 * earliest effective start date for the created grade step. If p_validate is
90 * true, then set to null.
91 * @param p_effective_end_date If p_validate is false, then set to the
92 * effective end date for the created grade step. If p_validate is true, then
93 * set to null.
94 * @param p_object_version_number If p_validate is false, then set to the
95 * version number of the created grade step. If p_validate is true, then the
96 * value will be null.
97 * @rep:displayname Create Grade Step
98 * @rep:category BUSINESS_ENTITY PER_GRADE
99 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
100 * @rep:scope public
101 * @rep:lifecycle active
102 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
103 */
104 --
105 -- {End Of Comments}
106 --
107 procedure create_grade_step
108 (p_validate in boolean default false
109 ,p_effective_date in date
110 ,p_business_group_id in number
111 ,p_spinal_point_id in number
112 ,p_grade_spine_id in number
113 ,p_sequence in number
114 ,p_request_id in number default null
115 ,p_program_application_id in number default null
116 ,p_program_id in number default null
117 ,p_program_update_date in date default null
118 ,p_information_category in varchar2 default null
119 ,p_information1 in varchar2 default null
120 ,p_information2 in varchar2 default null
121 ,p_information3 in varchar2 default null
122 ,p_information4 in varchar2 default null
123 ,p_information5 in varchar2 default null
124 ,p_information6 in varchar2 default null
125 ,p_information7 in varchar2 default null
126 ,p_information8 in varchar2 default null
127 ,p_information9 in varchar2 default null
128 ,p_information10 in varchar2 default null
129 ,p_information11 in varchar2 default null
130 ,p_information12 in varchar2 default null
131 ,p_information13 in varchar2 default null
132 ,p_information14 in varchar2 default null
133 ,p_information15 in varchar2 default null
134 ,p_information16 in varchar2 default null
135 ,p_information17 in varchar2 default null
136 ,p_information18 in varchar2 default null
137 ,p_information19 in varchar2 default null
138 ,p_information20 in varchar2 default null
139 ,p_information21 in varchar2 default null
140 ,p_information22 in varchar2 default null
141 ,p_information23 in varchar2 default null
142 ,p_information24 in varchar2 default null
143 ,p_information25 in varchar2 default null
144 ,p_information26 in varchar2 default null
145 ,p_information27 in varchar2 default null
146 ,p_information28 in varchar2 default null
147 ,p_information29 in varchar2 default null
148 ,p_information30 in varchar2 default null
149 ,p_step_id in out nocopy number
150 ,p_effective_start_date out nocopy date
151 ,p_effective_end_date out nocopy date
152 ,p_object_version_number out nocopy number
153 ) ;
154 --
155 -- ----------------------------------------------------------------------------
156 -- |----------------------------< update_grade_step >-------------------------|
157 -- ----------------------------------------------------------------------------
158 --
159 -- {Start Of Comments}
160 /*#
161 * This API updates a grade step for a given grade scale.
162 *
163 * Each grade step within the grade scale is linked to a point in the
164 * associated pay scale. Only flexfield information can be updated for an
165 * existing grade step.
166 *
167 * <p><b>Licensing</b><br>
168 * This API is licensed for use with Human Resources.
169 *
170 * <p><b>Prerequisites</b><br>
171 * The grade step must exist on the date of the update.
172 *
173 * <p><b>Post Success</b><br>
174 * The grade step will be updated
175 *
176 * <p><b>Post Failure</b><br>
177 * The grade step will not be updated and an error will be raised.
178 * @param p_validate If true, then validation alone will be performed and the
179 * database will remain unchanged. If false and all validation checks pass,
180 * then the database will be modified.
181 * @param p_effective_date Determines when the DateTrack operation comes into
182 * force
183 * @param p_datetrack_mode ndicates which DateTrack mode to use when updating
184 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
185 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
186 * depend on the dates of previous record changes and the effective date of
187 * this change.
188 * @param p_step_id Uniquely identifies the grade step to be updated.
189 * @param p_object_version_number Pass in the current version number of the
190 * grade step to be updated. When the process completes if p_validate is false,
191 * will be set to the new version number of the updated grade step. If
192 * p_validate is true will be set to the same value which was passed in.
193 * @param p_business_group_id The business group in which the grade step
194 * exists. Must be the same as the business group of the parent grade scale. It
195 * cannot be updated.
196 * @param p_spinal_point_id Uniquely identifies which pay scale point the grade
197 * step is linked to. The pay scale point must be within the pay scale
198 * associated with the parent grade scale. It cannot be updated
199 * @param p_grade_spine_id Uniquely identifies the grade scale in which the
200 * grade step is created. It cannot be updated.
201 * @param p_sequence Must be the same as the sequence of the pay scale point.
202 * It cannot be updated
203 * @param p_request_id When the API is executed from a concurrent program set
204 * to the concurrent request identifier.
205 * @param p_program_application_id When the API is executed from a concurrent
206 * program set to the program's Application.
207 * @param p_program_id When the API is executed from a concurrent program set
208 * to the program's identifier.
209 * @param p_program_update_date When the API is executed from a concurrent
210 * program set to when the program was ran.
211 * @param p_information_category This context value determines which flexfield
212 * structure to use with the developer descriptive flexfield segments.
213 * @param p_information1 Developer descriptive flexfield segment.
214 * @param p_information2 Developer descriptive flexfield segment.
215 * @param p_information3 Developer descriptive flexfield segment.
216 * @param p_information4 Developer descriptive flexfield segment.
217 * @param p_information5 Developer descriptive flexfield segment.
218 * @param p_information6 Developer descriptive flexfield segment.
219 * @param p_information7 Developer descriptive flexfield segment.
220 * @param p_information8 Developer descriptive flexfield segment.
221 * @param p_information9 Developer descriptive flexfield segment.
222 * @param p_information10 Developer descriptive flexfield segment.
223 * @param p_information11 Developer descriptive flexfield segment.
224 * @param p_information12 Developer descriptive flexfield segment.
225 * @param p_information13 Developer descriptive flexfield segment.
226 * @param p_information14 Developer descriptive flexfield segment.
227 * @param p_information15 Developer descriptive flexfield segment.
228 * @param p_information16 Developer descriptive flexfield segment.
229 * @param p_information17 Developer descriptive flexfield segment.
230 * @param p_information18 Developer descriptive flexfield segment.
231 * @param p_information19 Developer descriptive flexfield segment.
232 * @param p_information20 Developer descriptive flexfield segment.
233 * @param p_information21 Developer descriptive flexfield segment.
234 * @param p_information22 Developer descriptive flexfield segment.
235 * @param p_information23 Developer descriptive flexfield segment.
236 * @param p_information24 Developer descriptive flexfield segment.
237 * @param p_information25 Developer descriptive flexfield segment.
238 * @param p_information26 Developer descriptive flexfield segment.
239 * @param p_information27 Developer descriptive flexfield segment.
240 * @param p_information28 Developer descriptive flexfield segment.
241 * @param p_information29 Developer descriptive flexfield segment.
242 * @param p_information30 Developer descriptive flexfield segment.
243 * @param p_effective_start_date If p_validate is false, then set to the
244 * effective start date on the updated grade step row which now exists as of
245 * the effective date. If p_validate is true, then set to null.
246 * @param p_effective_end_date If p_validate is false, then set to the
247 * effective end date on the updated grade step row which now exists as of the
248 * effective date. If p_validate is true, then set to null.
249 * @rep:displayname Update Grade Step
250 * @rep:category BUSINESS_ENTITY PER_GRADE
251 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
252 * @rep:scope public
253 * @rep:lifecycle active
254 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
255 */
256 --
257 -- {End Of Comments}
258 --
259 procedure update_grade_step
260 (p_validate in boolean default false
261 ,p_effective_date in date default hr_api.g_date
262 ,p_datetrack_mode in varchar2
263 ,p_step_id in number
264 ,p_object_version_number in out nocopy number
265 ,p_business_group_id in number default hr_api.g_number
266 ,p_spinal_point_id in number default hr_api.g_number
267 ,p_grade_spine_id in number default hr_api.g_number
268 ,p_sequence in number default hr_api.g_number
269 ,p_request_id in number default hr_api.g_number
270 ,p_program_application_id in number default hr_api.g_number
271 ,p_program_id in number default hr_api.g_number
272 ,p_program_update_date in date default hr_api.g_date
273 ,p_information_category in varchar2 default hr_api.g_varchar2
274 ,p_information1 in varchar2 default hr_api.g_varchar2
275 ,p_information2 in varchar2 default hr_api.g_varchar2
276 ,p_information3 in varchar2 default hr_api.g_varchar2
277 ,p_information4 in varchar2 default hr_api.g_varchar2
278 ,p_information5 in varchar2 default hr_api.g_varchar2
279 ,p_information6 in varchar2 default hr_api.g_varchar2
280 ,p_information7 in varchar2 default hr_api.g_varchar2
281 ,p_information8 in varchar2 default hr_api.g_varchar2
282 ,p_information9 in varchar2 default hr_api.g_varchar2
283 ,p_information10 in varchar2 default hr_api.g_varchar2
284 ,p_information11 in varchar2 default hr_api.g_varchar2
285 ,p_information12 in varchar2 default hr_api.g_varchar2
286 ,p_information13 in varchar2 default hr_api.g_varchar2
287 ,p_information14 in varchar2 default hr_api.g_varchar2
288 ,p_information15 in varchar2 default hr_api.g_varchar2
289 ,p_information16 in varchar2 default hr_api.g_varchar2
290 ,p_information17 in varchar2 default hr_api.g_varchar2
294 ,p_information21 in varchar2 default hr_api.g_varchar2
291 ,p_information18 in varchar2 default hr_api.g_varchar2
292 ,p_information19 in varchar2 default hr_api.g_varchar2
293 ,p_information20 in varchar2 default hr_api.g_varchar2
295 ,p_information22 in varchar2 default hr_api.g_varchar2
296 ,p_information23 in varchar2 default hr_api.g_varchar2
297 ,p_information24 in varchar2 default hr_api.g_varchar2
298 ,p_information25 in varchar2 default hr_api.g_varchar2
299 ,p_information26 in varchar2 default hr_api.g_varchar2
300 ,p_information27 in varchar2 default hr_api.g_varchar2
301 ,p_information28 in varchar2 default hr_api.g_varchar2
302 ,p_information29 in varchar2 default hr_api.g_varchar2
303 ,p_information30 in varchar2 default hr_api.g_varchar2
304 ,p_effective_start_date out nocopy date
305 ,p_effective_end_date out nocopy date
306 ) ;
307 --
308 -- ----------------------------------------------------------------------------
309 -- |----------------------------< delete_grade_step >-------------------------|
310 -- ----------------------------------------------------------------------------
311 --
312 -- {Start Of Comments}
313 /*#
314 * This API deletes a grade step for a given grade scale.
315 *
316 * Each grade step within the grade scale is linked to a point in the
317 * associated pay scale.
318 *
319 * <p><b>Licensing</b><br>
320 * This API is licensed for use with Human Resources.
321 *
322 * <p><b>Prerequisites</b><br>
323 * The grade step must exist on the date it is to be deleted. The grade step
324 * cannot be deleted if any employees are assigned to that step.
325 *
326 * <p><b>Post Success</b><br>
327 * The grade step will be deleted.
328 *
329 * <p><b>Post Failure</b><br>
330 * The grade step will not be deleted and an error will be raised.
331 * @param p_validate If true, then validation alone will be performed and the
332 * database will remain unchanged. If false and all validation checks pass,
333 * then the database will be modified.
334 * @param p_effective_date Determines when the DateTrack operation comes into
335 * force
336 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
337 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
338 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
339 * on the dates of previous record changes and the effective date of this
340 * change.
341 * @param p_step_id Uniquely identifies the grade step to be deleted.
342 * @param p_object_version_number Current version number of the grade step to
343 * be deleted.
344 * @param p_effective_start_date If p_validate is false, then set to the
345 * effective start date for the deleted grade step row which now exists as of
346 * the effective date. If p_validate is true or all row instances have been
347 * deleted then set to null.
348 * @param p_effective_end_date If p_validate is false, then set to the
349 * effective end date for the deleted grade step row which now exists as of the
350 * effective date. If p_validate is true or all row instances have been deleted
351 * then set to null.
352 * @rep:displayname Delete Grade Step
353 * @rep:category BUSINESS_ENTITY PER_GRADE
354 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
355 * @rep:scope public
356 * @rep:lifecycle active
357 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
358 */
359 --
360 -- {End Of Comments}
361 --
362 procedure delete_grade_step
363 (p_validate in boolean
364 ,p_effective_date in date
365 ,p_datetrack_mode in varchar2
366 ,p_step_id in number
367 ,p_object_version_number in out nocopy number
368 ,p_effective_start_date out nocopy date
369 ,p_effective_end_date out nocopy date
370 );
371
372 -- ----------------------------------------------------------------------------
373 -- |----------------------< delete_grade_step >-------------------------------|
374 -- ----------------------------------------------------------------------------
375 --
376 -- Description:
377 -- Deletes grade scale record
378 --
379 -- Prerequisites:
380 -- The grade scale as identified by the in parameter p_step_id
381 -- and the in out parameter p_object_version_number must already exist.
382 -- There must be no records relating to the step_id in the
383 -- reference tables.
384 --
385 -- In Parameters:
386 -- Name Reqd Type Description
387 -- p_validate boolean If true, the database
388 -- remains unchanged. If false,
389 -- the absence record is created.
390 -- p_effective_date Yes date Application effective date.
391 -- p_datetrack_mode Yes varchar2 Delete mode.
392 -- p_step_id Yes number Primary key of the grade step
393 -- p_object_version_number Yes number If p_validate is false, set to
394 -- the version number of this
395 -- absence. If p_validate is true
396 -- set to null.
400 --
397 -- P_called_from_del_grd_scale yes boolean If false then performs the
398 -- the ceiling step validations.
399 -- Post Success:
401 -- The grade scale is deleted.
402 --
403 -- Name
404 -- p_object_version_number number If p_validate is false then
405 -- new version number is returned
406 -- depending upon datetrack mode.
407 -- If p_validate is false true then
408 -- version number passed in is
409 -- returned.
410 -- p_effective_start_date date Effective start date of the
411 -- grade scale changes.
412 -- p_effective_end_date date Effective end date of the
413 -- grade scale changes.
417 --
414 --
415 -- Post Failure:
416 -- The API does not delete grade scale action and raises an error.
418 -- Access Status:
419 -- Public.
420 --
421 -- {End Of Comments}
422 --
423
424 procedure delete_grade_step
425 (p_validate in boolean
426 ,p_effective_date in date
427 ,p_datetrack_mode in varchar2
428 ,p_step_id in number
429 ,p_object_version_number in out nocopy number
430 ,p_effective_start_date out nocopy date
431 ,p_effective_end_date out nocopy date
432 ,p_called_from_del_grd_scale in boolean -- bug 4096238
433 );
434
435 --
436 end hr_grade_step_api;
437 --
[Home] [Help]