[Home] [Help]
PACKAGE: APPS.PER_TASKS_IN_CHECKLIST_API
Source
1 Package PER_TASKS_IN_CHECKLIST_API as
2 /* $Header: pectkapi.pkh 120.3 2006/01/13 05:10:20 lsilveir noship $ */
3 /*#
4 * This package contains APIs for maintaining checklist tasks.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Checklist Task
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_task_in_ckl >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new checklist task within an existing checklist.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with HR Foundation.
20 *
21 * <p><b>Prerequisites</b><br>
22 * The checklist within which the task is being created must already exist.
23 *
24 * <p><b>Post Success</b><br>
25 * The API creates the checklist task successfully in the database.
26 *
27 * <p><b>Post Failure</b><br>
28 * The checklist task is not created in the database and an error is raised.
29 *
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date The date on which the checklist task is created.
34 * @param p_checklist_id Identifies the checklist in which the checklist
35 * task is created.
36 * @param p_checklist_task_name Checklist task name.
37 * @param p_eligibility_object_id Identifies the eligibility object
38 * associated with the checklist task.
39 * @param p_eligibility_profile_id identifies the eligibility profile
40 * attached to the checklist task.
41 * @param p_ame_attribute_identifier Identifies the AME attribute used for
42 * approvals management.
43 * @param p_description Checklist task description.
44 * @param p_task_sequence This should always be left null.
45 * @param p_mandatory Indicates whether the task is mandatory or optional.
46 * Set to 'Y' for mandatory and 'N' for optional.
47 * @param p_target_duration Target duration within which the task must
48 * be completed.
49 * @param p_target_duration_uom Unit of measure for the specified target
50 * duration.
51 * @param p_action_url URL of website to action the task.
52 * @param p_attribute_category This context value determines which flexfield
53 * structure to use with the descriptive flexfield segments.
54 * @param p_attribute1 Descriptive flexfield segment.
55 * @param p_attribute2 Descriptive flexfield segment.
56 * @param p_attribute3 Descriptive flexfield segment.
57 * @param p_attribute4 Descriptive flexfield segment.
58 * @param p_attribute5 Descriptive flexfield segment.
59 * @param p_attribute6 Descriptive flexfield segment.
60 * @param p_attribute7 Descriptive flexfield segment.
61 * @param p_attribute8 Descriptive flexfield segment.
62 * @param p_attribute9 Descriptive flexfield segment.
63 * @param p_attribute10 Descriptive flexfield segment.
64 * @param p_attribute11 Descriptive flexfield segment.
65 * @param p_attribute12 Descriptive flexfield segment.
66 * @param p_attribute13 Descriptive flexfield segment.
67 * @param p_attribute14 Descriptive flexfield segment.
68 * @param p_attribute15 Descriptive flexfield segment.
69 * @param p_attribute16 Descriptive flexfield segment.
70 * @param p_attribute17 Descriptive flexfield segment.
71 * @param p_attribute18 Descriptive flexfield segment.
72 * @param p_attribute19 Descriptive flexfield segment.
73 * @param p_attribute20 Descriptive flexfield segment.
74 * @param p_information_category This context value determines which flexfield
75 * structure to use with the developer descriptive flexfield segments.
76 * @param p_information1 Developer descriptive flexfield segment.
77 * @param p_information2 Developer descriptive flexfield segment.
78 * @param p_information3 Developer descriptive flexfield segment.
79 * @param p_information4 Developer descriptive flexfield segment.
80 * @param p_information5 Developer descriptive flexfield segment.
81 * @param p_information6 Developer descriptive flexfield segment.
82 * @param p_information7 Developer descriptive flexfield segment.
83 * @param p_information8 Developer descriptive flexfield segment.
84 * @param p_information9 Developer descriptive flexfield segment.
85 * @param p_information10 Developer descriptive flexfield segment.
86 * @param p_information11 Developer descriptive flexfield segment.
87 * @param p_information12 Developer descriptive flexfield segment.
88 * @param p_information13 Developer descriptive flexfield segment.
89 * @param p_information14 Developer descriptive flexfield segment.
90 * @param p_information15 Developer descriptive flexfield segment.
91 * @param p_information16 Developer descriptive flexfield segment.
92 * @param p_information17 Developer descriptive flexfield segment.
93 * @param p_information18 Developer descriptive flexfield segment.
94 * @param p_information19 Developer descriptive flexfield segment.
95 * @param p_information20 Developer descriptive flexfield segment.
96 * @param p_task_in_checklist_id If p_validate is false, then this
97 * uniquely identifies the checklist task created. If p_validate
98 * is true, then set to null.
99 * @param p_object_version_number If p_validate is false, then set to the
100 * version number of the created checklist task. If p_validate is true,
101 * then the value will be null.
102 * @rep:displayname Create Checklist Task
103 * @rep:category BUSINESS_ENTITY PER_CHECKLIST
104 * @rep:lifecycle active
105 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
106 * @rep:scope public
107 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
108 */
109 --
110 -- {End Of Comments}
111 --
112 procedure create_task_in_ckl
113 (p_validate in boolean default false
114 ,p_effective_date in date
115 ,p_checklist_id in number
116 ,p_checklist_task_name in varchar2
117 ,p_eligibility_object_id in number default null
118 ,p_eligibility_profile_id in number default null
119 ,p_ame_attribute_identifier in varchar2 default null
120 ,p_description in varchar2 default null
121 ,p_task_sequence in number default null
122 ,p_mandatory in varchar2 default null
123 ,p_target_duration in number default null
124 ,p_target_duration_uom in varchar2 default null
125 ,p_action_url in varchar2 default null
126 ,p_attribute_category in varchar2 default null
127 ,p_attribute1 in varchar2 default null
128 ,p_attribute2 in varchar2 default null
129 ,p_attribute3 in varchar2 default null
130 ,p_attribute4 in varchar2 default null
131 ,p_attribute5 in varchar2 default null
132 ,p_attribute6 in varchar2 default null
133 ,p_attribute7 in varchar2 default null
134 ,p_attribute8 in varchar2 default null
135 ,p_attribute9 in varchar2 default null
136 ,p_attribute10 in varchar2 default null
137 ,p_attribute11 in varchar2 default null
138 ,p_attribute12 in varchar2 default null
139 ,p_attribute13 in varchar2 default null
140 ,p_attribute14 in varchar2 default null
141 ,p_attribute15 in varchar2 default null
142 ,p_attribute16 in varchar2 default null
143 ,p_attribute17 in varchar2 default null
144 ,p_attribute18 in varchar2 default null
145 ,p_attribute19 in varchar2 default null
146 ,p_attribute20 in varchar2 default null
147 ,p_information_category in varchar2 default null
148 ,p_information1 in varchar2 default null
149 ,p_information2 in varchar2 default null
150 ,p_information3 in varchar2 default null
151 ,p_information4 in varchar2 default null
152 ,p_information5 in varchar2 default null
153 ,p_information6 in varchar2 default null
154 ,p_information7 in varchar2 default null
155 ,p_information8 in varchar2 default null
156 ,p_information9 in varchar2 default null
157 ,p_information10 in varchar2 default null
158 ,p_information11 in varchar2 default null
159 ,p_information12 in varchar2 default null
160 ,p_information13 in varchar2 default null
161 ,p_information14 in varchar2 default null
162 ,p_information15 in varchar2 default null
163 ,p_information16 in varchar2 default null
164 ,p_information17 in varchar2 default null
165 ,p_information18 in varchar2 default null
166 ,p_information19 in varchar2 default null
167 ,p_information20 in varchar2 default null
168 ,p_task_in_checklist_id out nocopy number
169 ,p_object_version_number out nocopy number
170 );
171 --
172 -- ----------------------------------------------------------------------------
173 -- |----------------------------< update_task_in_ckl >------------------------|
174 -- ----------------------------------------------------------------------------
175 --
176 -- {Start Of Comments}
177 /*#
178 * This API updates an existing checklist task.
179 *
180 * <p><b>Licensing</b><br>
181 * This API is licensed for use with HR Foundation.
182 *
183 * <p><b>Prerequisites</b><br>
184 * The checklist task that is to be updated must already exist.
185 *
186 * <p><b>Post Success</b><br>
187 * The API updates the checklist task successfully in the database.
188 *
189 * <p><b>Post Failure</b><br>
190 * The checklist task is not updated in the database and an error is raised.
191 *
192 * @param p_validate If true, then validation alone will be performed and the
193 * database will remain unchanged. If false and all validation checks pass,
194 * then the database will be modified.
195 * @param p_effective_date The date on which the checklist task is updated.
196 * @param p_task_in_checklist_id Identifies the checklist task to be updated.
197 * @param p_checklist_id Identifies the checklist containing the checklist
198 * task.
199 * @param p_checklist_task_name Checklist task name.
200 * @param p_eligibility_object_id Identifies the eligibility object
201 * associated with the checklist task.
202 * @param p_eligibility_profile_id identifies the eligibility profile
203 * attached to the checklist task.
204 * @param p_ame_attribute_identifier Identifies the AME attribute used for
205 * approvals management.
206 * @param p_description Checklist task description.
207 * @param p_task_sequence This should always be left null.
208 * @param p_mandatory Indicates whether the task is mandatory or optional.
209 * Set to 'Y' for mandatory and 'N' for optional.
210 * @param p_target_duration Target duration within which the task must
211 * be completed.
212 * @param p_target_duration_uom Unit of measure for the specified target
213 * duration.
214 * @param p_action_url URL of website to action the task.
215 * @param p_attribute_category This context value determines which flexfield
216 * structure to use with the descriptive flexfield segments.
217 * @param p_attribute1 Descriptive flexfield segment.
218 * @param p_attribute2 Descriptive flexfield segment.
219 * @param p_attribute3 Descriptive flexfield segment.
220 * @param p_attribute4 Descriptive flexfield segment.
221 * @param p_attribute5 Descriptive flexfield segment.
222 * @param p_attribute6 Descriptive flexfield segment.
223 * @param p_attribute7 Descriptive flexfield segment.
224 * @param p_attribute8 Descriptive flexfield segment.
225 * @param p_attribute9 Descriptive flexfield segment.
226 * @param p_attribute10 Descriptive flexfield segment.
227 * @param p_attribute11 Descriptive flexfield segment.
228 * @param p_attribute12 Descriptive flexfield segment.
229 * @param p_attribute13 Descriptive flexfield segment.
230 * @param p_attribute14 Descriptive flexfield segment.
231 * @param p_attribute15 Descriptive flexfield segment.
232 * @param p_attribute16 Descriptive flexfield segment.
233 * @param p_attribute17 Descriptive flexfield segment.
234 * @param p_attribute18 Descriptive flexfield segment.
235 * @param p_attribute19 Descriptive flexfield segment.
236 * @param p_attribute20 Descriptive flexfield segment.
237 * @param p_information_category This context value determines which flexfield
238 * structure to use with the developer descriptive flexfield segments.
239 * @param p_information1 Developer descriptive flexfield segment.
240 * @param p_information2 Developer descriptive flexfield segment.
241 * @param p_information3 Developer descriptive flexfield segment.
242 * @param p_information4 Developer descriptive flexfield segment.
243 * @param p_information5 Developer descriptive flexfield segment.
247 * @param p_information9 Developer descriptive flexfield segment.
244 * @param p_information6 Developer descriptive flexfield segment.
245 * @param p_information7 Developer descriptive flexfield segment.
246 * @param p_information8 Developer descriptive flexfield segment.
248 * @param p_information10 Developer descriptive flexfield segment.
249 * @param p_information11 Developer descriptive flexfield segment.
250 * @param p_information12 Developer descriptive flexfield segment.
251 * @param p_information13 Developer descriptive flexfield segment.
252 * @param p_information14 Developer descriptive flexfield segment.
253 * @param p_information15 Developer descriptive flexfield segment.
254 * @param p_information16 Developer descriptive flexfield segment.
255 * @param p_information17 Developer descriptive flexfield segment.
256 * @param p_information18 Developer descriptive flexfield segment.
257 * @param p_information19 Developer descriptive flexfield segment.
258 * @param p_information20 Developer descriptive flexfield segment.
259 * @param p_object_version_number Pass in the current version number of the
260 * checklist task to be updated. When the API completes if p_validate
261 * is false, it will be set to the new version number of the updated checklist
262 * task. If p_validate is true it will be set to the same value which was
263 * passed in.
264 * @rep:displayname Update Checklist Task
265 * @rep:category BUSINESS_ENTITY PER_CHECKLIST
266 * @rep:lifecycle active
267 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
268 * @rep:scope public
269 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
270 */
271 --
272 -- {End Of Comments}
273 --
274 procedure UPDATE_TASK_IN_CKL
275 (p_validate in boolean default false
276 ,p_effective_date in date
277 ,p_task_in_checklist_id in number
278 ,p_checklist_id in number
279 ,p_checklist_task_name in varchar2
280 ,p_eligibility_object_id in number default null
281 ,p_eligibility_profile_id in number default null
282 ,p_ame_attribute_identifier in varchar2 default null
283 ,p_description in varchar2 default null
284 ,p_task_sequence in number default null
285 ,p_mandatory in varchar2 default null
286 ,p_target_duration in number default null
287 ,p_target_duration_uom in varchar2 default null
288 ,p_action_url in varchar2 default null
289 ,p_attribute_category in varchar2 default null
290 ,p_attribute1 in varchar2 default null
291 ,p_attribute2 in varchar2 default null
292 ,p_attribute3 in varchar2 default null
293 ,p_attribute4 in varchar2 default null
294 ,p_attribute5 in varchar2 default null
295 ,p_attribute6 in varchar2 default null
296 ,p_attribute7 in varchar2 default null
297 ,p_attribute8 in varchar2 default null
298 ,p_attribute9 in varchar2 default null
299 ,p_attribute10 in varchar2 default null
300 ,p_attribute11 in varchar2 default null
301 ,p_attribute12 in varchar2 default null
302 ,p_attribute13 in varchar2 default null
303 ,p_attribute14 in varchar2 default null
304 ,p_attribute15 in varchar2 default null
305 ,p_attribute16 in varchar2 default null
306 ,p_attribute17 in varchar2 default null
307 ,p_attribute18 in varchar2 default null
308 ,p_attribute19 in varchar2 default null
309 ,p_attribute20 in varchar2 default null
310 ,p_information_category in varchar2 default null
311 ,p_information1 in varchar2 default null
312 ,p_information2 in varchar2 default null
313 ,p_information3 in varchar2 default null
314 ,p_information4 in varchar2 default null
315 ,p_information5 in varchar2 default null
316 ,p_information6 in varchar2 default null
317 ,p_information7 in varchar2 default null
318 ,p_information8 in varchar2 default null
319 ,p_information9 in varchar2 default null
320 ,p_information10 in varchar2 default null
321 ,p_information11 in varchar2 default null
322 ,p_information12 in varchar2 default null
323 ,p_information13 in varchar2 default null
324 ,p_information14 in varchar2 default null
325 ,p_information15 in varchar2 default null
326 ,p_information16 in varchar2 default null
327 ,p_information17 in varchar2 default null
328 ,p_information18 in varchar2 default null
329 ,p_information19 in varchar2 default null
330 ,p_information20 in varchar2 default null
331 ,p_object_version_number in out nocopy number
332 );
333 --
334 -- ----------------------------------------------------------------------------
335 -- |----------------------------< delete_task_in_ckl >------------------------|
336 -- ----------------------------------------------------------------------------
337 --
338 -- {Start Of Comments}
339 /*#
340 * This API deletes an existing checklist task.
341 *
342 * <p><b>Licensing</b><br>
343 * This API is licensed for use with HR Foundation.
344 *
345 * <p><b>Prerequisites</b><br>
346 * The checklist task that is to be deleted must already exist.
347 *
348 * <p><b>Post Success</b><br>
349 * The API deletes the checklist task successfully from the database.
350 *
351 * <p><b>Post Failure</b><br>
352 * The checklist task is not deleted from the database and an error is raised.
353 *
354 * @param p_validate If true, then validation alone will be performed and the
355 * database will remain unchanged. If false and all validation checks pass,
356 * then the database will be modified.
357 * @param p_task_in_checklist_id Identifies the checklist task to be deleted.
358 * @param p_object_version_number Current version number of the checklist
359 * task to be deleted.
360 * @rep:displayname Delete Checklist Task
361 * @rep:category BUSINESS_ENTITY PER_CHECKLIST
362 * @rep:lifecycle active
363 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
364 * @rep:scope public
365 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
366 */
367 --
368 -- {End Of Comments}
369 --
370 procedure DELETE_TASK_IN_CKL
371 (p_validate in boolean default false
372 ,p_task_in_checklist_id in number
373 ,p_object_version_number in number
374 );
375
376
377 end PER_TASKS_IN_CHECKLIST_API;