4 * This package contains the offering APIs.
1 PACKAGE OTA_OFFERING_API AUTHID CURRENT_USER as
2 /* $Header: otoffapi.pkh 120.5 2008/03/31 12:19:19 dpatange noship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Offering
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_offering >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an offering.
17 *
18 * This API enables the user to create an offering and enter 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 course and delivery mode must already exist before an offering
25 * can be created. The parent course and delivery mode must exist in the same
26 * business group as the business group of the offering, and must be active
27 * within the offering dates being entered.
28 *
29 * <p><b>Post Success</b><br>
30 * When the offering has been successfully inserted, the following OUT
31 * parameters are set.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create an offering, and raises an error.
35 * @param p_validate If true, then only validation is performed and the
36 * database remains unchanged. If false, then all validation checks pass and
37 * the database is modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_business_group_id The business group owning the offering.
42 * @param p_name The name of the offering. This must be unique within a course.
43 * @param p_start_date The date on which the offering starts.
44 * @param p_activity_version_id Foreign key to OTA_ACTIVITY_VERSION_ID. This
45 * column denotes the parent course for the offering.
46 * @param p_end_date The date on which the offering ends.
47 * @param p_owner_id Foreign key to PER_ALL_PEOPLE_F.
48 * @param p_delivery_mode_id Foreign key to OTA_CATEGORY_USAGES. This denotes
49 * the category usage of type DM, and is the delivery mode for the offering.
50 * @param p_language_id Ignore this parameter and populate p_language_code
51 * @param p_duration The duration of the class measured in units. The unit of
52 * measure is specified in column DURATION_UNITS.
53 * @param p_duration_units The units in which the duration is measured. Valid
54 * values are defined by the 'OTA_FREQUENCY' lookup type.
55 * @param p_learning_object_id Foreign key to OTA_LEARNING_OBJECTS. This is
59 * @param p_player_toolbar_bitset This column indicates whether or not the
56 * mandatory for offerings with an online delivery mode.
57 * @param p_player_toolbar_flag This flag indicates whether or not the toolbar
58 * appears in the player window for an online offering.
60 * following buttons appears in the player window: toolbar, next, outline,
61 * exit, previous.
62 * @param p_player_new_window_flag This indicates whether or not the player
63 * opens in a new browser window.
64 * @param p_maximum_attendees The maximum number of learners allowed to attend.
65 * @param p_maximum_internal_attendees The maximum number of internal learners
66 * allowed to attend.
67 * @param p_minimum_attendees The minimum number of learners required for this
68 * offering.
69 * @param p_actual_cost The actual cost of the offering.
70 * @param p_budget_cost The budgeted cost of the offering.
71 * @param p_budget_currency_code The actual cost of the offering in the
72 * budgeted currency.
73 * @param p_price_basis Price basis of the offering: Student, Customer, or No
74 * Charge. The value selected is defaulted in classes under this offering.
75 * Valid values are defined by the 'EVENT_PRICE_BASIS' lookup type.
76 * @param p_currency_code The currency in which the standard price is defined.
77 * @param p_standard_price The standard price per enrollment for this offering.
78 * A standard price can be per student (learner), per customer, or per order.
79 * @param p_attribute_category This context value determines which flexfield
80 * structure to use with the descriptive flexfield segments.
81 * @param p_attribute1 Descriptive flexfield segment.
82 * @param p_attribute2 Descriptive flexfield segment.
83 * @param p_attribute3 Descriptive flexfield segment.
84 * @param p_attribute4 Descriptive flexfield segment.
85 * @param p_attribute5 Descriptive flexfield segment.
86 * @param p_attribute6 Descriptive flexfield segment.
87 * @param p_attribute7 Descriptive flexfield segment.
88 * @param p_attribute8 Descriptive flexfield segment.
89 * @param p_attribute9 Descriptive flexfield segment.
90 * @param p_attribute10 Descriptive flexfield segment.
91 * @param p_attribute11 Descriptive flexfield segment.
92 * @param p_attribute12 Descriptive flexfield segment.
93 * @param p_attribute13 Descriptive flexfield segment.
94 * @param p_attribute14 Descriptive flexfield segment.
95 * @param p_attribute15 Descriptive flexfield segment.
96 * @param p_attribute16 Descriptive flexfield segment.
97 * @param p_attribute17 Descriptive flexfield segment.
98 * @param p_attribute18 Descriptive flexfield segment.
99 * @param p_attribute19 Descriptive flexfield segment.
100 * @param p_attribute20 Descriptive flexfield segment.
101 * @param p_offering_id If p_validate is false, then this ID uniquely
102 * identifies the offering being created. If p_validate is true, then it is set
103 * to null.
104 * @param p_object_version_number If p_validate is false, then the number is
105 * set to the version number of the created offering. If p_validate is true,
106 * then the value is null.
107 * @param p_data_source Source of the offering being created. Valid values are
108 * defined by the 'OTA_OBJECT_DATA_SOURCE' lookup type.
109 * @param p_vendor_id Foreign key to PO_VENDORS. The vendor hosting the
110 * offering.
111 * @param p_description Description of the offering.
112 * @param p_competency_update_level Valid values are defined by the 'OTA_COMPETENCY_UPDATE_LEVEL' lookup type.
113 * Specifies the mode of competency update. This value overrides the value set at the workflow level.
114 * @param p_language_code The language in which offering is taught, use
115 * OTA_NATURAL_LANGUAGES_V to pick the language code. The parameter
116 * language_id can be ignored
117 * @rep:displayname Create Offering
118 * @rep:category BUSINESS_ENTITY OTA_LEARNING_OFFERING
119 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
120 * @rep:scope public
121 * @rep:lifecycle active
122 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
123 */
124 --
125 -- {End Of Comments}
129 ,p_effective_date in date
126 --
127 procedure Create_offering
128 (p_validate in boolean default false
130 ,p_business_group_id in number
131 ,p_name in varchar2
132 ,p_start_date in date
133 ,p_activity_version_id in number default null
134 ,p_end_date in date default null
135 ,p_owner_id in number default null
136 ,p_delivery_mode_id in number default null
140 ,p_learning_object_id in number default null
137 ,p_language_id in number default null
138 ,p_duration in number default null
139 ,p_duration_units in varchar2 default null
141 ,p_player_toolbar_flag in varchar2 default null
142 ,p_player_toolbar_bitset in number default null
143 ,p_player_new_window_flag in varchar2 default null
144 ,p_maximum_attendees in number default null
145 ,p_maximum_internal_attendees in number default null
146 ,p_minimum_attendees in number default null
147 ,p_actual_cost in number default null
148 ,p_budget_cost in number default null
149 ,p_budget_currency_code in varchar2 default null
150 ,p_price_basis in varchar2 default null
151 ,p_currency_code in varchar2 default null
152 ,p_standard_price in number default null
153 ,p_attribute_category in varchar2 default null
154 ,p_attribute1 in varchar2 default null
155 ,p_attribute2 in varchar2 default null
156 ,p_attribute3 in varchar2 default null
157 ,p_attribute4 in varchar2 default null
158 ,p_attribute5 in varchar2 default null
159 ,p_attribute6 in varchar2 default null
160 ,p_attribute7 in varchar2 default null
161 ,p_attribute8 in varchar2 default null
162 ,p_attribute9 in varchar2 default null
163 ,p_attribute10 in varchar2 default null
164 ,p_attribute11 in varchar2 default null
165 ,p_attribute12 in varchar2 default null
166 ,p_attribute13 in varchar2 default null
167 ,p_attribute14 in varchar2 default null
168 ,p_attribute15 in varchar2 default null
169 ,p_attribute16 in varchar2 default null
170 ,p_attribute17 in varchar2 default null
171 ,p_attribute18 in varchar2 default null
172 ,p_attribute19 in varchar2 default null
173 ,p_attribute20 in varchar2 default null
174 ,p_offering_id out nocopy number
175 ,p_object_version_number out nocopy number
176 ,p_data_source in varchar2 default null
177 ,p_vendor_id in number default null
178 ,p_description in varchar2 default null
179 ,p_competency_update_level in varchar2 default null
180 ,p_language_code in varchar2 default null -- 2733966
181 );
182 --
183 -- ----------------------------------------------------------------------------
184 -- |-----------------------------< update_offering >--------------------------|
185 -- ----------------------------------------------------------------------------
186 --
187 -- {Start Of Comments}
188 /*#
189 * This API updates an offering.
190 *
191 *
192 * <p><b>Licensing</b><br>
193 * This API is licensed for use with Learning Management.
194 *
195 * <p><b>Prerequisites</b><br>
196 * The offering that is being updated must exist.
197 *
198 * <p><b>Post Success</b><br>
199 * The offering is successfully updated.
200 *
201 * <p><b>Post Failure</b><br>
202 * The API does not update the offering and raises an error.
203 * @param p_validate If true, then only validation is performed and the
204 * database remains unchanged. If false, then all validation checks pass and
205 * the database is modified.
206 * @param p_effective_date Reference date for validating lookup values are
207 * applicable during the start to end active date range. This date does not
208 * determine when the changes take effect.
209 * @param p_offering_id This uniquely identifies the offering being updated.
210 * @param p_object_version_number If p_validate is false, then the number is
211 * set to the version number of the updated offering. If p_validate is true,
212 * then the value is null.
213 * @param p_business_group_id The business group owning the offering.
214 * @param p_name The name of the offering. This must be unique within a course.
215 * @param p_start_date The date on which the offering starts.
216 * @param p_activity_version_id Foreign key to OTA_ACTIVITY_VERSION_ID. This
217 * column denotes the parent course for the offering.
218 * @param p_end_date The date on which the offering ends.
219 * @param p_owner_id Foreign key to PER_ALL_PEOPLE_F.
220 * @param p_delivery_mode_id Foreign key to OTA_CATEGORY_USAGES. This denotes
221 * the category usage of type DM, and is the delivery mode for the offering.
222 * @param p_language_id Ignore this parameter and populate p_language_code
223 * @param p_duration The duration of the class measured in units. The unit of
224 * measure is specified in column DURATION_UNITS.
225 * @param p_duration_units The units in which the duration is measured. Valid
226 * values are defined by the 'OTA_FREQUENCY' lookup type.
227 * @param p_learning_object_id Foreign key to OTA_LEARNING_OBJECTS. This is
228 * mandatory for offerings with an online delivery mode.
229 * @param p_player_toolbar_flag This flag indicates whether or not the toolbar
230 * appears in the player window for an online offering.
231 * @param p_player_toolbar_bitset This column indicates whether or not the
232 * following buttons appear in the player window: toolbar, next, outline, exit,
233 * previous.
237 * @param p_maximum_internal_attendees The maximum number of internal learners
234 * @param p_player_new_window_flag This indicates whether or not the player
235 * opens in a new browser window.
236 * @param p_maximum_attendees The maximum number of learners allowed to attend.
238 * allowed to attend.
239 * @param p_minimum_attendees The minimum number of learners required for this
240 * offering.
241 * @param p_actual_cost The actual cost of the offering.
245 * @param p_price_basis Price basis of the offering: Student, Customer, or No
242 * @param p_budget_cost The budgeted cost of the offering.
243 * @param p_budget_currency_code The actual cost of the offering in the
244 * budgeted currency.
246 * Charge. The value selected is defaulted in classes under this offering.
247 * Valid values are defined by the 'EVENT_PRICE_BASIS' lookup type.
248 * @param p_currency_code The currency in which the standard price is defined.
249 * @param p_standard_price The standard price per enrollment for this offering.
250 * A standard price can be per student (learner), per customer, or per order.
251 * @param p_attribute_category This context value determines which flexfield
252 * structure to use with the descriptive flexfield segments.
253 * @param p_attribute1 Descriptive flexfield segment.
254 * @param p_attribute2 Descriptive flexfield segment.
255 * @param p_attribute3 Descriptive flexfield segment.
256 * @param p_attribute4 Descriptive flexfield segment.
257 * @param p_attribute5 Descriptive flexfield segment.
258 * @param p_attribute6 Descriptive flexfield segment.
259 * @param p_attribute7 Descriptive flexfield segment.
260 * @param p_attribute8 Descriptive flexfield segment.
261 * @param p_attribute9 Descriptive flexfield segment.
262 * @param p_attribute10 Descriptive flexfield segment.
263 * @param p_attribute11 Descriptive flexfield segment.
264 * @param p_attribute12 Descriptive flexfield segment.
265 * @param p_attribute13 Descriptive flexfield segment.
266 * @param p_attribute14 Descriptive flexfield segment.
267 * @param p_attribute15 Descriptive flexfield segment.
268 * @param p_attribute16 Descriptive flexfield segment.
269 * @param p_attribute17 Descriptive flexfield segment.
270 * @param p_attribute18 Descriptive flexfield segment.
271 * @param p_attribute19 Descriptive flexfield segment.
272 * @param p_attribute20 Descriptive flexfield segment.
273 * @param p_data_source Source of the offering being created. Valid values are
274 * defined by the 'OTA_OBJECT_DATA_SOURCE' lookup type.
275 * @param p_vendor_id Foreign key to PO_VENDORS. The vendor hosting the
276 * offering.
277 * @param p_description Description of the offering.
278 * @param p_competency_update_level Valid values are defined by the 'OTA_COMPETENCY_UPDATE_LEVEL' lookup type.
279 * Specifies the mode of competency update. This value overrides the value set at the workflow level.
280 * @param p_language_code The language in which offering is taught, use
281 * OTA_NATURAL_LANGUAGES_V to pick the language code. The parameter
282 * language_id can be ignored
283 * @rep:displayname Update Offering
284 * @rep:category BUSINESS_ENTITY OTA_LEARNING_OFFERING
285 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
286 * @rep:scope public
287 * @rep:lifecycle active
288 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
289 */
290 --
291 -- {End Of Comments}
292 --
293 procedure Update_offering
294 (p_validate in boolean default false
295 ,p_effective_date in date
296 ,p_offering_id in number
297 ,p_object_version_number in out nocopy number
298 ,p_business_group_id in number default hr_api.g_number
299 ,p_name in varchar2 default hr_api.g_varchar2
300 ,p_start_date in date default hr_api.g_date
301 ,p_activity_version_id in number default hr_api.g_number
302 ,p_end_date in date default hr_api.g_date
303 ,p_owner_id in number default hr_api.g_number
304 ,p_delivery_mode_id in number default hr_api.g_number
305 ,p_language_id in number default hr_api.g_number
306 ,p_duration in number default hr_api.g_number
307 ,p_duration_units in varchar2 default hr_api.g_varchar2
308 ,p_learning_object_id in number default hr_api.g_number
309 ,p_player_toolbar_flag in varchar2 default hr_api.g_varchar2
310 ,p_player_toolbar_bitset in number default hr_api.g_number
311 ,p_player_new_window_flag in varchar2 default hr_api.g_varchar2
312 ,p_maximum_attendees in number default hr_api.g_number
313 ,p_maximum_internal_attendees in number default hr_api.g_number
317 ,p_budget_currency_code in varchar2 default hr_api.g_varchar2
314 ,p_minimum_attendees in number default hr_api.g_number
315 ,p_actual_cost in number default hr_api.g_number
316 ,p_budget_cost in number default hr_api.g_number
318 ,p_price_basis in varchar2 default hr_api.g_varchar2
319 ,p_currency_code in varchar2 default hr_api.g_varchar2
320 ,p_standard_price in number default hr_api.g_number
321 ,p_attribute_category in varchar2 default hr_api.g_varchar2
322 ,p_attribute1 in varchar2 default hr_api.g_varchar2
323 ,p_attribute2 in varchar2 default hr_api.g_varchar2
324 ,p_attribute3 in varchar2 default hr_api.g_varchar2
325 ,p_attribute4 in varchar2 default hr_api.g_varchar2
326 ,p_attribute5 in varchar2 default hr_api.g_varchar2
327 ,p_attribute6 in varchar2 default hr_api.g_varchar2
328 ,p_attribute7 in varchar2 default hr_api.g_varchar2
329 ,p_attribute8 in varchar2 default hr_api.g_varchar2
330 ,p_attribute9 in varchar2 default hr_api.g_varchar2
331 ,p_attribute10 in varchar2 default hr_api.g_varchar2
332 ,p_attribute11 in varchar2 default hr_api.g_varchar2
333 ,p_attribute12 in varchar2 default hr_api.g_varchar2
334 ,p_attribute13 in varchar2 default hr_api.g_varchar2
335 ,p_attribute14 in varchar2 default hr_api.g_varchar2
336 ,p_attribute15 in varchar2 default hr_api.g_varchar2
337 ,p_attribute16 in varchar2 default hr_api.g_varchar2
338 ,p_attribute17 in varchar2 default hr_api.g_varchar2
339 ,p_attribute18 in varchar2 default hr_api.g_varchar2
340 ,p_attribute19 in varchar2 default hr_api.g_varchar2
341 ,p_attribute20 in varchar2 default hr_api.g_varchar2
342 ,p_data_source in varchar2 default hr_api.g_varchar2
343 ,p_vendor_id in number default hr_api.g_number
344 ,p_description in varchar2 default hr_api.g_varchar2
345 ,p_competency_update_level in varchar2 default hr_api.g_varchar2
346 ,p_language_code in varchar2 default hr_api.g_varchar2 -- 2733966
347 );
348 --
349 -- ----------------------------------------------------------------------------
350 -- |-----------------------------< delete_offering >--------------------------|
351 -- ----------------------------------------------------------------------------
352 --
353 -- {Start Of Comments}
354 /*#
355 * This API enables the user to delete an offering.
356 *
357 *
358 * <p><b>Licensing</b><br>
359 * This API is licensed for use with Learning Management.
360 *
361 * <p><b>Prerequisites</b><br>
362 * The offering must exist and should not have classes under it.
363 *
364 * <p><b>Post Success</b><br>
365 * The offering is successfully deleted.
366 *
367 * <p><b>Post Failure</b><br>
368 * The API does not delete the offering, and raises an error.
369 * @param p_validate If true, then only validation is performed and the
370 * database remains unchanged. If false, then all validation checks pass and
371 * the database is modified.
372 * @param p_offering_id This uniquely identifies the offering being deleted.
373 * @param p_object_version_number If p_validate is false, then the number is
374 * set to the version number of the offering being deleted. If p_validate is
375 * true, then the value is null.
376 * @rep:displayname Delete Offering
377 * @rep:category BUSINESS_ENTITY OTA_LEARNING_OFFERING
378 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
379 * @rep:scope public
380 * @rep:lifecycle active
381 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
382 */
383 --
384 -- {End Of Comments}
385 --
386 procedure delete_offering
387 (p_validate in boolean default false
388 ,p_offering_id in number
389 ,p_object_version_number in number
390 );
391
392 end ota_offering_api;
[Home] [Help]