1 Package hr_document_extra_info_api AUTHID CURRENT_USER as
2 /* $Header: hrdeiapi.pkh 120.9 2010/04/07 11:40:59 tkghosh ship $ */
3 /*#
4 * This package contains procedures to create/update/delete the document of
5 * record for a person.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Person Document API
9 */
10 --
11 -- -----------------------------------------------------------------------------------
12 -- |--------------------------< create_doc_extra_info >--------------------------|
13 -- -----------------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a document of record for a person.
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resource.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A person must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * A document of record will be created.
27 *
28 * <p><b>Post Failure</b><br>
29 * A document of record will not be created and an error will be raised.
30 *
31 * @param p_validate If true, then validation alone will be performed and
32 * the database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_person_id Identifies the person for whom you create
35 * the document extra information record.
36 * @param p_document_type_id Identifies the document type of the document
37 * to be created.
38 * @param p_date_from Document is valid from which date
39 * @param p_date_to Document is valid till which date
40 * @param p_document_number Identifies the Document number of the document.
41 * @param p_issued_by Identifies the person who issues the document.
42 * @param p_issued_at Identifies the location where the document is issued.
43 * @param p_issued_date Identifies the date when the document is issued.
44 * @param p_issuing_authority Identifies the Issuing Authority of the
45 * document.
46 * @param p_verified_by Identfies the person who verifies the document.
47 * @param p_verified_date Identifies the date when the document is verified.
48 * @param p_related_object_name Identifies the Related Object Name
49 * @param p_related_object_id_col Identifies the Related Object Id Column of
50 * the document
51 * @param p_related_object_id Identfies the Related Object Id of the document.
52 * @param p_dei_attribute_category This context value determines which
53 * flexfield structure to use with the descriptive flexfield segments.
54 * @param p_dei_attribute1 Descriptive flexfield segment
55 * @param p_dei_attribute2 Descriptive flexfield segment
56 * @param p_dei_attribute3 Descriptive flexfield segment
57 * @param p_dei_attribute4 Descriptive flexfield segment
58 * @param p_dei_attribute5 Descriptive flexfield segment
62 * @param p_dei_attribute9 Descriptive flexfield segment
59 * @param p_dei_attribute6 Descriptive flexfield segment
60 * @param p_dei_attribute7 Descriptive flexfield segment
61 * @param p_dei_attribute8 Descriptive flexfield segment
63 * @param p_dei_attribute10 Descriptive flexfield segment
64 * @param p_dei_attribute11 Descriptive flexfield segment
65 * @param p_dei_attribute12 Descriptive flexfield segment
66 * @param p_dei_attribute13 Descriptive flexfield segment
67 * @param p_dei_attribute14 Descriptive flexfield segment
68 * @param p_dei_attribute15 Descriptive flexfield segment
69 * @param p_dei_attribute16 Descriptive flexfield segment
70 * @param p_dei_attribute17 Descriptive flexfield segment
71 * @param p_dei_attribute18 Descriptive flexfield segment
72 * @param p_dei_attribute19 Descriptive flexfield segment
73 * @param p_dei_attribute20 Descriptive flexfield segment
74 * @param p_dei_attribute21 Descriptive flexfield segment
75 * @param p_dei_attribute22 Descriptive flexfield segment
76 * @param p_dei_attribute23 Descriptive flexfield segment
77 * @param p_dei_attribute24 Descriptive flexfield segment
78 * @param p_dei_attribute25 Descriptive flexfield segment
79 * @param p_dei_attribute26 Descriptive flexfield segment
80 * @param p_dei_attribute27 Descriptive flexfield segment
81 * @param p_dei_attribute28 Descriptive flexfield segment
82 * @param p_dei_attribute29 Descriptive flexfield segment
83 * @param p_dei_attribute30 Descriptive flexfield segment
84 * @param p_dei_information_category This context value determines which
85 * flexfield structure to use with the developer descriptive flexfield segments
86 * @param p_dei_information1 Developer Descriptive flexfield segment
87 * @param p_dei_information2 Developer Descriptive flexfield segment
88 * @param p_dei_information3 Developer Descriptive flexfield segment
89 * @param p_dei_information4 Developer Descriptive flexfield segment
90 * @param p_dei_information5 Developer Descriptive flexfield segment
91 * @param p_dei_information6 Developer Descriptive flexfield segment
92 * @param p_dei_information7 Developer Descriptive flexfield segment
93 * @param p_dei_information8 Developer Descriptive flexfield segment
94 * @param p_dei_information9 Developer Descriptive flexfield segment
95 * @param p_dei_information10 Developer Descriptive flexfield segment
96 * @param p_dei_information11 Developer Descriptive flexfield segment
97 * @param p_dei_information12 Developer Descriptive flexfield segment
98 * @param p_dei_information13 Developer Descriptive flexfield segment
99 * @param p_dei_information14 Developer Descriptive flexfield segment
100 * @param p_dei_information15 Developer Descriptive flexfield segment
101 * @param p_dei_information16 Developer Descriptive flexfield segment
102 * @param p_dei_information17 Developer Descriptive flexfield segment
103 * @param p_dei_information18 Developer Descriptive flexfield segment
104 * @param p_dei_information19 Developer Descriptive flexfield segment
105 * @param p_dei_information20 Developer Descriptive flexfield segment
106 * @param p_dei_information21 Developer Descriptive flexfield segment
107 * @param p_dei_information22 Developer Descriptive flexfield segment
108 * @param p_dei_information23 Developer Descriptive flexfield segment
109 * @param p_dei_information24 Developer Descriptive flexfield segment
110 * @param p_dei_information25 Developer Descriptive flexfield segment
111 * @param p_dei_information26 Developer Descriptive flexfield segment
112 * @param p_dei_information27 Developer Descriptive flexfield segment
113 * @param p_dei_information28 Developer Descriptive flexfield segment
114 * @param p_dei_information29 Developer Descriptive flexfield segment
115 * @param p_dei_information30 Developer Descriptive flexfield segment
116 * @param p_request_id When the API is executed from a concurrent program
117 * set to the concurrent request identifier.
118 * @param p_program_application_id When the API is executed from a
119 * concurrent program set to the program's Application.
120 * @param p_program_id When the API is executed from a concurrent program
121 * set to the program's identifier.
122 * @param p_program_update_date When the API is executed from a concurrent
123 * program set to when the program was ran.
124 * @param p_document_extra_info_id If p_validate is false, then this
125 * uniquely identifies the document extra info created.If p_validate is true,
126 * then set to null.
127 * @param p_object_version_number If p_validate is false, then set to the
128 * version number of the created document extra information. If p_validate is
129 * true,then the value will be null.
130 * @rep:displayname Create Person Document
131 * @rep:category BUSINESS_ENTITY HR_PERSON
132 * @rep:lifecycle active
133 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
134 * @rep:scope public
135 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
136 */
137 --
138 -- {End Of Comments}
139 --
140 procedure create_doc_extra_info(
141 p_validate in boolean default false
142 ,p_person_id in number
143 ,p_document_type_id in number
144 ,p_date_from in date
145 ,p_date_to in date default null
146 ,p_document_number in varchar2 default null
147 ,p_issued_by in varchar2 default null
148 ,p_issued_at in varchar2 default null
149 ,p_issued_date in date default null
150 ,p_issuing_authority in varchar2 default null
151 ,p_verified_by in number default null
152 ,p_verified_date in date default null
153 ,p_related_object_name in varchar2 default null
154 ,p_related_object_id_col in varchar2 default null
155 ,p_related_object_id in number default null
159 ,p_dei_attribute3 in varchar2 default null
156 ,p_dei_attribute_category in varchar2 default null
157 ,p_dei_attribute1 in varchar2 default null
158 ,p_dei_attribute2 in varchar2 default null
160 ,p_dei_attribute4 in varchar2 default null
161 ,p_dei_attribute5 in varchar2 default null
162 ,p_dei_attribute6 in varchar2 default null
163 ,p_dei_attribute7 in varchar2 default null
164 ,p_dei_attribute8 in varchar2 default null
165 ,p_dei_attribute9 in varchar2 default null
166 ,p_dei_attribute10 in varchar2 default null
167 ,p_dei_attribute11 in varchar2 default null
168 ,p_dei_attribute12 in varchar2 default null
169 ,p_dei_attribute13 in varchar2 default null
170 ,p_dei_attribute14 in varchar2 default null
171 ,p_dei_attribute15 in varchar2 default null
172 ,p_dei_attribute16 in varchar2 default null
173 ,p_dei_attribute17 in varchar2 default null
174 ,p_dei_attribute18 in varchar2 default null
175 ,p_dei_attribute19 in varchar2 default null
176 ,p_dei_attribute20 in varchar2 default null
177 ,p_dei_attribute21 in varchar2 default null
178 ,p_dei_attribute22 in varchar2 default null
179 ,p_dei_attribute23 in varchar2 default null
180 ,p_dei_attribute24 in varchar2 default null
181 ,p_dei_attribute25 in varchar2 default null
182 ,p_dei_attribute26 in varchar2 default null
183 ,p_dei_attribute27 in varchar2 default null
184 ,p_dei_attribute28 in varchar2 default null
185 ,p_dei_attribute29 in varchar2 default null
186 ,p_dei_attribute30 in varchar2 default null
187 ,p_dei_information_category in varchar2 default null
188 ,p_dei_information1 in varchar2 default null
189 ,p_dei_information2 in varchar2 default null
190 ,p_dei_information3 in varchar2 default null
191 ,p_dei_information4 in varchar2 default null
192 ,p_dei_information5 in varchar2 default null
193 ,p_dei_information6 in varchar2 default null
194 ,p_dei_information7 in varchar2 default null
195 ,p_dei_information8 in varchar2 default null
196 ,p_dei_information9 in varchar2 default null
197 ,p_dei_information10 in varchar2 default null
198 ,p_dei_information11 in varchar2 default null
199 ,p_dei_information12 in varchar2 default null
200 ,p_dei_information13 in varchar2 default null
201 ,p_dei_information14 in varchar2 default null
202 ,p_dei_information15 in varchar2 default null
203 ,p_dei_information16 in varchar2 default null
204 ,p_dei_information17 in varchar2 default null
205 ,p_dei_information18 in varchar2 default null
206 ,p_dei_information19 in varchar2 default null
207 ,p_dei_information20 in varchar2 default null
208 ,p_dei_information21 in varchar2 default null
209 ,p_dei_information22 in varchar2 default null
210 ,p_dei_information23 in varchar2 default null
211 ,p_dei_information24 in varchar2 default null
212 ,p_dei_information25 in varchar2 default null
213 ,p_dei_information26 in varchar2 default null
214 ,p_dei_information27 in varchar2 default null
215 ,p_dei_information28 in varchar2 default null
216 ,p_dei_information29 in varchar2 default null
217 ,p_dei_information30 in varchar2 default null
218 ,p_request_id in number default null
219 ,p_program_application_id in number default null
220 ,p_program_id in number default null
221 ,p_program_update_date in date default null
222 ,p_document_extra_info_id out nocopy number
223 ,p_object_version_number out nocopy number
224 );
225 --
226 -- ----------------------------------------------------------------------------
227 -- |-------------------------< update_doc_extra_info >---------------------|
228 -- ----------------------------------------------------------------------------
229 --
230 -- {Start Of Comments}
231 /*#
232 * This API updates the document of record for a person.
233 *
234 * <p><b>Licensing</b><br>
235 * This API is licensed for use with Human Resource
236 *
237 * <p><b>Prerequisites</b><br>
238 * Document of record must exist for a person.
239 *
240 * <p><b>Post Success</b><br>
241 * The document of record will be updated.
242 *
243 * <p><b>Post Failure</b><br>
244 * The document of record will not be updated and an error will be raised.
245 *
246 * @param p_validate If true, then validation alone will be performed and
247 * the database will remain unchanged. If false and all validation checks pass,
248 * then the database will be modified.
249 * @param p_document_extra_info_id Identifies the document record to modify.
250 * @param p_person_id Identifies the person record for which the document is
251 * to be modified.
252 * @param p_document_type_id Identifies the document type of the document to
253 * modify.
254 * @param p_date_from Document is valid from which date
255 * @param p_date_to Document is valid till which date
259 * @param p_issued_date Identifies the date when the document is issued.
256 * @param p_document_number Identifies the Document Number of the document.
257 * @param p_issued_by Identifies the person who issues the document.
258 * @param p_issued_at Identifies the location where the document is issued.
260 * @param p_issuing_authority Identifies the Issuing Authority of the document.
261 * @param p_verified_by Identfies the person who verifies the document.
262 * @param p_verified_date Identifies the date when the document is verified.
263 * @param p_related_object_name Identifies the Related Object Name.
264 * @param p_related_object_id_col Identifies the Related Object Id Column
265 * of the document.
266 * @param p_related_object_id Identfies the Related Object Id of the document.
267 * @param p_dei_attribute_category This context value determines which
268 * flexfield structure to use with the descriptive flexfield segments.
269 * @param p_dei_attribute1 Descriptive flexfield segment
270 * @param p_dei_attribute2 Descriptive flexfield segment
271 * @param p_dei_attribute3 Descriptive flexfield segment
272 * @param p_dei_attribute4 Descriptive flexfield segment
273 * @param p_dei_attribute5 Descriptive flexfield segment
274 * @param p_dei_attribute6 Descriptive flexfield segment
275 * @param p_dei_attribute7 Descriptive flexfield segment
276 * @param p_dei_attribute8 Descriptive flexfield segment
277 * @param p_dei_attribute9 Descriptive flexfield segment
278 * @param p_dei_attribute10 Descriptive flexfield segment
279 * @param p_dei_attribute11 Descriptive flexfield segment
280 * @param p_dei_attribute12 Descriptive flexfield segment
281 * @param p_dei_attribute13 Descriptive flexfield segment
282 * @param p_dei_attribute14 Descriptive flexfield segment
283 * @param p_dei_attribute15 Descriptive flexfield segment
284 * @param p_dei_attribute16 Descriptive flexfield segment
285 * @param p_dei_attribute17 Descriptive flexfield segment
286 * @param p_dei_attribute18 Descriptive flexfield segment
287 * @param p_dei_attribute19 Descriptive flexfield segment
288 * @param p_dei_attribute20 Descriptive flexfield segment
289 * @param p_dei_attribute21 Descriptive flexfield segment
290 * @param p_dei_attribute22 Descriptive flexfield segment
291 * @param p_dei_attribute23 Descriptive flexfield segment
292 * @param p_dei_attribute24 Descriptive flexfield segment
293 * @param p_dei_attribute25 Descriptive flexfield segment
294 * @param p_dei_attribute26 Descriptive flexfield segment
295 * @param p_dei_attribute27 Descriptive flexfield segment
296 * @param p_dei_attribute28 Descriptive flexfield segment
297 * @param p_dei_attribute29 Descriptive flexfield segment
298 * @param p_dei_attribute30 Descriptive flexfield segment
299 * @param p_dei_information_category This context value determines which
300 * flexfield structure to use with the developer descriptive flexfield segments
301 * @param p_dei_information1 Developer Descriptive flexfield segment
302 * @param p_dei_information2 Developer Descriptive flexfield segment
303 * @param p_dei_information3 Developer Descriptive flexfield segment
304 * @param p_dei_information4 Developer Descriptive flexfield segment
305 * @param p_dei_information5 Developer Descriptive flexfield segment
306 * @param p_dei_information6 Developer Descriptive flexfield segment
307 * @param p_dei_information7 Developer Descriptive flexfield segment
308 * @param p_dei_information8 Developer Descriptive flexfield segment
309 * @param p_dei_information9 Developer Descriptive flexfield segment
310 * @param p_dei_information10 Developer Descriptive flexfield segment
311 * @param p_dei_information11 Developer Descriptive flexfield segment
312 * @param p_dei_information12 Developer Descriptive flexfield segment
313 * @param p_dei_information13 Developer Descriptive flexfield segment
314 * @param p_dei_information14 Developer Descriptive flexfield segment
315 * @param p_dei_information15 Developer Descriptive flexfield segment
316 * @param p_dei_information16 Developer Descriptive flexfield segment
317 * @param p_dei_information17 Developer Descriptive flexfield segment
318 * @param p_dei_information18 Developer Descriptive flexfield segment
319 * @param p_dei_information19 Developer Descriptive flexfield segment
320 * @param p_dei_information20 Developer Descriptive flexfield segment
321 * @param p_dei_information21 Developer Descriptive flexfield segment
322 * @param p_dei_information22 Developer Descriptive flexfield segment
323 * @param p_dei_information23 Developer Descriptive flexfield segment
324 * @param p_dei_information24 Developer Descriptive flexfield segment
325 * @param p_dei_information25 Developer Descriptive flexfield segment
326 * @param p_dei_information26 Developer Descriptive flexfield segment
327 * @param p_dei_information27 Developer Descriptive flexfield segment
328 * @param p_dei_information28 Developer Descriptive flexfield segment
329 * @param p_dei_information29 Developer Descriptive flexfield segment
330 * @param p_dei_information30 Developer Descriptive flexfield segment
331 * @param p_request_id When the API is executed from a concurrent program
332 * set to the concurrent request identifier.
333 * @param p_program_application_id When the API is executed from a
334 * concurrent program set to the program's Application.
335 * @param p_program_id When the API is executed from a concurrent program
336 * set to the program's identifier.
337 * @param p_program_update_date When the API is executed from a concurrent
338 * program set to when the program was ran.
339 * @param p_object_version_number Pass in the current version number of
340 * the document extra information to be updated. When the API completes
341 * if p_validate is false, will be set to the new version number of the
342 * updated document extra information. If p_validate is true will be set
343 * to the same value which was passed in.
344 * @rep:displayname Update Person Document
345 * @rep:category BUSINESS_ENTITY HR_PERSON
349 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
346 * @rep:lifecycle active
347 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
348 * @rep:scope public
350 */
351 --
352 -- {End Of Comments}
353 --
354 procedure update_doc_extra_info
355 (p_validate in boolean default false
356 ,p_document_extra_info_id in number
357 ,p_person_id in number
358 ,p_document_type_id in number
359 ,p_date_from in date
360 ,p_date_to in date default hr_api.g_date
361 ,p_document_number in varchar2 default hr_api.g_varchar2
362 ,p_issued_by in varchar2 default hr_api.g_varchar2
363 ,p_issued_at in varchar2 default hr_api.g_varchar2
364 ,p_issued_date in date default hr_api.g_date
365 ,p_issuing_authority in varchar2 default hr_api.g_varchar2
366 ,p_verified_by in number default hr_api.g_number
367 ,p_verified_date in date default hr_api.g_date
368 ,p_related_object_name in varchar2 default hr_api.g_varchar2
369 ,p_related_object_id_col in varchar2 default hr_api.g_varchar2
370 ,p_related_object_id in number default hr_api.g_number
371 ,p_dei_attribute_category in varchar2 default hr_api.g_varchar2
372 ,p_dei_attribute1 in varchar2 default hr_api.g_varchar2
373 ,p_dei_attribute2 in varchar2 default hr_api.g_varchar2
374 ,p_dei_attribute3 in varchar2 default hr_api.g_varchar2
375 ,p_dei_attribute4 in varchar2 default hr_api.g_varchar2
376 ,p_dei_attribute5 in varchar2 default hr_api.g_varchar2
377 ,p_dei_attribute6 in varchar2 default hr_api.g_varchar2
378 ,p_dei_attribute7 in varchar2 default hr_api.g_varchar2
379 ,p_dei_attribute8 in varchar2 default hr_api.g_varchar2
380 ,p_dei_attribute9 in varchar2 default hr_api.g_varchar2
381 ,p_dei_attribute10 in varchar2 default hr_api.g_varchar2
382 ,p_dei_attribute11 in varchar2 default hr_api.g_varchar2
383 ,p_dei_attribute12 in varchar2 default hr_api.g_varchar2
384 ,p_dei_attribute13 in varchar2 default hr_api.g_varchar2
385 ,p_dei_attribute14 in varchar2 default hr_api.g_varchar2
386 ,p_dei_attribute15 in varchar2 default hr_api.g_varchar2
387 ,p_dei_attribute16 in varchar2 default hr_api.g_varchar2
388 ,p_dei_attribute17 in varchar2 default hr_api.g_varchar2
389 ,p_dei_attribute18 in varchar2 default hr_api.g_varchar2
390 ,p_dei_attribute19 in varchar2 default hr_api.g_varchar2
391 ,p_dei_attribute20 in varchar2 default hr_api.g_varchar2
392 ,p_dei_attribute21 in varchar2 default hr_api.g_varchar2
393 ,p_dei_attribute22 in varchar2 default hr_api.g_varchar2
394 ,p_dei_attribute23 in varchar2 default hr_api.g_varchar2
395 ,p_dei_attribute24 in varchar2 default hr_api.g_varchar2
396 ,p_dei_attribute25 in varchar2 default hr_api.g_varchar2
397 ,p_dei_attribute26 in varchar2 default hr_api.g_varchar2
398 ,p_dei_attribute27 in varchar2 default hr_api.g_varchar2
399 ,p_dei_attribute28 in varchar2 default hr_api.g_varchar2
400 ,p_dei_attribute29 in varchar2 default hr_api.g_varchar2
401 ,p_dei_attribute30 in varchar2 default hr_api.g_varchar2
402 ,p_dei_information_category in varchar2 default hr_api.g_varchar2
403 ,p_dei_information1 in varchar2 default hr_api.g_varchar2
404 ,p_dei_information2 in varchar2 default hr_api.g_varchar2
405 ,p_dei_information3 in varchar2 default hr_api.g_varchar2
406 ,p_dei_information4 in varchar2 default hr_api.g_varchar2
407 ,p_dei_information5 in varchar2 default hr_api.g_varchar2
408 ,p_dei_information6 in varchar2 default hr_api.g_varchar2
409 ,p_dei_information7 in varchar2 default hr_api.g_varchar2
410 ,p_dei_information8 in varchar2 default hr_api.g_varchar2
411 ,p_dei_information9 in varchar2 default hr_api.g_varchar2
412 ,p_dei_information10 in varchar2 default hr_api.g_varchar2
413 ,p_dei_information11 in varchar2 default hr_api.g_varchar2
414 ,p_dei_information12 in varchar2 default hr_api.g_varchar2
415 ,p_dei_information13 in varchar2 default hr_api.g_varchar2
416 ,p_dei_information14 in varchar2 default hr_api.g_varchar2
417 ,p_dei_information15 in varchar2 default hr_api.g_varchar2
418 ,p_dei_information16 in varchar2 default hr_api.g_varchar2
419 ,p_dei_information17 in varchar2 default hr_api.g_varchar2
420 ,p_dei_information18 in varchar2 default hr_api.g_varchar2
421 ,p_dei_information19 in varchar2 default hr_api.g_varchar2
422 ,p_dei_information20 in varchar2 default hr_api.g_varchar2
423 ,p_dei_information21 in varchar2 default hr_api.g_varchar2
424 ,p_dei_information22 in varchar2 default hr_api.g_varchar2
425 ,p_dei_information23 in varchar2 default hr_api.g_varchar2
426 ,p_dei_information24 in varchar2 default hr_api.g_varchar2
427 ,p_dei_information25 in varchar2 default hr_api.g_varchar2
428 ,p_dei_information26 in varchar2 default hr_api.g_varchar2
429 ,p_dei_information27 in varchar2 default hr_api.g_varchar2
430 ,p_dei_information28 in varchar2 default hr_api.g_varchar2
431 ,p_dei_information29 in varchar2 default hr_api.g_varchar2
435 ,p_program_id in number default hr_api.g_number
432 ,p_dei_information30 in varchar2 default hr_api.g_varchar2
433 ,p_request_id in number default hr_api.g_number
434 ,p_program_application_id in number default hr_api.g_number
436 ,p_program_update_date in date default hr_api.g_date
437 ,p_object_version_number in out nocopy number
438 );
439 --
440 -- ----------------------------------------------------------------------------
441 -- |-------------------------< delete_doc_extra_info >---------------------|
442 -- ----------------------------------------------------------------------------
443 --
444 -- {Start Of Comments}
445 /*#
446 * This API deletes the document of record for a person.
447 *
448 * <p><b>Licensing</b><br>
449 * This API is licensed for use with Human Resource.
450 *
451 * <p><b>Prerequisites</b><br>
452 * Document of record must exist for a person.
453 *
454 * <p><b>Post Success</b><br>
455 * The document of record will be deleted.
456 *
457 * <p><b>Post Failure</b><br>
458 * The document of record will not be deleted and an error will be raised.
459 *
460 * @param p_validate If true, then validation alone will be performed and
461 * the database will remain unchanged. If false and all validation checks pass,
462 * then the database will be modified.
463 * @param p_document_extra_info_id If p_validate is false, then this
464 * uniquely identifies the document extra info to be deleted. If p_validate is
465 * true, then set to null.
466 * @param p_object_version_number Current version number of the document
467 * extra information to be deleted.
468 * @rep:displayname Delete Person Document
469 * @rep:category BUSINESS_ENTITY HR_PERSON
470 * @rep:lifecycle active
471 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
472 * @rep:scope public
473 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
474 */
475 --
476 -- {End Of Comments}
477 --
478 procedure delete_doc_extra_info
479 (p_validate in boolean default false
480 ,p_document_extra_info_id in number
481 ,p_object_version_number in number
482 );
483
484 --
485 -- ----------------------------------------------------------------------------
486 -- |----------------------------< set_reviewer >------------------------------|
487 -- ----------------------------------------------------------------------------
488 --
489 -- {Start Of Comments}
490 --
491 -- Description:
492 -- Sets the value of workflow attribute - Reviewer.
493 -- This procedure is called by Documents of Record workflow process.
494 --
495 --
496 -- Prerequisites:
497 -- None
498 --
499 -- In Parameters:
500 -- Name Reqd Type Description
501 -- itemtype Yes Varchar2 Identifies workflow item type
502 -- itemkey Yes Varchar2 Identifies workflow process
503 -- actid Yes Number Identifies workflow activity
504 -- funcmode Yes Varchar2 Identifies activity execution mode
505 --
506 --
507 -- Post Success:
508 -- The workflow attribute value will be set for Reviewer.
509 --
510 -- Returns the parameter value.
511 --
512 -- Name Type Description
513 -- resultout Varchar2 Indicates whether or not workflow
514 -- attribute is set.
515 --
516 -- Post Failure:
517 -- Workflow error will be raised.
518 --
519 -- Access Status:
520 -- Internal Development Use Only.
521 --
522 -- {End Of Comments}
523 --
524 procedure set_reviewer (itemtype in varchar2,
525 itemkey in varchar2,
526 actid in number,
527 funcmode in varchar2,
528 resultout out nocopy varchar2);
529
530
531 --
532 -- ----------------------------------------------------------------------------
533 -- |----------------------------< set_reviewee >------------------------------|
534 -- ----------------------------------------------------------------------------
535 --
536 -- {Start Of Comments}
537 --
538 -- Description:
539 -- Checks whether workflow attribute Reviewee is set.
540 -- This procedure is called by Documents of Record workflow process.
541 --
542 --
543 -- Prerequisites:
544 -- None
545 --
546 -- In Parameters:
547 -- Name Reqd Type Description
548 -- itemtype Yes Varchar2 Identifies workflow item type
549 -- itemkey Yes Varchar2 Identifies workflow process
550 -- actid Yes Number Identifies workflow activity
551 -- funcmode Yes Varchar2 Identifies activity execution mode
552 --
553 --
554 -- Post Success:
555 --
556 -- Returns the parameter value.
557 --
558 -- Name Type Description
559 -- resultout Varchar2 Indicates whether or not workflow
560 -- attribute is set.
561 --
562 -- Post Failure:
563 -- Workflow error will be raised.
564 --
565 -- Access Status:
566 -- Internal Development Use Only.
567 --
568 -- {End Of Comments}
569 --
570 procedure set_reviewee (itemtype in varchar2,
571 itemkey in varchar2,
572 actid in number,
573 funcmode in varchar2,
574 resultout out nocopy varchar2);
575
576 --
577 --
578 -- ----------------------------------------------------------------------------
579 -- |--------------------< get_view_pg_wf_notif_params >----------------------|
580 -- ----------------------------------------------------------------------------
581 --
582 -- {Start Of Comments}
583 --
584 -- Description:
585 -- Retrieves the notification parameter values for a given notification
586 -- identifier.
587 -- This procedure is called by Documents of Record functions.
588 --
589 --
590 -- Prerequisites:
591 -- None
592 --
593 -- In Parameters:
594 -- Name Reqd Type Description
595 -- p_notification_id Yes Number Identifies the notification.
596 --
597 --
598 -- Post Success:
599 -- Returns the parameter values.
600 --
601 -- Name Type Description
602 -- p_dor_id Number Identifies the person document
603 -- p_person_id Number Identifies the person
604 -- p_effective_date Date Date on which person is active.
605 --
606 --
607 -- Post Failure:
608 -- An oracle error will be raised.
609 --
610 -- Access Status:
611 -- Internal Development Use Only.
612 --
613 -- {End Of Comments}
614 --
615 procedure get_view_pg_wf_notif_params (p_notification_id in number,
616 p_dor_id out nocopy varchar2,
617 p_person_id out nocopy varchar2,
618 p_effective_date out nocopy date);
619
620 end hr_document_extra_info_api;
621
622 --
623 --
624
625 --
626 --
[Home] [Help]