1 PACKAGE ota_event_api AUTHID CURRENT_USER as
2 /* $Header: otevtapi.pkh 120.2 2008/01/29 09:23:39 smahanka noship $ */
3 /*#
4 * This package contains the class APIs.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Class
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_class >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a class into which the learners enroll.
17 *
18 * This business process enables the entry of class details.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Learning Management.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The parent offering must already exist before a class can be created. The
25 * parent offering must exist in the same business group as the business group
26 * of the class, and must be active within the class dates being entered.
27 *
28 * <p><b>Post Success</b><br>
29 * When the class has been successfully inserted, the following OUT parameters
30 * are set.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create a class, and raises an error.
34 * @param p_effective_date Reference date for validating lookup values are
35 * applicable during the start to end active date range. This date does not
36 * determine when the changes take effect.
37 * @param p_event_id If p_validate is false, then this ID uniquely identifies
38 * the class created. If p_validate is true, then it is set to null.
39 * @param p_vendor_id Foreign key to PO_VENDORS. The vendor hosting the class.
40 * @param p_activity_version_id Foreign key to OTA_ACTIVITY_VERSIONS. The
41 * course to which this class belongs.
42 * @param p_business_group_id The business group owning the class.
43 * @param p_organization_id Foreign key to HR_ALL_ORGANIZATION_UNITS. The
44 * organization to which this class belongs.
45 * @param p_event_type Class type. Valid values are defined by the
46 * 'TRAINING_EVENT_TYPE' lookup type.
47 * @param p_object_version_number If p_validate is false, then the number is
48 * set to the version number of the created class. If p_validate is true, then
49 * the value is null.
50 * @param p_title Class's title.
51 * @param p_budget_cost The budgeted cost for the class.
52 * @param p_actual_cost The actual cost of the class.
53 * @param p_budget_currency_code The currency for the budgeted cost.
54 * @param p_centre Obsolete parameter, do not use.
55 * @param p_comments Comment text.
56 * @param p_course_end_date The date on which the class ends.
57 * @param p_course_end_time The end time of the class.
58 * @param p_course_start_date The date on which the class starts.
59 * @param p_course_start_time The start time of the class.
60 * @param p_duration The duration of the class measured in units. The unit of
61 * measure is specified in the column DURATION_UNITS.
62 * @param p_duration_units The units in which the duration is measured. Valid
63 * values are defined by the 'OTA_FREQUENCY' lookup type.
64 * @param p_enrolment_end_date The closing date for enrollments in this class.
65 * @param p_enrolment_start_date The earliest date on which enrollments may be
66 * made for this class.
67 * @param p_language_id The language in which this class is taught. This is
68 * defaulted from the parent offering for the class.
69 * @param p_user_status User definition for the class status.
70 * @param p_development_event_type User description for the development type
71 * defined.
72 * @param p_event_status Class status. Valid values are defined by the
73 * 'SCHEDULED_EVENT_STATUS' lookup type.
74 * @param p_price_basis Price basis for this class. Valid values are defined by
75 * the 'EVENT_PRICE_BASIS' lookup type.
76 * @param p_currency_code The currency in which the standard price is defined.
77 * @param p_maximum_attendees The maximum number of learners who may take this
78 * class.
79 * @param p_maximum_internal_attendees The maximum number of internal learners
80 * who may take this class.
81 * @param p_minimum_attendees The minimum number of learners for this class to
82 * be viable.
83 * @param p_standard_price The standard price per enrollment for this class. A
84 * standard price can be per student (learner), per customer, or per order.
85 * @param p_category_code Indicates the program of courses for this class.
86 * @param p_parent_event_id Relevant for classes with type SESSION only. This
87 * indicates the parent class for the SESSION.
88 * @param p_book_independent_flag This flag indicates whether this class can
89 * occur independently of a program.
90 * @param p_public_event_flag This flag indicates whether a class can have
91 * learner access associated with it.
92 * @param p_secure_event_flag This flag indicates if a class can be maintained
93 * only by employees of the administering organization.
94 * @param p_evt_information_category This context value determines which
95 * Flexfield Structure to use with the Descriptive flexfield segments.
96 * @param p_evt_information1 Descriptive flexfield segment.
97 * @param p_evt_information2 Descriptive flexfield segment.
98 * @param p_evt_information3 Descriptive flexfield segment.
99 * @param p_evt_information4 Descriptive flexfield segment.
100 * @param p_evt_information5 Descriptive flexfield segment.
101 * @param p_evt_information6 Descriptive flexfield segment.
102 * @param p_evt_information7 Descriptive flexfield segment.
103 * @param p_evt_information8 Descriptive flexfield segment.
104 * @param p_evt_information9 Descriptive flexfield segment.
105 * @param p_evt_information10 Descriptive flexfield segment.
106 * @param p_evt_information11 Descriptive flexfield segment.
107 * @param p_evt_information12 Descriptive flexfield segment.
108 * @param p_evt_information13 Descriptive flexfield segment.
109 * @param p_evt_information14 Descriptive flexfield segment.
110 * @param p_evt_information15 Descriptive flexfield segment.
111 * @param p_evt_information16 Descriptive flexfield segment.
112 * @param p_evt_information17 Descriptive flexfield segment.
113 * @param p_evt_information18 Descriptive flexfield segment.
114 * @param p_evt_information19 Descriptive flexfield segment.
115 * @param p_evt_information20 Descriptive flexfield segment.
116 * @param p_project_id Foreign key to PA_PROJECTS_ALL.
117 * @param p_owner_id Foreign key to PER_ALL_PEOPLE_F.
118 * @param p_line_id Foreign key to OE_ORDER_LINES_ALL.
119 * @param p_org_id Foreign key to HR_ALL_ORGANIZATION_UNITS. The organization
120 * that is associated with the enrollment through OM or OTA.
121 * @param p_training_center_id Foreign key to HR_ALL_ORGANIZATIONS_UNITS.
122 * @param p_location_id Foreign key to HR_LOCATIONS.
123 * @param p_offering_id Obsolete parameter, do not use. This is the
124 * corresponding iLearning offering for this class.
125 * @param p_timezone Time zone of the class.
126 * @param p_parent_offering_id Foreign key to OTA_OFFERINGS. This specifies the
127 * parent of the class being created.
128 * @param p_data_source Source of the class being created. Valid values are
129 * defined by the 'OTA_OBJECT_DATA_SOURCE' lookup type.
130 * @param p_validate If true, then only validation will be performed and the
131 * database remains unchanged. If false, then all validation checks pass and
132 * the database will be modified.
133 * @rep:displayname Create Class
134 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CLASS
135 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
136 * @rep:scope public
137 * @rep:lifecycle active
138 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
139 */
140 --
141 -- {End Of Comments}
142 --
143 procedure Create_class
144 (p_effective_date in date
145 ,p_event_id out nocopy number,
146 p_vendor_id in number default null,
147 p_activity_version_id in number default null,
148 p_business_group_id in number,
149 p_organization_id in number default null,
150 p_event_type in varchar2,
151 p_object_version_number out nocopy number,
152 p_title in varchar2,
153 p_budget_cost in number default null,
154 p_actual_cost in number default null,
155 p_budget_currency_code in varchar2 default null,
156 p_centre in varchar2 default null,
157 p_comments in varchar2 default null,
158 p_course_end_date in date default null,
159 p_course_end_time in varchar2 default null,
160 p_course_start_date in date default null,
161 p_course_start_time in varchar2 default null,
162 p_duration in number default null,
163 p_duration_units in varchar2 default null,
164 p_enrolment_end_date in date default null,
165 p_enrolment_start_date in date default null,
166 p_language_id in number default null,
167 p_user_status in varchar2 default null,
168 p_development_event_type in varchar2 default null,
169 p_event_status in varchar2 default null,
170 p_price_basis in varchar2 default null,
171 p_currency_code in varchar2 default null,
172 p_maximum_attendees in number default null,
173 p_maximum_internal_attendees in number default null,
174 p_minimum_attendees in number default null,
175 p_standard_price in number default null,
176 p_category_code in varchar2 default null,
177 p_parent_event_id in number default null,
178 p_book_independent_flag in varchar2 default null,
179 p_public_event_flag in varchar2 default null,
180 p_secure_event_flag in varchar2 default null,
181 p_evt_information_category in varchar2 default null,
182 p_evt_information1 in varchar2 default null,
183 p_evt_information2 in varchar2 default null,
184 p_evt_information3 in varchar2 default null,
185 p_evt_information4 in varchar2 default null,
186 p_evt_information5 in varchar2 default null,
187 p_evt_information6 in varchar2 default null,
188 p_evt_information7 in varchar2 default null,
189 p_evt_information8 in varchar2 default null,
190 p_evt_information9 in varchar2 default null,
191 p_evt_information10 in varchar2 default null,
192 p_evt_information11 in varchar2 default null,
193 p_evt_information12 in varchar2 default null,
194 p_evt_information13 in varchar2 default null,
195 p_evt_information14 in varchar2 default null,
196 p_evt_information15 in varchar2 default null,
197 p_evt_information16 in varchar2 default null,
198 p_evt_information17 in varchar2 default null,
199 p_evt_information18 in varchar2 default null,
200 p_evt_information19 in varchar2 default null,
201 p_evt_information20 in varchar2 default null,
202 p_project_id in number default null,
203 p_owner_id in number default null,
204 p_line_id in number default null,
205 p_org_id in number default null,
206 p_training_center_id in number default null,
207 p_location_id in number default null,
208 p_offering_id in number default null,
209 p_timezone in varchar2 default null,
210 p_parent_offering_id in number default null,
211 p_data_source in varchar2 default null,
212 p_validate in boolean default false
213 );
214 --
215 -- ----------------------------------------------------------------------------
216 -- |-------------------------------< update_class >---------------------------|
217 -- ----------------------------------------------------------------------------
218 --
219 -- {Start Of Comments}
220 /*#
221 * This API updates a class into which learners are enrolling or have enrolled.
222 *
223 * This business process enables the user to update class details.
224 *
225 * <p><b>Licensing</b><br>
226 * This API is licensed for use with Learning Management.
227 *
228 * <p><b>Prerequisites</b><br>
229 * The class must exist.
230 *
231 * <p><b>Post Success</b><br>
232 * When the class has been successfully updated, the following OUT parameters
233 * are set.
234 *
235 * <p><b>Post Failure</b><br>
236 * The API does not update the class, and raises an error.
237 * @param p_event_id This parameter uniquely identifies the class being
238 * updated.
239 * @param p_effective_date Reference date for validating lookup values are
240 * applicable during the start to end active date range. This date does not
241 * determine when the changes take effect.
242 * @param p_vendor_id Foreign key to PO_VENDORS. The vendor hosting the class.
243 * @param p_activity_version_id Foreign key to OTA_ACTIVITY_VERSIONS. The
244 * course to which this class belongs.
245 * @param p_business_group_id The business group owning the class.
246 * @param p_organization_id Foreign key to HR_ALL_ORGANIZATION_UNITS. The
247 * organization to which this plan applies.
248 * @param p_event_type Class type. Valid values are defined by the
249 * 'TRAINING_EVENT_TYPE' lookup type.
250 * @param p_object_version_number Pass in the current version number of the
251 * class to be updated.When the API completes if p_validate is false, then the
252 * number is set to the version number of the updated class. If p_validate is
253 * true will be set to the same value which was passed in.
254 * @param p_title Class's title
255 * @param p_budget_cost The budgeted cost for the class.
256 * @param p_actual_cost The actual cost of the class.
257 * @param p_budget_currency_code The currency for the budgeted cost.
258 * @param p_centre Obsolete parameter, do not use.
259 * @param p_comments Comment text.
260 * @param p_course_end_date The date on which the class ends.
261 * @param p_course_end_time The end time of the class.
262 * @param p_course_start_date The date on which the class starts.
263 * @param p_course_start_time The start time of the class.
264 * @param p_duration The duration of the class measured in units. The unit of
265 * measure is specified in the column DURATION_UNITS.
266 * @param p_duration_units The units in which the duration is measured. Valid
267 * values are defined by the 'OTA_FREQUENCY' lookup type.
271 * @param p_language_id The language in which this class is taught. This is
268 * @param p_enrolment_end_date The closing date for enrollments in this class.
269 * @param p_enrolment_start_date The earliest date on which enrollments may be
270 * made for this class.
272 * defaulted from the parent offering for the class.
273 * @param p_user_status User definition for the class status.
274 * @param p_development_event_type User description for the development type
275 * defined.
276 * @param p_event_status Class status. Valid values are defined by the
277 * 'SCHEDULED_EVENT_STATUS' lookup type.
278 * @param p_price_basis Price basis for this class. Valid values are defined by
279 * the 'EVENT_PRICE_BASIS' lookup type.
280 * @param p_currency_code The currency in which the standard price is defined.
281 * @param p_maximum_attendees The maximum number of learners who may take this
282 * class.
283 * @param p_maximum_internal_attendees The maximum number of internal learners
284 * who may take this class.
285 * @param p_minimum_attendees The minimum number of learners for this class to
286 * be viable.
287 * @param p_standard_price The standard price per enrollment for this class. A
288 * standard price can be per student (learner), per customer, or per order.
289 * @param p_category_code Indicates the program of courses for this class.
290 * @param p_parent_event_id Relevant only for classes of the type SESSION. This
291 * indicates the parent class for the session.
292 * @param p_book_independent_flag This flag indicates whether this class can
293 * occur independently of a program.
294 * @param p_public_event_flag This flag indicates whether a class can have
295 * learner access associated with it.
296 * @param p_secure_event_flag This flag indicates if a class can be maintained
297 * only by employees of the administering organization.
298 * @param p_evt_information_category This context value determines which
299 * Flexfield Structure to use with the Descriptive flexfield segments.
300 * @param p_evt_information1 Descriptive flexfield segment.
301 * @param p_evt_information2 Descriptive flexfield segment.
302 * @param p_evt_information3 Descriptive flexfield segment.
303 * @param p_evt_information4 Descriptive flexfield segment.
304 * @param p_evt_information5 Descriptive flexfield segment.
305 * @param p_evt_information6 Descriptive flexfield segment.
306 * @param p_evt_information7 Descriptive flexfield segment.
307 * @param p_evt_information8 Descriptive flexfield segment.
308 * @param p_evt_information9 Descriptive flexfield segment.
309 * @param p_evt_information10 Descriptive flexfield segment.
310 * @param p_evt_information11 Descriptive flexfield segment.
311 * @param p_evt_information12 Descriptive flexfield segment.
312 * @param p_evt_information13 Descriptive flexfield segment.
313 * @param p_evt_information14 Descriptive flexfield segment.
314 * @param p_evt_information15 Descriptive flexfield segment.
315 * @param p_evt_information16 Descriptive flexfield segment.
316 * @param p_evt_information17 Descriptive flexfield segment.
317 * @param p_evt_information18 Descriptive flexfield segment.
318 * @param p_evt_information19 Descriptive flexfield segment.
319 * @param p_evt_information20 Descriptive flexfield segment.
320 * @param p_project_id Foreign key to PA_PROJECTS_ALL.
321 * @param p_owner_id Foreign key to PER_ALL_PEOPLE_F.
322 * @param p_line_id Foreign key to OE_ORDER_LINES_ALL.
323 * @param p_org_id Foreign key to HR_ALL_ORGANIZATION_UNITS. The organization
324 * that is associated with the enrollment through OM or OTA.
325 * @param p_training_center_id Foreign key to HR_ALL_ORGANIZATIONS_UNITS.
326 * @param p_location_id Foreign key to HR_LOCATIONS.
327 * @param p_offering_id Obsolete parameter, do not use. This is the
328 * corresponding iLearning offering for this class.
329 * @param p_timezone Time zone of the class.
330 * @param p_parent_offering_id Foreign key to OTA_OFFERINGS. This specifies the
331 * parent of the class being created.
332 * @param p_data_source Source of the class being created. Valid values are
333 * defined by the 'OTA_OBJECT_DATA_SOURCE' lookup type.
334 * @param p_validate If true, then only validation will be performed and the
335 * database remains unchanged. If false, then all validation checks pass and
336 * the database will be modified.
337 * @rep:displayname Update Class
338 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CLASS
339 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
340 * @rep:scope public
341 * @rep:lifecycle active
342 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
343 */
344 --
345 -- {End Of Comments}
346 --
347 procedure update_class
348 (p_event_id in number,
349 p_effective_date in date,
350 p_vendor_id in number default hr_api.g_number,
351 p_activity_version_id in number default hr_api.g_number,
352 p_business_group_id in number default hr_api.g_number,
353 p_organization_id in number default hr_api.g_number,
354 p_event_type in varchar2 default hr_api.g_varchar2,
355 p_object_version_number in out nocopy number,
356 p_title in varchar2 default hr_api.g_varchar2,
357 p_budget_cost in number default hr_api.g_number,
358 p_actual_cost in number default hr_api.g_number,
359 p_budget_currency_code in varchar2 default hr_api.g_varchar2,
360 p_centre in varchar2 default hr_api.g_varchar2,
361 p_comments in varchar2 default hr_api.g_varchar2,
365 p_course_start_time in varchar2 default hr_api.g_varchar2,
362 p_course_end_date in date default hr_api.g_date,
363 p_course_end_time in varchar2 default hr_api.g_varchar2,
364 p_course_start_date in date default hr_api.g_date,
366 p_duration in number default hr_api.g_number,
367 p_duration_units in varchar2 default hr_api.g_varchar2,
368 p_enrolment_end_date in date default hr_api.g_date,
369 p_enrolment_start_date in date default hr_api.g_date,
370 p_language_id in number default hr_api.g_number,
371 p_user_status in varchar2 default hr_api.g_varchar2,
372 p_development_event_type in varchar2 default hr_api.g_varchar2,
373 p_event_status in varchar2 default hr_api.g_varchar2,
374 p_price_basis in varchar2 default hr_api.g_varchar2,
375 p_currency_code in varchar2 default hr_api.g_varchar2,
376 p_maximum_attendees in number default hr_api.g_number,
377 p_maximum_internal_attendees in number default hr_api.g_number,
378 p_minimum_attendees in number default hr_api.g_number,
379 p_standard_price in number default hr_api.g_number,
380 p_category_code in varchar2 default hr_api.g_varchar2,
381 p_parent_event_id in number default hr_api.g_number,
382 p_book_independent_flag in varchar2 default hr_api.g_varchar2,
383 p_public_event_flag in varchar2 default hr_api.g_varchar2,
384 p_secure_event_flag in varchar2 default hr_api.g_varchar2,
385 p_evt_information_category in varchar2 default hr_api.g_varchar2,
386 p_evt_information1 in varchar2 default hr_api.g_varchar2,
387 p_evt_information2 in varchar2 default hr_api.g_varchar2,
388 p_evt_information3 in varchar2 default hr_api.g_varchar2,
389 p_evt_information4 in varchar2 default hr_api.g_varchar2,
390 p_evt_information5 in varchar2 default hr_api.g_varchar2,
391 p_evt_information6 in varchar2 default hr_api.g_varchar2,
392 p_evt_information7 in varchar2 default hr_api.g_varchar2,
393 p_evt_information8 in varchar2 default hr_api.g_varchar2,
394 p_evt_information9 in varchar2 default hr_api.g_varchar2,
395 p_evt_information10 in varchar2 default hr_api.g_varchar2,
396 p_evt_information11 in varchar2 default hr_api.g_varchar2,
397 p_evt_information12 in varchar2 default hr_api.g_varchar2,
398 p_evt_information13 in varchar2 default hr_api.g_varchar2,
399 p_evt_information14 in varchar2 default hr_api.g_varchar2,
400 p_evt_information15 in varchar2 default hr_api.g_varchar2,
401 p_evt_information16 in varchar2 default hr_api.g_varchar2,
402 p_evt_information17 in varchar2 default hr_api.g_varchar2,
403 p_evt_information18 in varchar2 default hr_api.g_varchar2,
404 p_evt_information19 in varchar2 default hr_api.g_varchar2,
405 p_evt_information20 in varchar2 default hr_api.g_varchar2,
406 p_project_id in number default hr_api.g_number,
407 p_owner_id in number default hr_api.g_number,
408 p_line_id in number default hr_api.g_number,
409 p_org_id in number default hr_api.g_number,
410 p_training_center_id in number default hr_api.g_number,
411 p_location_id in number default hr_api.g_number,
412 p_offering_id in number default hr_api.g_number,
413 p_timezone in varchar2 default hr_api.g_varchar2,
414 -- Bug#2200078 Corrected default value for offering_id and timezone
415 -- p_offering_id in number default null,
416 -- p_timezone in varchar2 default null,
417 p_parent_offering_id in number default hr_api.g_number,
418 p_data_source in varchar2 default hr_api.g_varchar2,
419 p_validate in boolean default false
420 );
421 --
422 -- ----------------------------------------------------------------------------
423 -- |-------------------------------< delete_class >---------------------------|
424 -- ----------------------------------------------------------------------------
425 --
426 -- {Start Of Comments}
427 /*#
428 * This business process enables the user to delete a class.
429 *
430 *
431 * <p><b>Licensing</b><br>
432 * This API is licensed for use with Learning Management.
433 *
434 * <p><b>Prerequisites</b><br>
435 * The class that is to be deleted must exist.
436 *
437 * <p><b>Post Success</b><br>
438 * The class will be deleted.
439 *
440 * <p><b>Post Failure</b><br>
441 * The API does not update the class, and raises an error.
442 * @param p_validate If true, then only validation will be performed and the
443 * database remains unchanged. If false, then all validation checks pass and
444 * the database will be modified.
445 * @param p_event_id This column uniquely identifies the class being deleted.
446 * @param p_object_version_number Current version number of the class to be
447 * deleted.
451 * @rep:scope public
448 * @rep:displayname Delete Class
449 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CLASS
450 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
452 * @rep:lifecycle active
453 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
454 */
455 --
456 -- {End Of Comments}
457 --
458 procedure delete_class
459 (p_validate in boolean default false
460 ,p_event_id in number
461 ,p_object_version_number in number
462 );
463
464 PROCEDURE add_evaluation
465 ( p_event_id in number
466 ,p_activity_version_id in number);
467
468
469 end ota_event_api;
[Home] [Help]