1 Package hr_sit_api as
2 /* $Header: pesitapi.pkh 120.2.12010000.1 2008/07/28 05:57:54 appldev ship $ */
3 /*#
4 * This package contains APIs which create and maintain special information
5 * types.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Special Information Type
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------------< create_sit >----------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a special information record for a person.
18 *
19 * This API creates a special information type which is an additional set of
20 * structured data captured for a person, implemented by means of an instance
21 * of the per person analysis key flexfield. An example may be the use of
22 * special information types to hold medical details or disciplinary records
23 * for a person. This special information types prove a flexible means to
24 * capture multiple additional types of data about a person, beyond that stored
25 * directly on the person record. Special information types are comprised of
26 * component fields or segments, organised as predefined structures, and
27 * validation logic may be attached to each segment to ensure the data held for
28 * the information type for the person is valid.
29 *
30 * <p><b>Licensing</b><br>
31 * This API is licensed for use with Human Resources.
32 *
33 * <p><b>Prerequisites</b><br>
34 * The person for whom the special information type is to be created must
35 * exist. The structure of the special information type to be created must have
36 * been defined previously.
37 *
38 * <p><b>Post Success</b><br>
39 * A special information record is created for the person.
40 *
41 * <p><b>Post Failure</b><br>
42 * The API does not create the special information record for the person and
43 * raises an error.
44 * @param p_validate If true, then validation alone will be performed and the
45 * database will remain unchanged. If false and all validation checks pass,
46 * then the database will be modified.
47 * @param p_person_id Uniquely identifies the person for whom the special
48 * information applies.
49 * @param p_business_group_id Uniquely identifies the business group.
50 * @param p_id_flex_num Uniquely identifies the special information type
51 * structure of the key flexfield.
52 * @param p_effective_date Reference date for validating lookup values are
53 * applicable during the start to end active date range. This date does not
54 * determine when the changes take effect.
55 * @param p_comments Comment text.
56 * @param p_date_from The date the special information type is valid from.
57 * @param p_date_to The date the special information type is valid until.
58 * @param p_request_id When the API is executed from a concurrent program set
59 * to the concurrent request identifier.
60 * @param p_program_application_id When the API is executed from a concurrent
61 * program set to the program's Application.
62 * @param p_program_id When the API is executed from a concurrent program set
63 * to the program's identifier.
64 * @param p_program_update_date When the API is executed from a concurrent
65 * program set to when the program was ran.
66 * @param p_attribute_category This context value determines which flexfield
67 * structure to use with the descriptive flexfield segments.
68 * @param p_attribute1 Descriptive flexfield segment.
69 * @param p_attribute2 Descriptive flexfield segment.
70 * @param p_attribute3 Descriptive flexfield segment.
71 * @param p_attribute4 Descriptive flexfield segment.
72 * @param p_attribute5 Descriptive flexfield segment.
73 * @param p_attribute6 Descriptive flexfield segment.
74 * @param p_attribute7 Descriptive flexfield segment.
75 * @param p_attribute8 Descriptive flexfield segment.
76 * @param p_attribute9 Descriptive flexfield segment.
77 * @param p_attribute10 Descriptive flexfield segment.
78 * @param p_attribute11 Descriptive flexfield segment.
79 * @param p_attribute12 Descriptive flexfield segment.
80 * @param p_attribute13 Descriptive flexfield segment.
81 * @param p_attribute14 Descriptive flexfield segment.
82 * @param p_attribute15 Descriptive flexfield segment.
83 * @param p_attribute16 Descriptive flexfield segment.
84 * @param p_attribute17 Descriptive flexfield segment.
85 * @param p_attribute18 Descriptive flexfield segment.
86 * @param p_attribute19 Descriptive flexfield segment.
87 * @param p_attribute20 Descriptive flexfield segment.
88 * @param p_segment1 Component of the special information type for the person.
89 * @param p_segment2 Component of the special information type for the person.
90 * @param p_segment3 Component of the special information type for the person.
91 * @param p_segment4 Component of the special information type for the person.
92 * @param p_segment5 Component of the special information type for the person.
93 * @param p_segment6 Component of the special information type for the person.
94 * @param p_segment7 Component of the special information type for the person.
95 * @param p_segment8 Component of the special information type for the person.
96 * @param p_segment9 Component of the special information type for the person.
97 * @param p_segment10 Component of the special information type for the person.
98 * @param p_segment11 Component of the special information type for the person.
99 * @param p_segment12 Component of the special information type for the person.
100 * @param p_segment13 Component of the special information type for the person.
101 * @param p_segment14 Component of the special information type for the person.
102 * @param p_segment15 Component of the special information type for the person.
103 * @param p_segment16 Component of the special information type for the person.
104 * @param p_segment17 Component of the special information type for the person.
105 * @param p_segment18 Component of the special information type for the person.
106 * @param p_segment19 Component of the special information type for the person.
107 * @param p_segment20 Component of the special information type for the person.
108 * @param p_segment21 Component of the special information type for the person.
109 * @param p_segment22 Component of the special information type for the person.
110 * @param p_segment23 Component of the special information type for the person.
111 * @param p_segment24 Component of the special information type for the person.
112 * @param p_segment25 Component of the special information type for the person.
113 * @param p_segment26 Component of the special information type for the person.
114 * @param p_segment27 Component of the special information type for the person.
115 * @param p_segment28 Component of the special information type for the person.
116 * @param p_segment29 Component of the special information type for the person.
117 * @param p_segment30 Component of the special information type for the person.
118 * @param p_concat_segments The concatenation of all segment values for the
119 * special information type.
120 * @param p_analysis_criteria_id Uniquely identifies the analysis criteria
121 * record holding the details for the special information type (person
122 * analysis).
123 * @param p_person_analysis_id If p_validate is false, uniquely identifies the
124 * person analysis (information type) for the person. if p_validate is true,
125 * set to null.
126 * @param p_pea_object_version_number If p_validate is false, set to the
127 * version number of the person analysis created. If p_validate is true, set to
128 * null.
129 * @rep:displayname Create Special Information Type
130 * @rep:category BUSINESS_ENTITY HR_PERSON
131 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
132 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
133 * @rep:scope public
134 * @rep:lifecycle active
135 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
136 */
137 --
138 -- {End Of Comments}
139 --
140 procedure create_sit
141 (p_validate in boolean default false
142 ,p_person_id in number
143 ,p_business_group_id in number
144 ,p_id_flex_num in number
145 ,p_effective_date in date
146 ,p_comments in varchar2 default null
147 ,p_date_from in date default null
148 ,p_date_to in date default null
149 ,p_request_id in number default null
150 ,p_program_application_id in number default null
151 ,p_program_id in number default null
152 ,p_program_update_date in date default null
153 ,p_attribute_category in varchar2 default null
154 ,p_attribute1 in varchar2 default null
155 ,p_attribute2 in varchar2 default null
156 ,p_attribute3 in varchar2 default null
157 ,p_attribute4 in varchar2 default null
158 ,p_attribute5 in varchar2 default null
159 ,p_attribute6 in varchar2 default null
160 ,p_attribute7 in varchar2 default null
161 ,p_attribute8 in varchar2 default null
162 ,p_attribute9 in varchar2 default null
163 ,p_attribute10 in varchar2 default null
164 ,p_attribute11 in varchar2 default null
165 ,p_attribute12 in varchar2 default null
166 ,p_attribute13 in varchar2 default null
167 ,p_attribute14 in varchar2 default null
168 ,p_attribute15 in varchar2 default null
169 ,p_attribute16 in varchar2 default null
170 ,p_attribute17 in varchar2 default null
171 ,p_attribute18 in varchar2 default null
172 ,p_attribute19 in varchar2 default null
173 ,p_attribute20 in varchar2 default null
174 ,p_segment1 in varchar2 default null
175 ,p_segment2 in varchar2 default null
176 ,p_segment3 in varchar2 default null
177 ,p_segment4 in varchar2 default null
178 ,p_segment5 in varchar2 default null
179 ,p_segment6 in varchar2 default null
180 ,p_segment7 in varchar2 default null
181 ,p_segment8 in varchar2 default null
182 ,p_segment9 in varchar2 default null
183 ,p_segment10 in varchar2 default null
184 ,p_segment11 in varchar2 default null
185 ,p_segment12 in varchar2 default null
186 ,p_segment13 in varchar2 default null
187 ,p_segment14 in varchar2 default null
188 ,p_segment15 in varchar2 default null
189 ,p_segment16 in varchar2 default null
190 ,p_segment17 in varchar2 default null
191 ,p_segment18 in varchar2 default null
192 ,p_segment19 in varchar2 default null
193 ,p_segment20 in varchar2 default null
194 ,p_segment21 in varchar2 default null
195 ,p_segment22 in varchar2 default null
196 ,p_segment23 in varchar2 default null
197 ,p_segment24 in varchar2 default null
198 ,p_segment25 in varchar2 default null
199 ,p_segment26 in varchar2 default null
200 ,p_segment27 in varchar2 default null
201 ,p_segment28 in varchar2 default null
202 ,p_segment29 in varchar2 default null
203 ,p_segment30 in varchar2 default null
204 ,p_concat_segments in varchar2 default null
205 ,p_analysis_criteria_id in out nocopy number
206 ,p_person_analysis_id out nocopy number
207 ,p_pea_object_version_number out nocopy number
208 );
209 --
210 -- ----------------------------------------------------------------------------
211 -- |--------------------------------< update_sit >----------------------------|
212 -- ----------------------------------------------------------------------------
213 --
214 -- {Start Of Comments}
215 /*#
216 * This API updates a special information type for a person.
217 *
218 * This API updates a special information type which is an additional set of
219 * structured data captured for a person, implemented by means of an instance
220 * of the per person analysis key flexfield. An example may be the use of
221 * special information types to hold medical details or disciplinary records
222 * for a person. This special information types prove a flexible means to
223 * capture multiple additional types of data about a person, beyond that stored
224 * directly on the person record. Special information types are comprised of
225 * component fields or segments, organised as predefined structures, and
226 * validation logic may be attached to each segment to ensure the data held for
227 * the information type for the person is valid.
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 person to whom the special information type is to be updated must exist.
234 * The structure of the special information type to be updated must have been
235 * defined previously.
236 *
237 * <p><b>Post Success</b><br>
238 * The special information record is updated.
239 *
240 * <p><b>Post Failure</b><br>
241 * API does not update a special information record and raises an error.
242 * @param p_validate If true, then validation alone will be performed and the
243 * database will remain unchanged. If false and all validation checks pass,
244 * then the database will be modified.
245 * @param p_person_analysis_id Uniquely identifies the person analysis
246 * (information type) for the person.
247 * @param p_pea_object_version_number If p_validate is false, set to the
248 * version number of the person analysis updated. If p_validate is true, set to
249 * the supplied value.
250 * @param p_comments Comment text.
251 * @param p_date_from The date the special information type is valid from.
252 * @param p_date_to The date the special information type is valid until.
253 * @param p_request_id When the API is executed from a concurrent program set
254 * to the concurrent request identifier.
255 * @param p_program_application_id When the API is executed from a concurrent
256 * program set to the program's Application.
257 * @param p_program_id When the API is executed from a concurrent program set
258 * to the program's identifier.
259 * @param p_program_update_date When the API is executed from a concurrent
260 * program set to when the program was ran.
261 * @param p_attribute_category This context value determines which flexfield
262 * structure to use with the descriptive flexfield segments.
263 * @param p_attribute1 Descriptive flexfield segment.
264 * @param p_attribute2 Descriptive flexfield segment.
265 * @param p_attribute3 Descriptive flexfield segment.
266 * @param p_attribute4 Descriptive flexfield segment.
267 * @param p_attribute5 Descriptive flexfield segment.
268 * @param p_attribute6 Descriptive flexfield segment.
269 * @param p_attribute7 Descriptive flexfield segment.
270 * @param p_attribute8 Descriptive flexfield segment.
271 * @param p_attribute9 Descriptive flexfield segment.
272 * @param p_attribute10 Descriptive flexfield segment.
273 * @param p_attribute11 Descriptive flexfield segment.
274 * @param p_attribute12 Descriptive flexfield segment.
275 * @param p_attribute13 Descriptive flexfield segment.
276 * @param p_attribute14 Descriptive flexfield segment.
277 * @param p_attribute15 Descriptive flexfield segment.
278 * @param p_attribute16 Descriptive flexfield segment.
279 * @param p_attribute17 Descriptive flexfield segment.
280 * @param p_attribute18 Descriptive flexfield segment.
281 * @param p_attribute19 Descriptive flexfield segment.
282 * @param p_attribute20 Descriptive flexfield segment.
283 * @param p_segment1 Component of the special information type for the person.
284 * @param p_segment2 Component of the special information type for the person.
285 * @param p_segment3 Component of the special information type for the person.
286 * @param p_segment4 Component of the special information type for the person.
287 * @param p_segment5 Component of the special information type for the person.
288 * @param p_segment6 Component of the special information type for the person.
289 * @param p_segment7 Component of the special information type for the person.
290 * @param p_segment8 Component of the special information type for the person.
291 * @param p_segment9 Component of the special information type for the person.
292 * @param p_segment10 Component of the special information type for the person.
296 * @param p_segment14 Component of the special information type for the person.
293 * @param p_segment11 Component of the special information type for the person.
294 * @param p_segment12 Component of the special information type for the person.
295 * @param p_segment13 Component of the special information type for the person.
297 * @param p_segment15 Component of the special information type for the person.
298 * @param p_segment16 Component of the special information type for the person.
299 * @param p_segment17 Component of the special information type for the person.
300 * @param p_segment18 Component of the special information type for the person.
301 * @param p_segment19 Component of the special information type for the person.
302 * @param p_segment20 Component of the special information type for the person.
303 * @param p_segment21 Component of the special information type for the person.
304 * @param p_segment22 Component of the special information type for the person.
305 * @param p_segment23 Component of the special information type for the person.
306 * @param p_segment24 Component of the special information type for the person.
307 * @param p_segment25 Component of the special information type for the person.
308 * @param p_segment26 Component of the special information type for the person.
309 * @param p_segment27 Component of the special information type for the person.
310 * @param p_segment28 Component of the special information type for the person.
311 * @param p_segment29 Component of the special information type for the person.
312 * @param p_segment30 Component of the special information type for the person.
313 * @param p_concat_segments The concatenation of all segment values for the
314 * special information type.
315 * @param p_analysis_criteria_id If p_validate is false, uniquely identifies
316 * the combination of segments passed. If p_validate is true, set to supplied
317 * value. (It derives segment values from the analysis criteria).
318 * @rep:displayname Update Special Information Type
319 * @rep:category BUSINESS_ENTITY HR_PERSON
320 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
321 * @rep:scope public
322 * @rep:lifecycle active
323 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
324 */
325 --
326 -- {End Of Comments}
327 --
328 procedure update_sit
329 (p_validate in boolean default false
330 ,p_person_analysis_id in number
331 ,p_pea_object_version_number in out nocopy number
332 ,p_comments in varchar2 default hr_api.g_varchar2
333 ,p_date_from in date default hr_api.g_date
334 ,p_date_to in date default hr_api.g_date
335 ,p_request_id in number default hr_api.g_number
336 ,p_program_application_id in number default hr_api.g_number
337 ,p_program_id in number default hr_api.g_number
338 ,p_program_update_date in date default hr_api.g_date
339 ,p_attribute_category in varchar2 default hr_api.g_varchar2
340 ,p_attribute1 in varchar2 default hr_api.g_varchar2
341 ,p_attribute2 in varchar2 default hr_api.g_varchar2
342 ,p_attribute3 in varchar2 default hr_api.g_varchar2
343 ,p_attribute4 in varchar2 default hr_api.g_varchar2
344 ,p_attribute5 in varchar2 default hr_api.g_varchar2
345 ,p_attribute6 in varchar2 default hr_api.g_varchar2
346 ,p_attribute7 in varchar2 default hr_api.g_varchar2
347 ,p_attribute8 in varchar2 default hr_api.g_varchar2
348 ,p_attribute9 in varchar2 default hr_api.g_varchar2
349 ,p_attribute10 in varchar2 default hr_api.g_varchar2
350 ,p_attribute11 in varchar2 default hr_api.g_varchar2
351 ,p_attribute12 in varchar2 default hr_api.g_varchar2
352 ,p_attribute13 in varchar2 default hr_api.g_varchar2
353 ,p_attribute14 in varchar2 default hr_api.g_varchar2
354 ,p_attribute15 in varchar2 default hr_api.g_varchar2
355 ,p_attribute16 in varchar2 default hr_api.g_varchar2
356 ,p_attribute17 in varchar2 default hr_api.g_varchar2
357 ,p_attribute18 in varchar2 default hr_api.g_varchar2
358 ,p_attribute19 in varchar2 default hr_api.g_varchar2
359 ,p_attribute20 in varchar2 default hr_api.g_varchar2
360 ,p_segment1 in varchar2 default hr_api.g_varchar2
361 ,p_segment2 in varchar2 default hr_api.g_varchar2
362 ,p_segment3 in varchar2 default hr_api.g_varchar2
363 ,p_segment4 in varchar2 default hr_api.g_varchar2
364 ,p_segment5 in varchar2 default hr_api.g_varchar2
365 ,p_segment6 in varchar2 default hr_api.g_varchar2
366 ,p_segment7 in varchar2 default hr_api.g_varchar2
367 ,p_segment8 in varchar2 default hr_api.g_varchar2
368 ,p_segment9 in varchar2 default hr_api.g_varchar2
369 ,p_segment10 in varchar2 default hr_api.g_varchar2
370 ,p_segment11 in varchar2 default hr_api.g_varchar2
371 ,p_segment12 in varchar2 default hr_api.g_varchar2
372 ,p_segment13 in varchar2 default hr_api.g_varchar2
373 ,p_segment14 in varchar2 default hr_api.g_varchar2
374 ,p_segment15 in varchar2 default hr_api.g_varchar2
375 ,p_segment16 in varchar2 default hr_api.g_varchar2
376 ,p_segment17 in varchar2 default hr_api.g_varchar2
380 ,p_segment21 in varchar2 default hr_api.g_varchar2
377 ,p_segment18 in varchar2 default hr_api.g_varchar2
378 ,p_segment19 in varchar2 default hr_api.g_varchar2
379 ,p_segment20 in varchar2 default hr_api.g_varchar2
381 ,p_segment22 in varchar2 default hr_api.g_varchar2
382 ,p_segment23 in varchar2 default hr_api.g_varchar2
383 ,p_segment24 in varchar2 default hr_api.g_varchar2
384 ,p_segment25 in varchar2 default hr_api.g_varchar2
385 ,p_segment26 in varchar2 default hr_api.g_varchar2
386 ,p_segment27 in varchar2 default hr_api.g_varchar2
387 ,p_segment28 in varchar2 default hr_api.g_varchar2
388 ,p_segment29 in varchar2 default hr_api.g_varchar2
389 ,p_segment30 in varchar2 default hr_api.g_varchar2
390 ,p_concat_segments in varchar2 default hr_api.g_varchar2
391 ,p_analysis_criteria_id in out nocopy number
392 );
393 --
394 -- ----------------------------------------------------------------------------
395 -- |--------------------------------< delete_sit >----------------------------|
396 -- ----------------------------------------------------------------------------
397 --
398 -- {Start Of Comments}
399 /*#
400 * This API deletes a special information type for a person.
401 *
402 * This API deletes a special information type which is an additional set of
403 * structured data captured for a person, implemented by means of an instance
404 * of the per person analyses key flexfield. An example may be the use of
405 * special information types to hold medical details or disciplinary records
406 * for a person. This special information types prove a flexible means to
407 * capture multiple additional types of data about a person, beyond that stored
408 * directly on the person record. Special information types are comprised of
409 * component fields or segments, organised as predefined structures, and
410 * validation logic may be attached to each segment to ensure the data held for
411 * the information type for the person is valid.
412 *
413 * <p><b>Licensing</b><br>
414 * This API is licensed for use with Human Resources.
415 *
416 * <p><b>Prerequisites</b><br>
417 * The special information type specified must exist.
418 *
419 * <p><b>Post Success</b><br>
420 * The API deletes the special information type record.
421 *
422 * <p><b>Post Failure</b><br>
423 * The API does not delete the special information type and raises an error.
424 * @param p_validate If true, then validation alone will be performed and the
425 * database will remain unchanged. If false and all validation checks pass,
426 * then the database will be modified.
427 * @param p_person_analysis_id The identifier of the special information type
428 * to be deleted.
429 * @param p_pea_object_version_number Current version number of the special
430 * information type (per person analysis) to be deleted.
431 * @rep:displayname Delete Special Information Type
432 * @rep:category BUSINESS_ENTITY HR_PERSON
433 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
434 * @rep:scope public
435 * @rep:lifecycle active
436 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
437 */
438 --
439 -- {End Of Comments}
440 --
441 procedure delete_sit
442 (p_validate in boolean default false
443 ,p_person_analysis_id in number
444 ,p_pea_object_version_number in number
445 );
446 --
447
448 -- ----------------------------------------------------------------------------
449 -- |----------------------------< lck >------------------------------|
450 -- ----------------------------------------------------------------------------
451 -- {Start Of Comments}
452 --
453 -- Description:
454 -- This API locks a SIT record on the PER_PERSON_ANALYSES table.
455 --
456 -- Prerequisites:
457 -- The SIT specified by p_perosn_analysis_id and p_pea_object_version_number
458 -- must exist.
459 --
460 -- In Parameters:
461 -- Name Reqd Type Description
462 -- p_person_analysis_id Y number Person Analysis id.
463 -- p_pea_object_version_number Y number Version number of the SIT
464 -- record on PER_PERSON_ANALYSIS
465 -- not that of
466 -- PER_ANALYSIS_CRITERIA
467 -- Post Success:
468 -- The API locks the SIT record.
469 --
470 -- Post Failure:
471 -- The API does not lock the SIT and raises an error.
472 --
473 -- Access Status:
474 -- Public.
475 --
479 (p_person_analysis_id in number
476 -- {End Of Comments}
477 --
478 procedure lck
480 ,p_pea_object_version_number in number
481 );
482 --
483
484
485
486 end HR_SIT_API;
[Home] [Help]