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