1 Package per_hierarchy_api as
2 /* $Header: pepghapi.pkh 120.1 2005/10/02 02:21:16 aroussel $ */
3 /*#
4 * This package contains APIs which maintains generic hierarchy records.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Generic Hierarchy
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_hierarchy >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a generic hierarchy.
17 *
18 * Generic hierarchy provides the means to create and maintain a hierarchies of
19 * data, each of which can be given a name and a type and then populated with
20 * data from pre-defined value sets. The data can therefore be drawn from any
21 * areas of the HRMS system, based on the definition of the value sets that are
22 * being used for the hierarchy. Multiple dated versions of the hierarchy
23 * structure can be maintained.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * A node type hierarchy structure belonging to the hierarchy type specified
30 * for this generic hierarchy must exist. The node type hierarchy controls
31 * which value set is used to populate each level of data within the generioc
32 * hierarchy.
33 *
34 * <p><b>Post Success</b><br>
35 * The generic hierarchy is created.
36 *
37 * <p><b>Post Failure</b><br>
38 * The generic hierarchy is not created and an error is raised.
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_hierarchy_id If p_validate is false then uniquely identifies the
43 * generic hierarchy created. If p_validate is true then set to null.
44 * @param p_business_group_id The business group under which the generic
45 * hierarchy will be created.
46 * @param p_name The name of the generic hierarchy.
47 * @param p_type The type of generic hierarchy to be created. Valid values are
48 * defined by the 'HIERARCHY_TYPE' lookup type.
49 * @param p_request_id When the API is executed from a concurrent program set
50 * to the concurrent request identifier.
51 * @param p_program_application_id When the API is executed from a concurrent
52 * program set to the program's Application.
53 * @param p_program_id When the API is executed from a concurrent program set
54 * to the program's identifier.
55 * @param p_program_update_date When the API is executed from a concurrent
56 * program set to when the program was ran.
57 * @param p_object_version_number If p_validate is false, then set to the
58 * version number of the created generic hierarchy. If p_validate is true, then
59 * the value will be null.
60 * @param p_attribute_category This context value determines which flexfield
61 * structure to use with the descriptive flexfield segments.
62 * @param p_attribute1 Descriptive flexfield segment.
63 * @param p_attribute2 Descriptive flexfield segment.
64 * @param p_attribute3 Descriptive flexfield segment.
65 * @param p_attribute4 Descriptive flexfield segment.
66 * @param p_attribute5 Descriptive flexfield segment.
67 * @param p_attribute6 Descriptive flexfield segment.
68 * @param p_attribute7 Descriptive flexfield segment.
69 * @param p_attribute8 Descriptive flexfield segment.
70 * @param p_attribute9 Descriptive flexfield segment.
71 * @param p_attribute10 Descriptive flexfield segment.
72 * @param p_attribute11 Descriptive flexfield segment.
73 * @param p_attribute12 Descriptive flexfield segment.
74 * @param p_attribute13 Descriptive flexfield segment.
75 * @param p_attribute14 Descriptive flexfield segment.
76 * @param p_attribute15 Descriptive flexfield segment.
77 * @param p_attribute16 Descriptive flexfield segment.
78 * @param p_attribute17 Descriptive flexfield segment.
79 * @param p_attribute18 Descriptive flexfield segment.
80 * @param p_attribute19 Descriptive flexfield segment.
81 * @param p_attribute20 Descriptive flexfield segment.
82 * @param p_attribute21 Descriptive flexfield segment.
83 * @param p_attribute22 Descriptive flexfield segment.
84 * @param p_attribute23 Descriptive flexfield segment.
85 * @param p_attribute24 Descriptive flexfield segment.
86 * @param p_attribute25 Descriptive flexfield segment.
87 * @param p_attribute26 Descriptive flexfield segment.
88 * @param p_attribute27 Descriptive flexfield segment.
89 * @param p_attribute28 Descriptive flexfield segment.
90 * @param p_attribute29 Descriptive flexfield segment.
91 * @param p_attribute30 Descriptive flexfield segment.
92 * @param p_information_category This context value determines which flexfield
93 * structure to use with the developer descriptive flexfield segments.
94 * @param p_information1 Developer descriptive flexfield segment.
95 * @param p_information2 Developer descriptive flexfield segment.
96 * @param p_information3 Developer descriptive flexfield segment.
97 * @param p_information4 Developer descriptive flexfield segment.
98 * @param p_information5 Developer descriptive flexfield segment.
99 * @param p_information6 Developer descriptive flexfield segment.
100 * @param p_information7 Developer descriptive flexfield segment.
101 * @param p_information8 Developer descriptive flexfield segment.
102 * @param p_information9 Developer descriptive flexfield segment.
103 * @param p_information10 Developer descriptive flexfield segment.
104 * @param p_information11 Developer descriptive flexfield segment.
105 * @param p_information12 Developer descriptive flexfield segment.
106 * @param p_information13 Developer descriptive flexfield segment.
107 * @param p_information14 Developer descriptive flexfield segment.
108 * @param p_information15 Developer descriptive flexfield segment.
109 * @param p_information16 Developer descriptive flexfield segment.
110 * @param p_information17 Developer descriptive flexfield segment.
111 * @param p_information18 Developer descriptive flexfield segment.
112 * @param p_information19 Developer descriptive flexfield segment.
113 * @param p_information20 Developer descriptive flexfield segment.
114 * @param p_information21 Developer descriptive flexfield segment.
115 * @param p_information22 Developer descriptive flexfield segment.
116 * @param p_information23 Developer descriptive flexfield segment.
117 * @param p_information24 Developer descriptive flexfield segment.
118 * @param p_information25 Developer descriptive flexfield segment.
119 * @param p_information26 Developer descriptive flexfield segment.
120 * @param p_information27 Developer descriptive flexfield segment.
121 * @param p_information28 Developer descriptive flexfield segment.
122 * @param p_information29 Developer descriptive flexfield segment.
123 * @param p_information30 Developer descriptive flexfield segment.
124 * @param p_effective_date Reference date for validating lookup values are
125 * applicable during the start to end active date range. This date does not
126 * determine when the changes take effect.
127 * @rep:displayname Create Hierarchy
128 * @rep:category BUSINESS_ENTITY PER_GENERIC_HIERARCHY
129 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
130 * @rep:scope public
131 * @rep:lifecycle active
132 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
133 */
134 --
135 -- {End Of Comments}
136 --
137 procedure create_hierarchy
138 (
139 p_validate in boolean default false
140 ,p_hierarchy_id out nocopy number
141 ,p_business_group_id in number default null
142 ,p_name in varchar2 default null
143 ,p_type in varchar2 default null
144 ,p_request_id in number default null
145 ,p_program_application_id in number default null
146 ,p_program_id in number default null
147 ,p_program_update_date in date default null
148 ,p_object_version_number in out nocopy number
149 ,p_attribute_category in varchar2 default null
150 ,p_attribute1 in varchar2 default null
151 ,p_attribute2 in varchar2 default null
152 ,p_attribute3 in varchar2 default null
153 ,p_attribute4 in varchar2 default null
154 ,p_attribute5 in varchar2 default null
155 ,p_attribute6 in varchar2 default null
156 ,p_attribute7 in varchar2 default null
157 ,p_attribute8 in varchar2 default null
158 ,p_attribute9 in varchar2 default null
159 ,p_attribute10 in varchar2 default null
160 ,p_attribute11 in varchar2 default null
161 ,p_attribute12 in varchar2 default null
162 ,p_attribute13 in varchar2 default null
163 ,p_attribute14 in varchar2 default null
164 ,p_attribute15 in varchar2 default null
165 ,p_attribute16 in varchar2 default null
166 ,p_attribute17 in varchar2 default null
167 ,p_attribute18 in varchar2 default null
168 ,p_attribute19 in varchar2 default null
169 ,p_attribute20 in varchar2 default null
170 ,p_attribute21 in varchar2 default null
171 ,p_attribute22 in varchar2 default null
172 ,p_attribute23 in varchar2 default null
173 ,p_attribute24 in varchar2 default null
174 ,p_attribute25 in varchar2 default null
175 ,p_attribute26 in varchar2 default null
176 ,p_attribute27 in varchar2 default null
177 ,p_attribute28 in varchar2 default null
178 ,p_attribute29 in varchar2 default null
179 ,p_attribute30 in varchar2 default null
180 ,p_information_category in varchar2 default null
181 ,p_information1 in varchar2 default null
182 ,p_information2 in varchar2 default null
183 ,p_information3 in varchar2 default null
184 ,p_information4 in varchar2 default null
185 ,p_information5 in varchar2 default null
186 ,p_information6 in varchar2 default null
187 ,p_information7 in varchar2 default null
188 ,p_information8 in varchar2 default null
189 ,p_information9 in varchar2 default null
190 ,p_information10 in varchar2 default null
191 ,p_information11 in varchar2 default null
192 ,p_information12 in varchar2 default null
193 ,p_information13 in varchar2 default null
194 ,p_information14 in varchar2 default null
195 ,p_information15 in varchar2 default null
196 ,p_information16 in varchar2 default null
197 ,p_information17 in varchar2 default null
198 ,p_information18 in varchar2 default null
199 ,p_information19 in varchar2 default null
200 ,p_information20 in varchar2 default null
201 ,p_information21 in varchar2 default null
202 ,p_information22 in varchar2 default null
203 ,p_information23 in varchar2 default null
204 ,p_information24 in varchar2 default null
205 ,p_information25 in varchar2 default null
206 ,p_information26 in varchar2 default null
207 ,p_information27 in varchar2 default null
208 ,p_information28 in varchar2 default null
209 ,p_information29 in varchar2 default null
210 ,p_information30 in varchar2 default null
211 ,p_effective_date in date
212 );
213 --
214 -- ----------------------------------------------------------------------------
215 -- |-----------------------------< update_hierarchy >-------------------------|
216 -- ----------------------------------------------------------------------------
217 --
218 -- {Start Of Comments}
219 /*#
220 * This API updates a generic hierarchy.
221 *
222 * Generic hierarchy provides the means to create and maintain a hierarchies of
223 * data, each of which can be given a name and a type and then populated with
224 * data from pre-defined value sets. The data can therefore be drawn from any
225 * areas of the HRMS system, based on the definition of the value sets that are
226 * being used for the hierarchy. Multiple dated versions of the hierarchy
227 * structure can be maintained.
228 *
229 * <p><b>Licensing</b><br>
230 * This API is licensed for use with Human Resources.
231 *
232 * <p><b>Prerequisites</b><br>
233 * The generic hierarchy to be updated must exist.
234 *
235 * <p><b>Post Success</b><br>
236 * The API updates the generic hierarchy.
237 *
238 * <p><b>Post Failure</b><br>
239 * The API does not update the generic hierarchy and raises an error.
240 * @param p_validate If true, then validation alone will be performed and the
241 * database will remain unchanged. If false and all validation checks pass,
242 * then the database will be modified.
243 * @param p_hierarchy_id Uniquely identifies the generic hierarchy to be
244 * updated.
245 * @param p_name The name of the generic hierarchy.
246 * @param p_request_id When the API is executed from a concurrent program set
247 * to the concurrent request identifier.
248 * @param p_program_application_id When the API is executed from a concurrent
249 * program set to the program's Application.
250 * @param p_program_id When the API is executed from a concurrent program set
251 * to the program's identifier.
252 * @param p_program_update_date When the API is executed from a concurrent
253 * program set to when the program was ran.
254 * @param p_object_version_number Pass in the current version number of the
255 * generic hierarchy to be updated. When the API completes if p_validate is
256 * false, will be set to the new version number of the updated generic
257 * hierarchy. If p_validate is true will be set to the same value which was
258 * passed in.
259 * @param p_attribute_category This context value determines which flexfield
260 * structure to use with the descriptive flexfield segments.
261 * @param p_attribute1 Descriptive flexfield segment.
262 * @param p_attribute2 Descriptive flexfield segment.
263 * @param p_attribute3 Descriptive flexfield segment.
264 * @param p_attribute4 Descriptive flexfield segment.
265 * @param p_attribute5 Descriptive flexfield segment.
266 * @param p_attribute6 Descriptive flexfield segment.
267 * @param p_attribute7 Descriptive flexfield segment.
268 * @param p_attribute8 Descriptive flexfield segment.
269 * @param p_attribute9 Descriptive flexfield segment.
270 * @param p_attribute10 Descriptive flexfield segment.
271 * @param p_attribute11 Descriptive flexfield segment.
272 * @param p_attribute12 Descriptive flexfield segment.
273 * @param p_attribute13 Descriptive flexfield segment.
274 * @param p_attribute14 Descriptive flexfield segment.
275 * @param p_attribute15 Descriptive flexfield segment.
276 * @param p_attribute16 Descriptive flexfield segment.
277 * @param p_attribute17 Descriptive flexfield segment.
278 * @param p_attribute18 Descriptive flexfield segment.
279 * @param p_attribute19 Descriptive flexfield segment.
280 * @param p_attribute20 Descriptive flexfield segment.
281 * @param p_attribute21 Descriptive flexfield segment.
282 * @param p_attribute22 Descriptive flexfield segment.
283 * @param p_attribute23 Descriptive flexfield segment.
284 * @param p_attribute24 Descriptive flexfield segment.
285 * @param p_attribute25 Descriptive flexfield segment.
286 * @param p_attribute26 Descriptive flexfield segment.
287 * @param p_attribute27 Descriptive flexfield segment.
288 * @param p_attribute28 Descriptive flexfield segment.
289 * @param p_attribute29 Descriptive flexfield segment.
290 * @param p_attribute30 Descriptive flexfield segment.
291 * @param p_information_category This context value determines which flexfield
292 * structure to use with the developer descriptive flexfield segments.
293 * @param p_information1 Developer descriptive flexfield segment.
294 * @param p_information2 Developer descriptive flexfield segment.
295 * @param p_information3 Developer descriptive flexfield segment.
296 * @param p_information4 Developer descriptive flexfield segment.
297 * @param p_information5 Developer descriptive flexfield segment.
298 * @param p_information6 Developer descriptive flexfield segment.
302 * @param p_information10 Developer descriptive flexfield segment.
299 * @param p_information7 Developer descriptive flexfield segment.
300 * @param p_information8 Developer descriptive flexfield segment.
301 * @param p_information9 Developer descriptive flexfield segment.
303 * @param p_information11 Developer descriptive flexfield segment.
304 * @param p_information12 Developer descriptive flexfield segment.
305 * @param p_information13 Developer descriptive flexfield segment.
306 * @param p_information14 Developer descriptive flexfield segment.
307 * @param p_information15 Developer descriptive flexfield segment.
308 * @param p_information16 Developer descriptive flexfield segment.
309 * @param p_information17 Developer descriptive flexfield segment.
310 * @param p_information18 Developer descriptive flexfield segment.
311 * @param p_information19 Developer descriptive flexfield segment.
312 * @param p_information20 Developer descriptive flexfield segment.
313 * @param p_information21 Developer descriptive flexfield segment.
314 * @param p_information22 Developer descriptive flexfield segment.
315 * @param p_information23 Developer descriptive flexfield segment.
316 * @param p_information24 Developer descriptive flexfield segment.
317 * @param p_information25 Developer descriptive flexfield segment.
318 * @param p_information26 Developer descriptive flexfield segment.
319 * @param p_information27 Developer descriptive flexfield segment.
320 * @param p_information28 Developer descriptive flexfield segment.
321 * @param p_information29 Developer descriptive flexfield segment.
322 * @param p_information30 Developer descriptive flexfield segment.
323 * @param p_effective_date Reference date for validating lookup values are
324 * applicable during the start to end active date range. This date does not
325 * determine when the changes take effect.
326 * @rep:displayname Update Generic Hierarchy
327 * @rep:category BUSINESS_ENTITY PER_GENERIC_HIERARCHY
328 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
329 * @rep:scope public
330 * @rep:lifecycle active
331 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
332 */
333 --
334 -- {End Of Comments}
335 --
336 procedure update_hierarchy
337 (
338 p_validate in boolean default false
339 ,p_hierarchy_id in number
340 ,p_name in varchar2 default hr_api.g_varchar2
341 ,p_request_id in number default hr_api.g_number
342 ,p_program_application_id in number default hr_api.g_number
343 ,p_program_id in number default hr_api.g_number
344 ,p_program_update_date in date default hr_api.g_date
345 ,p_object_version_number in out nocopy number
346 ,p_attribute_category in varchar2 default hr_api.g_varchar2
347 ,p_attribute1 in varchar2 default hr_api.g_varchar2
348 ,p_attribute2 in varchar2 default hr_api.g_varchar2
349 ,p_attribute3 in varchar2 default hr_api.g_varchar2
350 ,p_attribute4 in varchar2 default hr_api.g_varchar2
351 ,p_attribute5 in varchar2 default hr_api.g_varchar2
352 ,p_attribute6 in varchar2 default hr_api.g_varchar2
353 ,p_attribute7 in varchar2 default hr_api.g_varchar2
354 ,p_attribute8 in varchar2 default hr_api.g_varchar2
355 ,p_attribute9 in varchar2 default hr_api.g_varchar2
356 ,p_attribute10 in varchar2 default hr_api.g_varchar2
357 ,p_attribute11 in varchar2 default hr_api.g_varchar2
358 ,p_attribute12 in varchar2 default hr_api.g_varchar2
359 ,p_attribute13 in varchar2 default hr_api.g_varchar2
360 ,p_attribute14 in varchar2 default hr_api.g_varchar2
361 ,p_attribute15 in varchar2 default hr_api.g_varchar2
362 ,p_attribute16 in varchar2 default hr_api.g_varchar2
363 ,p_attribute17 in varchar2 default hr_api.g_varchar2
364 ,p_attribute18 in varchar2 default hr_api.g_varchar2
365 ,p_attribute19 in varchar2 default hr_api.g_varchar2
366 ,p_attribute20 in varchar2 default hr_api.g_varchar2
367 ,p_attribute21 in varchar2 default hr_api.g_varchar2
368 ,p_attribute22 in varchar2 default hr_api.g_varchar2
369 ,p_attribute23 in varchar2 default hr_api.g_varchar2
370 ,p_attribute24 in varchar2 default hr_api.g_varchar2
371 ,p_attribute25 in varchar2 default hr_api.g_varchar2
372 ,p_attribute26 in varchar2 default hr_api.g_varchar2
373 ,p_attribute27 in varchar2 default hr_api.g_varchar2
374 ,p_attribute28 in varchar2 default hr_api.g_varchar2
375 ,p_attribute29 in varchar2 default hr_api.g_varchar2
376 ,p_attribute30 in varchar2 default hr_api.g_varchar2
377 ,p_information_category in varchar2 default hr_api.g_varchar2
378 ,p_information1 in varchar2 default hr_api.g_varchar2
379 ,p_information2 in varchar2 default hr_api.g_varchar2
380 ,p_information3 in varchar2 default hr_api.g_varchar2
381 ,p_information4 in varchar2 default hr_api.g_varchar2
382 ,p_information5 in varchar2 default hr_api.g_varchar2
383 ,p_information6 in varchar2 default hr_api.g_varchar2
384 ,p_information7 in varchar2 default hr_api.g_varchar2
388 ,p_information11 in varchar2 default hr_api.g_varchar2
385 ,p_information8 in varchar2 default hr_api.g_varchar2
386 ,p_information9 in varchar2 default hr_api.g_varchar2
387 ,p_information10 in varchar2 default hr_api.g_varchar2
389 ,p_information12 in varchar2 default hr_api.g_varchar2
390 ,p_information13 in varchar2 default hr_api.g_varchar2
391 ,p_information14 in varchar2 default hr_api.g_varchar2
392 ,p_information15 in varchar2 default hr_api.g_varchar2
393 ,p_information16 in varchar2 default hr_api.g_varchar2
394 ,p_information17 in varchar2 default hr_api.g_varchar2
395 ,p_information18 in varchar2 default hr_api.g_varchar2
396 ,p_information19 in varchar2 default hr_api.g_varchar2
397 ,p_information20 in varchar2 default hr_api.g_varchar2
398 ,p_information21 in varchar2 default hr_api.g_varchar2
399 ,p_information22 in varchar2 default hr_api.g_varchar2
400 ,p_information23 in varchar2 default hr_api.g_varchar2
401 ,p_information24 in varchar2 default hr_api.g_varchar2
402 ,p_information25 in varchar2 default hr_api.g_varchar2
403 ,p_information26 in varchar2 default hr_api.g_varchar2
404 ,p_information27 in varchar2 default hr_api.g_varchar2
405 ,p_information28 in varchar2 default hr_api.g_varchar2
406 ,p_information29 in varchar2 default hr_api.g_varchar2
407 ,p_information30 in varchar2 default hr_api.g_varchar2
408 ,p_effective_date in date
409 );
410 --
411 -- ----------------------------------------------------------------------------
412 -- |-----------------------------< delete_hierarchy >-------------------------|
413 -- ----------------------------------------------------------------------------
414 --
415 -- {Start Of Comments}
416 /*#
417 * This API deletes a generic hierarchy.
418 *
419 * Generic hierarchy provides the means to create and maintain a hierarchies of
420 * data, each of which can be given a name and a type and then populated with
421 * data from pre-defined value sets. The data can therefore be drawn from any
422 * areas of the HRMS system, based on the definition of the value sets that are
423 * being used for the hierarchy. Multiple dated versions of the hierarchy
424 * structure can be maintained.
425 *
426 * <p><b>Licensing</b><br>
427 * This API is licensed for use with Human Resources.
428 *
429 * <p><b>Prerequisites</b><br>
430 * The generic hierarchy to be deleted must exist. There cannot be any generic
431 * hierarchy structure versions for the generic hierarchy to be deleted.
432 *
433 * <p><b>Post Success</b><br>
434 * The API deletes the generic hierarchy.
435 *
436 * <p><b>Post Failure</b><br>
437 * The API does not delete the generic hierarchy and an error is raised.
438 * @param p_validate If true, then validation alone will be performed and the
439 * database will remain unchanged. If false and all validation checks pass,
440 * then the database will be modified.
441 * @param p_hierarchy_id Uniquely identifies the generic hierarchy to be
442 * deleted.
443 * @param p_object_version_number Current version number of the generic
444 * hierarchy to be deleted.
445 * @rep:displayname Delete Generic Hierarchy
446 * @rep:category BUSINESS_ENTITY PER_GENERIC_HIERARCHY
447 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
448 * @rep:scope public
449 * @rep:lifecycle active
450 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
451 */
452 --
453 -- {End Of Comments}
454 --
455 procedure delete_hierarchy
456 (
457 p_validate in boolean default false
458 ,p_hierarchy_id in number
459 ,p_object_version_number in out nocopy number
460 );
461 --
462 -- ----------------------------------------------------------------------------
463 -- |----------------------------------< lck >---------------------------------|
464 -- ----------------------------------------------------------------------------
465 -- {Start Of Comments}
466 --
467 -- Description:
468 --
469 -- Prerequisites:
470 --
471 --
472 -- In Parameters:
473 -- Name Reqd Type Description
474 -- p_hierarchy_id Yes number PK of record
475 -- p_object_version_number Yes number OVN of record
476 --
477 -- Post Success:
478 --
479 -- Name Type Description
480 --
481 -- Post Failure:
482 --
483 -- Access Status:
484 -- Public.
485 --
486 -- {End Of Comments}
487 --
488 procedure lck
489 (
490 p_hierarchy_id in number
491 ,p_object_version_number in number
492 );
493 --
494 end per_hierarchy_api;
[Home] [Help]