1 Package ota_lp_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otlpeapi.pkh 120.7 2006/07/12 11:14:59 niarora noship $ */
3 /*#
4 * This package contains learning path enrollment APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Learning Path Enrollment
11 -- |---------------------------< create_lp_enrollment >-----------------------|
8 */
9 --
10 -- ----------------------------------------------------------------------------
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the learning path enrollment.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Learning Management.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The Learning Path, Learning Path Section and Learning Path Member records
24 * must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The learning path enrollment record is created successfully.
28 *
29 * <p><b>Post Failure</b><br>
30 * The learning path enrollment record is not created and an error is raised.
31 *
32 * @param p_effective_date Reference date for validating lookup values are
33 * applicable during the start to end active date range. This date does not
34 * determine when the changes take effect.
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_learning_path_id The unique identifier of the learning path for
39 * which enrollment is being done.
40 * @param p_person_id Identifies the person for whom you create the learning
41 * path enrollment record.
42 * @param p_contact_id Identifies the external contact for whom you create the
43 * learning path enrollment record.
44 * @param p_path_status_code Status of the learning path enrollment. Valid
45 * values are defined by 'OTA_LEARNING_PATH_STATUS' lookup type.
46 * @param p_enrollment_source_code Source of the learning path enrollment.
47 * Valid values are defined by 'OTA_TRAINING_PLAN_SOURCE' lookup type.
48 * @param p_no_of_mandatory_courses Number of mandatory courses in the learning
49 * path.
50 * @param p_no_of_completed_courses Number of courses in the learning path,
51 * completed by the learner.
52 * @param p_completion_target_date Date before which the learner has to
53 * complete the learning path.
54 * @param p_completion_date Date on which the learner has completed the
55 * learning path.
56 * @param p_creator_person_id Identifies the person who has created the
57 * learning path enrollment for the learner.
58 * @param p_business_group_id The unique identifer of the business group to
59 * which the learning path belongs.
60 * @param p_attribute_category This context value determines which flexfield
61 * structure to use with the descriptive flexfield segments.
62 * @param p_attribute1 Descriptive flexfield segment.
63 * @param p_attribute2 Descriptive flexfield segment.
64 * @param p_attribute3 Descriptive flexfield segment.
65 * @param p_attribute4 Descriptive flexfield segment.
66 * @param p_attribute5 Descriptive flexfield segment.
67 * @param p_attribute6 Descriptive flexfield segment.
68 * @param p_attribute7 Descriptive flexfield segment.
69 * @param p_attribute8 Descriptive flexfield segment.
70 * @param p_attribute9 Descriptive flexfield segment.
71 * @param p_attribute10 Descriptive flexfield segment.
72 * @param p_attribute11 Descriptive flexfield segment.
73 * @param p_attribute12 Descriptive flexfield segment.
74 * @param p_attribute13 Descriptive flexfield segment.
75 * @param p_attribute14 Descriptive flexfield segment.
76 * @param p_attribute15 Descriptive flexfield segment.
77 * @param p_attribute16 Descriptive flexfield segment.
78 * @param p_attribute17 Descriptive flexfield segment.
79 * @param p_attribute18 Descriptive flexfield segment.
80 * @param p_attribute19 Descriptive flexfield segment.
81 * @param p_attribute20 Descriptive flexfield segment.
82 * @param p_attribute21 Descriptive flexfield segment.
83 * @param p_attribute22 Descriptive flexfield segment.
84 * @param p_attribute23 Descriptive flexfield segment.
85 * @param p_attribute24 Descriptive flexfield segment.
86 * @param p_attribute25 Descriptive flexfield segment.
87 * @param p_attribute26 Descriptive flexfield segment.
88 * @param p_attribute27 Descriptive flexfield segment.
89 * @param p_attribute28 Descriptive flexfield segment.
90 * @param p_attribute29 Descriptive flexfield segment.
91 * @param p_attribute30 Descriptive flexfield segment.
92 * @param p_lp_enrollment_id Identifies the learning path enrollment record.
93 * @param p_object_version_number If p_validate is false, then set to the
94 * version number of the created learning path enrollment. If p_validate is
95 * true, then the value will be null.
96 * @param p_is_history_flag Determines whether the learning path enrollment
97 * record should be moved to history once completed. Valid values are Y
98 * and N. Default value is N.
99 * @rep:displayname Create Learning Path Enrollment
100 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
101 * @rep:lifecycle active
102 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
103 * @rep:scope public
104 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
105 */
106 --
107 -- {End Of Comments}
108 --
109 procedure create_lp_enrollment
110 (
111 p_effective_date in date,
112 p_validate in boolean default false ,
113 p_learning_path_id in number,
114 p_person_id in number default null,
115 p_contact_id in number default null,
116 p_path_status_code in varchar2,
117 p_enrollment_source_code in varchar2,
118 p_no_of_mandatory_courses in number default null,
119 p_no_of_completed_courses in number default null,
120 p_completion_target_date in date default null,
121 p_completion_date in date default null,
125 p_attribute1 in varchar2 default null,
122 p_creator_person_id in number default null,
123 p_business_group_id in number,
124 p_attribute_category in varchar2 default null,
126 p_attribute2 in varchar2 default null,
127 p_attribute3 in varchar2 default null,
128 p_attribute4 in varchar2 default null,
129 p_attribute5 in varchar2 default null,
130 p_attribute6 in varchar2 default null,
131 p_attribute7 in varchar2 default null,
132 p_attribute8 in varchar2 default null,
133 p_attribute9 in varchar2 default null,
134 p_attribute10 in varchar2 default null,
135 p_attribute11 in varchar2 default null,
136 p_attribute12 in varchar2 default null,
137 p_attribute13 in varchar2 default null,
138 p_attribute14 in varchar2 default null,
139 p_attribute15 in varchar2 default null,
140 p_attribute16 in varchar2 default null,
141 p_attribute17 in varchar2 default null,
142 p_attribute18 in varchar2 default null,
143 p_attribute19 in varchar2 default null,
144 p_attribute20 in varchar2 default null,
145 p_attribute21 in varchar2 default null,
146 p_attribute22 in varchar2 default null,
147 p_attribute23 in varchar2 default null,
148 p_attribute24 in varchar2 default null,
149 p_attribute25 in varchar2 default null,
150 p_attribute26 in varchar2 default null,
151 p_attribute27 in varchar2 default null,
152 p_attribute28 in varchar2 default null,
153 p_attribute29 in varchar2 default null,
154 p_attribute30 in varchar2 default null,
155 p_IS_HISTORY_FLAG in varchar2 default 'N',
156 p_lp_enrollment_id out nocopy number,
157 p_object_version_number out nocopy number
158 );
159 --
160 -- ----------------------------------------------------------------------------
161 -- |---------------------------< update_lp_enrollment >-----------------------|
162 -- ----------------------------------------------------------------------------
163 --
164 -- {Start Of Comments}
165 /*#
166 * This API updates the learning path enrollment.
167 *
168 *
169 * <p><b>Licensing</b><br>
170 * This API is licensed for use with Learning Management.
171 *
172 * <p><b>Prerequisites</b><br>
173 * The learning path enrollment record with the given object version number
174 * must exist.
175 *
176 * <p><b>Post Success</b><br>
177 * The learning path enrollment record is updated successfully.
178 *
179 * <p><b>Post Failure</b><br>
180 * The learning path enrollment record is not updated and an error is raised.
181 *
182 * @param p_effective_date Reference date for validating lookup values are
183 * applicable during the start to end active date range. This date does not
184 * determine when the changes take effect.
185 * @param p_lp_enrollment_id Identifies the learning path enrollment record
186 * that is to be modified.
187 * @param p_object_version_number Pass in the current version number of the
188 * learning path enrollment to be updated. When the API completes if p_validate
189 * is false, will be set to the new version number of the updated learning path
190 * enrollment. If p_validate is true will be set to the same value which was
191 * passed in.
192 * @param p_person_id Identifies the person for whom you create the learning
193 * path enrollment record.
194 * @param p_contact_id Identifies the external contact for whom you create the
195 * learning path enrollment record.
196 * @param p_path_status_code Status of the learning path enrollment. Valid
197 * values are defined by 'OTA_LEARNING_PATH_STATUS' lookup type.
198 * @param p_enrollment_source_code Source of the learning path enrollment.
199 * Valid values are defined by 'OTA_TRAINING_PLAN_SOURCE' lookup type.
200 * @param p_no_of_mandatory_courses Number of mandatory courses in the learning
201 * path.
202 * @param p_no_of_completed_courses Number of courses in the learning path,
203 * completed by the learner.
204 * @param p_completion_target_date Date before which the learner has to
205 * complete the learning path.
206 * @param p_completion_date Date on which the learner has completed the
207 * learning path.
208 * @param p_creator_person_id Identifies the person who has created the
209 * learning path enrollment for the learner.
210 * @param p_attribute_category This context value determines which flexfield
211 * structure to use with the descriptive flexfield segments.
212 * @param p_attribute1 Descriptive flexfield segment.
213 * @param p_attribute2 Descriptive flexfield segment.
214 * @param p_attribute3 Descriptive flexfield segment.
215 * @param p_attribute4 Descriptive flexfield segment.
216 * @param p_attribute5 Descriptive flexfield segment.
217 * @param p_attribute6 Descriptive flexfield segment.
218 * @param p_attribute7 Descriptive flexfield segment.
219 * @param p_attribute8 Descriptive flexfield segment.
220 * @param p_attribute9 Descriptive flexfield segment.
221 * @param p_attribute10 Descriptive flexfield segment.
222 * @param p_attribute11 Descriptive flexfield segment.
223 * @param p_attribute12 Descriptive flexfield segment.
224 * @param p_attribute13 Descriptive flexfield segment.
225 * @param p_attribute14 Descriptive flexfield segment.
226 * @param p_attribute15 Descriptive flexfield segment.
227 * @param p_attribute16 Descriptive flexfield segment.
228 * @param p_attribute17 Descriptive flexfield segment.
229 * @param p_attribute18 Descriptive flexfield segment.
230 * @param p_attribute19 Descriptive flexfield segment.
231 * @param p_attribute20 Descriptive flexfield segment.
232 * @param p_attribute21 Descriptive flexfield segment.
233 * @param p_attribute22 Descriptive flexfield segment.
234 * @param p_attribute23 Descriptive flexfield segment.
235 * @param p_attribute24 Descriptive flexfield segment.
236 * @param p_attribute25 Descriptive flexfield segment.
237 * @param p_attribute26 Descriptive flexfield segment.
238 * @param p_attribute27 Descriptive flexfield segment.
239 * @param p_attribute28 Descriptive flexfield segment.
240 * @param p_attribute29 Descriptive flexfield segment.
241 * @param p_attribute30 Descriptive flexfield segment.
242 * @param p_business_group_id The unique identifer of the business group to
243 * which the learning path belongs.
244 * @param p_validate If true, then validation alone will be performed and the
245 * database will remain unchanged. If false and all validation checks pass,
246 * then the database will be modified.
247 * @param p_is_history_flag Determines whether the learning path enrollment
248 * record should be moved to history once completed. Valid values are Y
249 * and N. Default value is N.
250 * @rep:displayname Update Learning Path Enrollment
251 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
252 * @rep:lifecycle active
253 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
254 * @rep:scope public
255 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
256 */
257 --
258 -- {End Of Comments}
259 --
260 procedure Update_lp_enrollment
261 (
262 p_effective_date in date,
263 p_lp_enrollment_id in number,
264 p_object_version_number in out nocopy number,
265 p_person_id in number default hr_api.g_number,
266 p_contact_id in number default hr_api.g_number,
267 p_path_status_code in varchar2 default hr_api.g_varchar2,
268 p_enrollment_source_code in varchar2 default hr_api.g_varchar2,
269 p_no_of_mandatory_courses in number default hr_api.g_number,
270 p_no_of_completed_courses in number default hr_api.g_number,
271 p_completion_target_date in date default hr_api.g_date,
272 p_completion_date in date default hr_api.g_date,
273 p_creator_person_id in number default hr_api.g_number,
274 p_attribute_category in varchar2 default hr_api.g_varchar2,
275 p_attribute1 in varchar2 default hr_api.g_varchar2,
276 p_attribute2 in varchar2 default hr_api.g_varchar2,
277 p_attribute3 in varchar2 default hr_api.g_varchar2,
278 p_attribute4 in varchar2 default hr_api.g_varchar2,
279 p_attribute5 in varchar2 default hr_api.g_varchar2,
280 p_attribute6 in varchar2 default hr_api.g_varchar2,
281 p_attribute7 in varchar2 default hr_api.g_varchar2,
282 p_attribute8 in varchar2 default hr_api.g_varchar2,
283 p_attribute9 in varchar2 default hr_api.g_varchar2,
284 p_attribute10 in varchar2 default hr_api.g_varchar2,
285 p_attribute11 in varchar2 default hr_api.g_varchar2,
286 p_attribute12 in varchar2 default hr_api.g_varchar2,
287 p_attribute13 in varchar2 default hr_api.g_varchar2,
288 p_attribute14 in varchar2 default hr_api.g_varchar2,
289 p_attribute15 in varchar2 default hr_api.g_varchar2,
290 p_attribute16 in varchar2 default hr_api.g_varchar2,
291 p_attribute17 in varchar2 default hr_api.g_varchar2,
292 p_attribute18 in varchar2 default hr_api.g_varchar2,
293 p_attribute19 in varchar2 default hr_api.g_varchar2,
294 p_attribute20 in varchar2 default hr_api.g_varchar2,
295 p_attribute21 in varchar2 default hr_api.g_varchar2,
296 p_attribute22 in varchar2 default hr_api.g_varchar2,
297 p_attribute23 in varchar2 default hr_api.g_varchar2,
298 p_attribute24 in varchar2 default hr_api.g_varchar2,
299 p_attribute25 in varchar2 default hr_api.g_varchar2,
300 p_attribute26 in varchar2 default hr_api.g_varchar2,
301 p_attribute27 in varchar2 default hr_api.g_varchar2,
302 p_attribute28 in varchar2 default hr_api.g_varchar2,
303 p_attribute29 in varchar2 default hr_api.g_varchar2,
304 p_attribute30 in varchar2 default hr_api.g_varchar2,
305 p_is_history_flag in varchar2 default hr_api.g_varchar2,
306 p_business_group_id in number default hr_api.g_number,
307 p_validate in boolean default false
308 );
309 --
310 -- ----------------------------------------------------------------------------
311 -- |---------------------------< delete_lp_enrollment >-----------------------|
312 -- ----------------------------------------------------------------------------
313 --
314 -- {Start Of Comments}
315 /*#
316 * This API deletes the learning path enrollment record.
317 *
318 * This business process allows the user to delete a Learning Path Enrollment
319 * within the Learning Path functionality.
320 *
321 * <p><b>Licensing</b><br>
322 * This API is licensed for use with Learning Management.
323 *
324 * <p><b>Prerequisites</b><br>
325 * All the learning path component enrollment records must be deleted before
326 * deleting the learning path enrollment.
327 *
328 * <p><b>Post Success</b><br>
329 * The learning path enrollment record is deleted successfully.
330 *
331 * <p><b>Post Failure</b><br>
332 * The learning path enrollment record is not deleted and an error is raised.
333 *
334 * @param p_lp_enrollment_id Identifies the learning path enrollment record
335 * that is to be deleted.
336 * @param p_object_version_number Current version number of the learning path
337 * enrollment to be deleted.
338 * @param p_validate If true, then validation alone will be performed and the
339 * database will remain unchanged. If false and all validation checks pass,
340 * then the database will be modified.
341 * @rep:displayname Delete Learning Path Enrollment
342 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
343 * @rep:lifecycle active
344 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
345 * @rep:scope public
346 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
347 */
348 --
349 -- {End Of Comments}
350 --
351 procedure delete_lp_enrollment
352 (p_lp_enrollment_id in number
353 ,p_object_version_number in number
354 ,p_validate in boolean default false
355 );
356 --
357 -- ----------------------------------------------------------------------------
358 -- |------------------------< subscribe_to_learning_path >--------------------|
359 -- ----------------------------------------------------------------------------
360 --
361 -- {Start Of Comments}
362 /*#
363 * This API creates a Learning Path Subscription.
364 *
365 *
366 * <p><b>Licensing</b><br>
367 * This API is licensed for use with Learning Management.
368 *
369 * <p><b>Prerequisites</b><br>
370 * The Learning Path should exist.
371 *
372 * <p><b>Post Success</b><br>
373 * Learning Path Enrollment and Learning Path Member Enrollment records are created.
374 *
375 * <p><b>Post Failure</b><br>
376 * No Learning Path enrollment records are created, and an error is raised.
377 *
378 * @param p_validate If true, then validation alone will be performed and the
379 * database will remain unchanged. If false and all validation checks pass,
380 * then the database will be modified.
381 * @param p_learning_path_id The unique identifier of the learning path being subscribed to.
382 * @param p_person_id Identifies the person subscribing to the learning path.
383 * @param p_contact_id Identifies the external contact subscribing to the learning path.
384 * @param p_enrollment_source_code Source of the learning path enrollment. Valid values are
385 * defined by the 'OTA_TRAINING_PLAN_SOURCE' lookup type.
386 * @param p_business_group_id The business group owning the section record and the Learning Path.
387 * @param p_creator_person_id Identifies the person who has created the learning path subscription for the learner.
388 * @param p_attribute_category This context value determines which flexfield
389 * structure to use with the descriptive flexfield segments.
390 * @param p_attribute1 Descriptive flexfield segment.
391 * @param p_attribute2 Descriptive flexfield segment.
392 * @param p_attribute3 Descriptive flexfield segment.
393 * @param p_attribute4 Descriptive flexfield segment.
394 * @param p_attribute5 Descriptive flexfield segment.
395 * @param p_attribute6 Descriptive flexfield segment.
396 * @param p_attribute7 Descriptive flexfield segment.
397 * @param p_attribute8 Descriptive flexfield segment.
398 * @param p_attribute9 Descriptive flexfield segment.
399 * @param p_attribute10 Descriptive flexfield segment.
400 * @param p_attribute11 Descriptive flexfield segment.
401 * @param p_attribute12 Descriptive flexfield segment.
402 * @param p_attribute13 Descriptive flexfield segment.
403 * @param p_attribute14 Descriptive flexfield segment.
404 * @param p_attribute15 Descriptive flexfield segment.
405 * @param p_attribute16 Descriptive flexfield segment.
406 * @param p_attribute17 Descriptive flexfield segment.
407 * @param p_attribute18 Descriptive flexfield segment.
408 * @param p_attribute19 Descriptive flexfield segment.
409 * @param p_attribute20 Descriptive flexfield segment.
410 * @param p_attribute21 Descriptive flexfield segment.
411 * @param p_attribute22 Descriptive flexfield segment.
412 * @param p_attribute23 Descriptive flexfield segment.
413 * @param p_attribute24 Descriptive flexfield segment.
414 * @param p_attribute25 Descriptive flexfield segment.
415 * @param p_attribute26 Descriptive flexfield segment.
416 * @param p_attribute27 Descriptive flexfield segment.
417 * @param p_attribute28 Descriptive flexfield segment.
418 * @param p_attribute29 Descriptive flexfield segment.
419 * @param p_attribute30 Descriptive flexfield segment.
420 * @param p_lp_enrollment_id Identifies the learning path enrollment record.
421 * @param p_path_status_code Status of the learning path subscription. Valid values
422 * are defined by the 'OTA_LEARNING_PATH_STATUS' lookup type
423 * @rep:displayname Learning Path Enrollment
424 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
425 * @rep:lifecycle active
426 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
427 * @rep:scope public
428 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
429 */
430 --
431 -- {End Of Comments}
432 --
433 procedure subscribe_to_learning_path
434 (p_validate in boolean default false
435 ,p_learning_path_id IN NUMBER
436 ,p_person_id IN NUMBER default null
437 ,p_contact_id IN NUMBER default null
438 ,p_enrollment_source_code IN VARCHAR2
439 ,p_business_group_id IN NUMBER
440 ,p_creator_person_id IN NUMBER
441 ,p_attribute_category IN VARCHAR2 default NULL
442 ,p_attribute1 IN VARCHAR2 default NULL
443 ,p_attribute2 IN VARCHAR2 default NULL
444 ,p_attribute3 IN VARCHAR2 default NULL
445 ,p_attribute4 IN VARCHAR2 default NULL
446 ,p_attribute5 IN VARCHAR2 default NULL
447 ,p_attribute6 IN VARCHAR2 default NULL
448 ,p_attribute7 IN VARCHAR2 default NULL
449 ,p_attribute8 IN VARCHAR2 default NULL
450 ,p_attribute9 IN VARCHAR2 default NULL
451 ,p_attribute10 IN VARCHAR2 default NULL
452 ,p_attribute11 IN VARCHAR2 default NULL
453 ,p_attribute12 IN VARCHAR2 default NULL
454 ,p_attribute13 IN VARCHAR2 default NULL
455 ,p_attribute14 IN VARCHAR2 default NULL
456 ,p_attribute15 IN VARCHAR2 default NULL
457 ,p_attribute16 IN VARCHAR2 default NULL
458 ,p_attribute17 IN VARCHAR2 default NULL
459 ,p_attribute18 IN VARCHAR2 default NULL
460 ,p_attribute19 IN VARCHAR2 default NULL
461 ,p_attribute20 IN VARCHAR2 default NULL
462 ,p_attribute21 IN VARCHAR2 default NULL
463 ,p_attribute22 IN VARCHAR2 default NULL
464 ,p_attribute23 IN VARCHAR2 default NULL
465 ,p_attribute24 IN VARCHAR2 default NULL
466 ,p_attribute25 IN VARCHAR2 default NULL
467 ,p_attribute26 IN VARCHAR2 default NULL
468 ,p_attribute27 IN VARCHAR2 default NULL
469 ,p_attribute28 IN VARCHAR2 default NULL
470 ,p_attribute29 IN VARCHAR2 default NULL
471 ,p_attribute30 IN VARCHAR2 default NULL
472 ,p_lp_enrollment_id OUT NOCOPY number
473 ,p_path_status_code OUT NOCOPY VARCHAR2
474 );
475 end ota_lp_enrollment_api;
[Home] [Help]