4 * This package contains checklist item APIs.
1 Package per_checklist_items_api AUTHID CURRENT_USER as
2 /* $Header: pechkapi.pkh 120.1 2005/10/02 02:13:06 aroussel $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Checklist Item
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_checklist_items >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates checklist items for a person.
17 *
18 * A checklist is a list of user actions related to people management and
19 * recruitment, such as "Check References" and "Reimburse Expenses". Against
20 * each check item, users can record a status, date due, date achieved, and any
21 * notes. The checklists are for user reference only; they do not perform any
22 * actions
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * The person and checklist item must exist in the relevant business group.
29 *
30 * <p><b>Post Success</b><br>
31 * The checklist item for the person is successfully created.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the checklist item and raises an error.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Determines when the DateTrack operation comes into
39 * force.
40 * @param p_person_id Identifies the person for whom you create the checklist
44 * @param p_date_due Due date.
41 * item record.
42 * @param p_item_code Item Code. Valid values are defined by the CHECKLIST_ITEM
43 * lookup type.
45 * @param p_date_done Date completed.
46 * @param p_status Status of the checklist item. Valid values are defined by
47 * the CHECKLIST_STATUS lookup type.
48 * @param p_notes Comment text.
49 * @param p_attribute_category This context value determines which flexfield
50 * structure to use with the descriptive flexfield segments.
51 * @param p_attribute1 Descriptive flexfield segment.
52 * @param p_attribute2 Descriptive flexfield segment.
53 * @param p_attribute3 Descriptive flexfield segment.
54 * @param p_attribute4 Descriptive flexfield segment.
55 * @param p_attribute5 Descriptive flexfield segment.
56 * @param p_attribute6 Descriptive flexfield segment.
57 * @param p_attribute7 Descriptive flexfield segment.
58 * @param p_attribute8 Descriptive flexfield segment.
59 * @param p_attribute9 Descriptive flexfield segment.
60 * @param p_attribute10 Descriptive flexfield segment.
61 * @param p_attribute11 Descriptive flexfield segment.
62 * @param p_attribute12 Descriptive flexfield segment.
63 * @param p_attribute13 Descriptive flexfield segment.
64 * @param p_attribute14 Descriptive flexfield segment.
65 * @param p_attribute15 Descriptive flexfield segment.
66 * @param p_attribute16 Descriptive flexfield segment.
67 * @param p_attribute17 Descriptive flexfield segment.
68 * @param p_attribute18 Descriptive flexfield segment.
69 * @param p_attribute19 Descriptive flexfield segment.
70 * @param p_attribute20 Descriptive flexfield segment.
71 * @param p_attribute21 Descriptive flexfield segment.
72 * @param p_attribute22 Descriptive flexfield segment.
73 * @param p_attribute23 Descriptive flexfield segment.
74 * @param p_attribute24 Descriptive flexfield segment.
75 * @param p_attribute25 Descriptive flexfield segment.
76 * @param p_attribute26 Descriptive flexfield segment.
77 * @param p_attribute27 Descriptive flexfield segment.
78 * @param p_attribute28 Descriptive flexfield segment.
79 * @param p_attribute29 Descriptive flexfield segment.
80 * @param p_attribute30 Descriptive flexfield segment.
81 * @param p_checklist_item_id If p_validate is false, then this uniquely
82 * identifies the created checklist item. If p_validate is true, then set to
83 * null.
84 * @param p_object_version_number If p_validate is false, then set to the
85 * version number of the created checklist. If p_validate is true, then the
86 * value will be null.
87 * @rep:displayname Create Checklist Item
88 * @rep:category BUSINESS_ENTITY HR_PERSON
89 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
93 */
94 --
95 -- {End Of Comments}
96 --
97 procedure create_checklist_items
98 ( p_validate in boolean default false
99 ,p_effective_date in date
100 ,p_person_id in number
101 ,p_item_code in varchar2
102 ,p_date_due in date default null
103 ,p_date_done in date default null
104 ,p_status in varchar2 default null
105 ,p_notes in varchar2 default null
106 ,p_attribute_category in varchar2 default null
107 ,p_attribute1 in varchar2 default null
108 ,p_attribute2 in varchar2 default null
109 ,p_attribute3 in varchar2 default null
110 ,p_attribute4 in varchar2 default null
111 ,p_attribute5 in varchar2 default null
112 ,p_attribute6 in varchar2 default null
113 ,p_attribute7 in varchar2 default null
114 ,p_attribute8 in varchar2 default null
115 ,p_attribute9 in varchar2 default null
116 ,p_attribute10 in varchar2 default null
117 ,p_attribute11 in varchar2 default null
118 ,p_attribute12 in varchar2 default null
119 ,p_attribute13 in varchar2 default null
120 ,p_attribute14 in varchar2 default null
121 ,p_attribute15 in varchar2 default null
122 ,p_attribute16 in varchar2 default null
123 ,p_attribute17 in varchar2 default null
124 ,p_attribute18 in varchar2 default null
125 ,p_attribute19 in varchar2 default null
126 ,p_attribute20 in varchar2 default null
127 ,p_attribute21 in varchar2 default null
128 ,p_attribute22 in varchar2 default null
129 ,p_attribute23 in varchar2 default null
130 ,p_attribute24 in varchar2 default null
131 ,p_attribute25 in varchar2 default null
132 ,p_attribute26 in varchar2 default null
133 ,p_attribute27 in varchar2 default null
134 ,p_attribute28 in varchar2 default null
135 ,p_attribute29 in varchar2 default null
136 ,p_attribute30 in varchar2 default null
137 ,p_checklist_item_id out nocopy number
138 ,p_object_version_number out nocopy number
139 );
140 --
141 -- ----------------------------------------------------------------------------
142 -- |--------------------------< update_checklist_items >----------------------|
143 -- ----------------------------------------------------------------------------
144 --
145 -- {Start Of Comments}
146 /*#
147 * This API updates checklist items for a person.
148 *
152 * notes. The checklists are for user reference only; they do not perform any
149 * A checklist is a list of user actions related to people management and
150 * recruitment, such as "Check References" and "Reimburse Expenses". Against
151 * each check item, users can record a status, date due, date achieved, and any
153 * actions
154 *
155 * <p><b>Licensing</b><br>
156 * This API is licensed for use with Human Resources.
157 *
158 * <p><b>Prerequisites</b><br>
159 * The checklist item must exist in the relevant business group.
160 *
161 * <p><b>Post Success</b><br>
162 * The checklist item for the person is successfully updated.
163 *
164 * <p><b>Post Failure</b><br>
165 * The API does not update the checklist item and raises an error.
166 * @param p_validate If true, then validation alone will be performed and the
167 * database will remain unchanged. If false and all validation checks pass,
168 * then the database will be modified.
169 * @param p_effective_date Determines when the DateTrack operation comes into
170 * force.
171 * @param p_checklist_item_id Identifies the checklist item record to be
172 * modified.
173 * @param p_person_id Identifies the person for whom you modify the checklist
174 * item record.
175 * @param p_item_code Item Code. Valid values are defined by the CHECKLIST_ITEM
176 * lookup type.
177 * @param p_date_due Due date.
178 * @param p_date_done Date completed.
179 * @param p_status Status of the checklist item. Valid values are defined by
180 * the CHECKLIST_STATUS lookup type.
181 * @param p_notes Comment text.
182 * @param p_attribute_category This context value determines which flexfield
183 * structure to use with the descriptive flexfield segments.
184 * @param p_attribute1 Descriptive flexfield segment.
185 * @param p_attribute2 Descriptive flexfield segment.
186 * @param p_attribute3 Descriptive flexfield segment.
187 * @param p_attribute4 Descriptive flexfield segment.
188 * @param p_attribute5 Descriptive flexfield segment.
189 * @param p_attribute6 Descriptive flexfield segment.
190 * @param p_attribute7 Descriptive flexfield segment.
191 * @param p_attribute8 Descriptive flexfield segment.
192 * @param p_attribute9 Descriptive flexfield segment.
193 * @param p_attribute10 Descriptive flexfield segment.
194 * @param p_attribute11 Descriptive flexfield segment.
195 * @param p_attribute12 Descriptive flexfield segment.
196 * @param p_attribute13 Descriptive flexfield segment.
197 * @param p_attribute14 Descriptive flexfield segment.
198 * @param p_attribute15 Descriptive flexfield segment.
199 * @param p_attribute16 Descriptive flexfield segment.
200 * @param p_attribute17 Descriptive flexfield segment.
201 * @param p_attribute18 Descriptive flexfield segment.
202 * @param p_attribute19 Descriptive flexfield segment.
203 * @param p_attribute20 Descriptive flexfield segment.
204 * @param p_attribute21 Descriptive flexfield segment.
205 * @param p_attribute22 Descriptive flexfield segment.
206 * @param p_attribute23 Descriptive flexfield segment.
207 * @param p_attribute24 Descriptive flexfield segment.
208 * @param p_attribute25 Descriptive flexfield segment.
209 * @param p_attribute26 Descriptive flexfield segment.
210 * @param p_attribute27 Descriptive flexfield segment.
211 * @param p_attribute28 Descriptive flexfield segment.
212 * @param p_attribute29 Descriptive flexfield segment.
213 * @param p_attribute30 Descriptive flexfield segment.
214 * @param p_object_version_number Pass in the current version number of the
215 * checklist to be updated. When the API completes if p_validate is false, will
216 * be set to the new version number of the updated checklist. If p_validate is
217 * true will be set to the same value which was passed in.
218 * @rep:displayname Update Checklist Item
219 * @rep:category BUSINESS_ENTITY HR_PERSON
220 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
221 * @rep:scope public
222 * @rep:lifecycle active
223 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
224 */
225 --
226 -- {End Of Comments}
227 --
228 procedure update_checklist_items
229 (
230 p_validate in boolean default false
231 ,p_effective_date in date
232 ,p_checklist_item_id in number
233 ,p_person_id in number default hr_api.g_number
234 ,p_item_code in varchar2 default hr_api.g_varchar2
235 ,p_date_due in date default hr_api.g_date
236 ,p_date_done in date default hr_api.g_date
237 ,p_status in varchar2 default hr_api.g_varchar2
238 ,p_notes in varchar2 default hr_api.g_varchar2
239 ,p_attribute_category in varchar2 default hr_api.g_varchar2
240 ,p_attribute1 in varchar2 default hr_api.g_varchar2
241 ,p_attribute2 in varchar2 default hr_api.g_varchar2
242 ,p_attribute3 in varchar2 default hr_api.g_varchar2
243 ,p_attribute4 in varchar2 default hr_api.g_varchar2
244 ,p_attribute5 in varchar2 default hr_api.g_varchar2
245 ,p_attribute6 in varchar2 default hr_api.g_varchar2
246 ,p_attribute7 in varchar2 default hr_api.g_varchar2
247 ,p_attribute8 in varchar2 default hr_api.g_varchar2
248 ,p_attribute9 in varchar2 default hr_api.g_varchar2
249 ,p_attribute10 in varchar2 default hr_api.g_varchar2
253 ,p_attribute14 in varchar2 default hr_api.g_varchar2
250 ,p_attribute11 in varchar2 default hr_api.g_varchar2
251 ,p_attribute12 in varchar2 default hr_api.g_varchar2
252 ,p_attribute13 in varchar2 default hr_api.g_varchar2
254 ,p_attribute15 in varchar2 default hr_api.g_varchar2
255 ,p_attribute16 in varchar2 default hr_api.g_varchar2
256 ,p_attribute17 in varchar2 default hr_api.g_varchar2
257 ,p_attribute18 in varchar2 default hr_api.g_varchar2
258 ,p_attribute19 in varchar2 default hr_api.g_varchar2
259 ,p_attribute20 in varchar2 default hr_api.g_varchar2
260 ,p_attribute21 in varchar2 default hr_api.g_varchar2
261 ,p_attribute22 in varchar2 default hr_api.g_varchar2
262 ,p_attribute23 in varchar2 default hr_api.g_varchar2
263 ,p_attribute24 in varchar2 default hr_api.g_varchar2
264 ,p_attribute25 in varchar2 default hr_api.g_varchar2
265 ,p_attribute26 in varchar2 default hr_api.g_varchar2
266 ,p_attribute27 in varchar2 default hr_api.g_varchar2
267 ,p_attribute28 in varchar2 default hr_api.g_varchar2
268 ,p_attribute29 in varchar2 default hr_api.g_varchar2
269 ,p_attribute30 in varchar2 default hr_api.g_varchar2
270 ,p_object_version_number in out nocopy number
271 );
272 --
273 -- ----------------------------------------------------------------------------
274 -- |--------------------------< delete_checklist_items >----------------------|
275 -- ----------------------------------------------------------------------------
276 --
277 -- {Start Of Comments}
278 /*#
279 * This API deletes checklist items for a person.
280 *
281 * A checklist is a list of user actions related to people management and
282 * recruitment, such as "Check References" and "Reimburse Expenses". Against
283 * each check item, users can record a status, date due, date achieved, and any
284 * notes. The checklists are for user reference only; they do not perform any
285 * actions
286 *
287 * <p><b>Licensing</b><br>
288 * This API is licensed for use with Human Resources.
289 *
290 * <p><b>Prerequisites</b><br>
291 * The checklist item must exist in the relevant business group.
292 *
293 * <p><b>Post Success</b><br>
294 * The checklist item for the person is successfully deleted.
295 *
296 * <p><b>Post Failure</b><br>
297 * The API does not delete the checklist item and raises an error.
298 * @param p_validate If true, then validation alone will be performed and the
299 * database will remain unchanged. If false and all validation checks pass,
300 * then the database will be modified.
301 * @param p_checklist_item_id Identifies the checklist item record to be
302 * deleted.
303 * @param p_object_version_number Current version number of the checklist to be
304 * deleted.
305 * @rep:displayname Delete Checklist Item
306 * @rep:category BUSINESS_ENTITY HR_PERSON
307 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
308 * @rep:scope public
309 * @rep:lifecycle active
310 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
311 */
312 --
313 -- {End Of Comments}
314 --
315 procedure delete_checklist_items
316 (
317 p_validate in boolean default false
318 ,p_checklist_item_id in number
319 ,p_object_version_number in number
320 );
321 --
322 -- ----------------------------------------------------------------------------
323 -- |----------------------------------< lck >---------------------------------|
324 -- ----------------------------------------------------------------------------
325 -- {Start Of Comments}
326 --
327 -- Description:
328 --
329 -- Prerequisites:
330 --
331 --
332 -- In Parameters:
333 -- Name Reqd Type Description
334 -- p_checklist_item_id Yes number PK of record
335 -- p_object_version_number Yes number OVN of record
336 --
337 -- Post Success:
338 --
339 -- Name Type Description
340 --
341 -- Post Failure:
342 --
343 -- Access Status:
344 -- Public.
345 --
346 -- {End Of Comments}
347 --
348 procedure lck
349 (
350 p_checklist_item_id in number
351 ,p_object_version_number in number
352 );
353 --
354 --
355 -- ----------------------------------------------------------------------------
356 -- |------------------------< cre_upd_checklist_items >-----------------------|
357 -- ----------------------------------------------------------------------------
358 -- {Start Of Comments}
359 --
360 -- Description: This procedure is a wrapper used for creating or updating an
361 -- checklist item, depending on the data passed to it
362 --
363 -- Prerequisites:
364 --
365 --
366 -- In Parameters:
367 -- Name Reqd Type Description
368 -- p_validate Yes boolean Commit or Rollback.
369 -- p_effective_date Yes date
370 -- p_checklist_item_id Yes number PK of record
371 -- p_person_id Yes number
372 -- p_item_code Yes varchar2
373 -- p_date_due No date
374 -- p_date_done No date
375 -- p_status Yes varchar2
376 -- p_notes No varchar2
377 -- p_attribute_category No varchar2 Descriptive Flexfield
378 -- p_attribute1 No varchar2 Descriptive Flexfield
379 -- p_attribute2 No varchar2 Descriptive Flexfield
380 -- p_attribute3 No varchar2 Descriptive Flexfield
381 -- p_attribute4 No varchar2 Descriptive Flexfield
382 -- p_attribute5 No varchar2 Descriptive Flexfield
383 -- p_attribute6 No varchar2 Descriptive Flexfield
384 -- p_attribute7 No varchar2 Descriptive Flexfield
385 -- p_attribute8 No varchar2 Descriptive Flexfield
386 -- p_attribute9 No varchar2 Descriptive Flexfield
387 -- p_attribute10 No varchar2 Descriptive Flexfield
388 -- p_attribute11 No varchar2 Descriptive Flexfield
389 -- p_attribute12 No varchar2 Descriptive Flexfield
390 -- p_attribute13 No varchar2 Descriptive Flexfield
391 -- p_attribute14 No varchar2 Descriptive Flexfield
392 -- p_attribute15 No varchar2 Descriptive Flexfield
393 -- p_attribute16 No varchar2 Descriptive Flexfield
397 -- p_attribute20 No varchar2 Descriptive Flexfield
394 -- p_attribute17 No varchar2 Descriptive Flexfield
395 -- p_attribute18 No varchar2 Descriptive Flexfield
396 -- p_attribute19 No varchar2 Descriptive Flexfield
398 -- p_attribute21 No varchar2 Descriptive Flexfield
399 -- p_attribute22 No varchar2 Descriptive Flexfield
400 -- p_attribute23 No varchar2 Descriptive Flexfield
401 -- p_attribute24 No varchar2 Descriptive Flexfield
402 -- p_attribute25 No varchar2 Descriptive Flexfield
403 -- p_attribute26 No varchar2 Descriptive Flexfield
404 -- p_attribute27 No varchar2 Descriptive Flexfield
405 -- p_attribute28 No varchar2 Descriptive Flexfield
406 -- p_attribute29 No varchar2 Descriptive Flexfield
407 -- p_attribute30 No varchar2 Descriptive Flexfield
408 --
409 -- Post Success:
410 --
411 -- Name Type Description
412 -- p_object_version_number No number OVN of record
413 --
414 -- Post Failure:
415 --
416 -- Access Status:
417 -- Public.
418 --
419 -- {End Of Comments}
420 --
421 procedure cre_or_upd_checklist_items
422 (
423 p_validate in boolean default false
424 ,p_effective_date in date
425 ,p_person_id in number default hr_api.g_number
426 ,p_item_code in varchar2 default hr_api.g_varchar2
427 ,p_date_due in date default hr_api.g_date
428 ,p_date_done in date default hr_api.g_date
429 ,p_status in varchar2 default hr_api.g_varchar2
430 ,p_notes in varchar2 default hr_api.g_varchar2
431 ,p_attribute_category in varchar2 default hr_api.g_varchar2
432 ,p_attribute1 in varchar2 default hr_api.g_varchar2
433 ,p_attribute2 in varchar2 default hr_api.g_varchar2
434 ,p_attribute3 in varchar2 default hr_api.g_varchar2
435 ,p_attribute4 in varchar2 default hr_api.g_varchar2
436 ,p_attribute5 in varchar2 default hr_api.g_varchar2
437 ,p_attribute6 in varchar2 default hr_api.g_varchar2
438 ,p_attribute7 in varchar2 default hr_api.g_varchar2
439 ,p_attribute8 in varchar2 default hr_api.g_varchar2
440 ,p_attribute9 in varchar2 default hr_api.g_varchar2
441 ,p_attribute10 in varchar2 default hr_api.g_varchar2
442 ,p_attribute11 in varchar2 default hr_api.g_varchar2
443 ,p_attribute12 in varchar2 default hr_api.g_varchar2
444 ,p_attribute13 in varchar2 default hr_api.g_varchar2
445 ,p_attribute14 in varchar2 default hr_api.g_varchar2
446 ,p_attribute15 in varchar2 default hr_api.g_varchar2
447 ,p_attribute16 in varchar2 default hr_api.g_varchar2
448 ,p_attribute17 in varchar2 default hr_api.g_varchar2
449 ,p_attribute18 in varchar2 default hr_api.g_varchar2
450 ,p_attribute19 in varchar2 default hr_api.g_varchar2
451 ,p_attribute20 in varchar2 default hr_api.g_varchar2
452 ,p_attribute21 in varchar2 default hr_api.g_varchar2
453 ,p_attribute22 in varchar2 default hr_api.g_varchar2
454 ,p_attribute23 in varchar2 default hr_api.g_varchar2
455 ,p_attribute24 in varchar2 default hr_api.g_varchar2
456 ,p_attribute25 in varchar2 default hr_api.g_varchar2
457 ,p_attribute26 in varchar2 default hr_api.g_varchar2
458 ,p_attribute27 in varchar2 default hr_api.g_varchar2
459 ,p_attribute28 in varchar2 default hr_api.g_varchar2
460 ,p_attribute29 in varchar2 default hr_api.g_varchar2
461 ,p_attribute30 in varchar2 default hr_api.g_varchar2
462 ,p_checklist_item_id in out nocopy number
463 ,p_object_version_number in out nocopy number
464 );
465 --
466 --
467 end per_checklist_items_api;
[Home] [Help]