1 PACKAGE ota_activity_version_api AUTHID CURRENT_USER as
2 /* $Header: ottavapi.pkh 120.4 2006/02/27 04:53:21 rdola noship $ */
3 /*#
4 * This package contains the course APIs.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Course
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_activity_version >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a course.
17 *
18 * This business process creates a course record.
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 category under which the course is to be created must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The Course record is created in the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * If the API cannot create a course, an error is raised.
31 * @param p_effective_date Reference date for validating lookup values are
32 * applicable during the start to end active date range. This date does not
33 * determine when the changes take effect.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_activity_id {@rep:casecolumn OTA_ACTIVITY_DEFINITIONS.ACTIVITY_ID}
38 * @param p_superseded_by_act_version_id {@rep:casecolumn
39 * OTA_ACTIVITY_VERSIONS.ACTIVITY_VERSION_ID}
40 * @param p_developer_organization_id {@rep:casecolumn
41 * HR_ALL_ORGANIZATION_UNITS.ORGANIZATION_ID}
42 * @param p_controlling_person_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_ID}
43 * @param p_version_name Name of the Course.
44 * @param p_comments If the profile 'HR:Use Standard Attachments
45 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
46 * attachment text.
47 * @param p_description Description of the Course.
48 * @param p_duration Numeric duration of the Course.
49 * @param p_duration_units LOOKUP_CODE : OTA_DURATION_UNITS.
50 * @param p_end_date End Date.
51 * @param p_intended_audience Intended audience.
52 * @param p_language_id The unique identifier of the language of the course.
53 * @param p_maximum_attendees The maximum number of attendees.
54 * @param p_minimum_attendees The minimum number of attendees.
55 * @param p_objectives Objectives.
56 * @param p_start_date Start Date.
57 * @param p_success_criteria LOOKUP_CODE:ACTIVITY_SUCCESS_CRITERIA.
58 * @param p_user_status LOOKUP_CODE:ACTIVITY_USER_STATUS.
59 * @param p_vendor_id The unique identifer that identifies the vendor of this
60 * course.
61 * @param p_actual_cost Actual Cost.
62 * @param p_budget_cost Budgeted Cost.
63 * @param p_budget_currency_code Currency code of the budget currency for this
64 * course.
65 * @param p_expenses_allowed Expenses allowed. Possible values: 'Y' /'N'.
66 * @param p_professional_credit_type LOOKUP_CODE:PROFESSIONAL_CREDIT_TYPE.
67 * @param p_professional_credits Professional Credits.
68 * @param p_maximum_internal_attendees Maximum Internal Attendees.
69 * @param p_tav_information_category This context value determines which
70 * Flexfield Structure to use with the Descriptive flexfield segment.
71 * @param p_tav_information1 Descriptive Flexfield Segment.
72 * @param p_tav_information2 Descriptive Flexfield Segment.
73 * @param p_tav_information3 Descriptive Flexfield Segment.
74 * @param p_tav_information4 Descriptive Flexfield Segment.
75 * @param p_tav_information5 Descriptive Flexfield Segment.
76 * @param p_tav_information6 Descriptive Flexfield Segment.
77 * @param p_tav_information7 Descriptive Flexfield Segment.
78 * @param p_tav_information8 Descriptive Flexfield Segment.
79 * @param p_tav_information9 Descriptive Flexfield Segment.
80 * @param p_tav_information10 Descriptive Flexfield Segment.
81 * @param p_tav_information11 Descriptive Flexfield Segment.
82 * @param p_tav_information12 Descriptive Flexfield Segment.
83 * @param p_tav_information13 Descriptive Flexfield Segment.
84 * @param p_tav_information14 Descriptive Flexfield Segment.
85 * @param p_tav_information15 Descriptive Flexfield Segment.
86 * @param p_tav_information16 Descriptive Flexfield Segment.
87 * @param p_tav_information17 Descriptive Flexfield Segment.
88 * @param p_tav_information18 Descriptive Flexfield Segment.
89 * @param p_tav_information19 Descriptive Flexfield Segment.
90 * @param p_tav_information20 Descriptive Flexfield Segment.
91 * @param p_inventory_item_id The unique identifier of the inventory item to
92 * which this course is attached.
93 * @param p_organization_id The unique identifier of the Organization which
94 * owns the inventory item to which this course is attached.
95 * @param p_rco_id RCO_ID for courses imported from Oracle iLearning.
96 * @param p_version_code Version Code.
97 * @param p_keywords Keywords by which this course can be identified during a
98 * search.
99 * @param p_business_group_id The unique identifier of the business group that
100 * owns this course.
101 * @param p_activity_version_id The Course number generation method determines
102 * when the API derives and passes out a course number or when the calling
103 * program should pass in a value. When the API call completes, if p_validate
104 * is true then the ID is set to the generated identifier. If p_validate is
105 * false then it is set to the passed value.
106 * @param p_object_version_number If p_validate is false, then the number is
107 * set to the version number of the created course. If p_validate is true then
108 * the value will be null.
109 * @param p_data_source LOOKUP_CODE : OTA_DATA_SOURCE.
110 * @param p_competency_update_level Valid values are defined by the 'OTA_COMPETENCY_UPDATE_LEVEL' lookup type.
111 * Specifies the mode of competency update. This value overrides the value set at the workflow level.
112 * @rep:displayname Create Course
113 * @rep:category BUSINESS_ENTITY OTA_LEARNING_COURSE
114 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
115 * @rep:scope public
116 * @rep:lifecycle active
117 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
118 */
119 --
120 -- {End Of Comments}
121 --
122 procedure Create_activity_version
123 (
124 p_effective_date in date,
125 p_validate in boolean default false ,
126 p_activity_id in number,
127 p_superseded_by_act_version_id in number default null,
128 p_developer_organization_id in number,
129 p_controlling_person_id in number default null,
130 p_version_name in varchar2,
131 p_comments in varchar2 default null,
132 p_description in varchar2 default null,
133 p_duration in number default null,
134 p_duration_units in varchar2 default null,
135 p_end_date in date default null,
136 p_intended_audience in varchar2 default null,
137 p_language_id in number default null,
138 p_maximum_attendees in number default null,
139 p_minimum_attendees in number default null,
140 p_objectives in varchar2 default null,
141 p_start_date in date default null,
142 p_success_criteria in varchar2 default null,
143 p_user_status in varchar2 default null,
144 p_vendor_id in number default null,
145 p_actual_cost in number default null,
146 p_budget_cost in number default null,
147 p_budget_currency_code in varchar2 default null,
148 p_expenses_allowed in varchar2 default null,
149 p_professional_credit_type in varchar2 default null,
150 p_professional_credits in number default null,
151 p_maximum_internal_attendees in number default null,
152 p_tav_information_category in varchar2 default null,
153 p_tav_information1 in varchar2 default null,
154 p_tav_information2 in varchar2 default null,
155 p_tav_information3 in varchar2 default null,
156 p_tav_information4 in varchar2 default null,
157 p_tav_information5 in varchar2 default null,
158 p_tav_information6 in varchar2 default null,
159 p_tav_information7 in varchar2 default null,
160 p_tav_information8 in varchar2 default null,
161 p_tav_information9 in varchar2 default null,
162 p_tav_information10 in varchar2 default null,
163 p_tav_information11 in varchar2 default null,
164 p_tav_information12 in varchar2 default null,
165 p_tav_information13 in varchar2 default null,
166 p_tav_information14 in varchar2 default null,
167 p_tav_information15 in varchar2 default null,
168 p_tav_information16 in varchar2 default null,
169 p_tav_information17 in varchar2 default null,
170 p_tav_information18 in varchar2 default null,
171 p_tav_information19 in varchar2 default null,
172 p_tav_information20 in varchar2 default null,
173 p_inventory_item_id in number default null,
174 p_organization_id in number default null,
175 p_rco_id in number default null,
176 p_version_code in varchar2 default null,
177 p_keywords in varchar2 default null,
178 p_business_group_id in number default null,
179 p_activity_version_id out nocopy number ,
180 p_object_version_number out nocopy number,
181 p_data_source in varchar2 default null
182 ,p_competency_update_level in varchar2 default null
183
184 );
185 --
186 -- ----------------------------------------------------------------------------
187 -- |-------------------------< update_activity_version >----------------------|
188 -- ----------------------------------------------------------------------------
189 --
190 -- {Start Of Comments}
191 /*#
195 *
192 * This API updates a course.
193 *
194 * This business process updates a course record.
196 * <p><b>Licensing</b><br>
197 * This API is licensed for use with Learning Management.
198 *
199 * <p><b>Prerequisites</b><br>
200 * The Course must exist.
201 *
202 * <p><b>Post Success</b><br>
203 * The Course record is updated.
204 *
205 * <p><b>Post Failure</b><br>
206 * If the API cannot update the course, an error is raised.
207 * @param p_effective_date Reference date for validating lookup values are
208 * applicable during the start to end active date range. This date does not
209 * determine when the changes take effect.
210 * @param p_activity_version_id {@rep:casecolumn
211 * OTA_ACTIVITY_VERSIONS.ACTIVITY_VERSION_ID}
212 * @param p_activity_id {@rep:casecolumn OTA_ACTIVITY_DEFINITIONS.ACTIVITY_ID}
213 * @param p_superseded_by_act_version_id {@rep:casecolumn
214 * OTA_ACTIVITY_VERSIONS.ACTIVITY_VERSION_ID}
215 * @param p_developer_organization_id {@rep:casecolumn
216 * HR_ALL_ORGANIZATION_UNITS.ORGANIZATION_ID}
217 * @param p_controlling_person_id {@rep:casecolumn PER_ALL_PEOPLE_F.PERSON_ID}
218 * @param p_object_version_number Pass in the current version number of the
219 * Course to be updated. When the API completes, if p_validate is false, the
220 * number is set to the new version number of the updated course. If p_validate
221 * is true, the number remains unchanged.
222 * @param p_version_name Name of the Course.
223 * @param p_comments If the profile 'HR:Use Standard Attachments
224 * (PER_ATTACHMENT_USAGE)' is set to 'No', this text serves as HR-specific
225 * attachment text.
226 * @param p_description Description of the course.
227 * @param p_duration Numeric duration of the course.
228 * @param p_duration_units LOOKUP_CODE:OTA_DURATION_UNITS.
229 * @param p_end_date End Date.
230 * @param p_intended_audience Intended audience.
231 * @param p_language_id The unique identifier of the language of the course.
232 * @param p_maximum_attendees The maximum number of attendees.
233 * @param p_minimum_attendees The minimum number of attendees.
234 * @param p_objectives Objectives.
235 * @param p_start_date Start Date.
236 * @param p_success_criteria LOOKUP_CODE:ACTIVITY_SUCCESS_CRITERIA.
237 * @param p_user_status LOOKUP_CODE:ACTIVITY_USER_STATUS.
238 * @param p_vendor_id The unique identifer that identifies the vendor of this
239 * course.
240 * @param p_actual_cost Actual Cost.
241 * @param p_budget_cost Budgeted Cost.
242 * @param p_budget_currency_code Currency code of the budget currency for this
243 * course.
244 * @param p_expenses_allowed Expenses Allowed. Possible Values 'Y' /'N'.
245 * @param p_professional_credit_type LOOKUP_CODE:PROFESSIONAL_CREDIT_TYPE.
246 * @param p_professional_credits Professional Credits.
247 * @param p_maximum_internal_attendees Maximum Internal Attendees.
248 * @param p_tav_information_category This context value determines which
249 * Flexfield Structure to use with the Descriptive flexfield segment.
250 * @param p_tav_information1 Descriptive Flexfield Segment.
251 * @param p_tav_information2 Descriptive Flexfield Segment.
252 * @param p_tav_information3 Descriptive Flexfield Segment.
253 * @param p_tav_information4 Descriptive Flexfield Segment.
254 * @param p_tav_information5 Descriptive Flexfield Segment.
255 * @param p_tav_information6 Descriptive Flexfield Segment.
256 * @param p_tav_information7 Descriptive Flexfield Segment.
257 * @param p_tav_information8 Descriptive Flexfield Segment.
258 * @param p_tav_information9 Descriptive Flexfield Segment.
259 * @param p_tav_information10 Descriptive Flexfield Segment.
260 * @param p_tav_information11 Descriptive Flexfield Segment.
261 * @param p_tav_information12 Descriptive Flexfield Segment.
262 * @param p_tav_information13 Descriptive Flexfield Segment.
263 * @param p_tav_information14 Descriptive Flexfield Segment.
264 * @param p_tav_information15 Descriptive Flexfield Segment.
265 * @param p_tav_information16 Descriptive Flexfield Segment.
266 * @param p_tav_information17 Descriptive Flexfield Segment.
267 * @param p_tav_information18 Descriptive Flexfield Segment.
268 * @param p_tav_information19 Descriptive Flexfield Segment.
269 * @param p_tav_information20 Descriptive Flexfield Segment.
270 * @param p_inventory_item_id The unique identifier of the inventory item to
271 * which this course is attached.
272 * @param p_organization_id The unique identifier of the Organization which
273 * owns the inventory item to which this course is attached.
274 * @param p_rco_id RCO_ID for courses imported from Oracle iLearning.
275 * @param p_version_code Version Code.
276 * @param p_keywords Keywords through which this Course can be identified
277 * during search.
278 * @param p_business_group_id The unique identifier of the business group that
279 * owns this course.
280 * @param p_validate If true, then validation alone will be performed and the
281 * database will remain unchanged. If false and all validation checks pass,
282 * then the database will be modified.
283 * @param p_data_source LOOKUP_CODE:OTA_DATA_SOURCE.
284 * @param p_competency_update_level Valid values are defined by the 'OTA_COMPETENCY_UPDATE_LEVEL' lookup type.
285 * Specifies the mode of competency update. This value overrides the value set at the workflow level.
286 * @rep:displayname Update Course
287 * @rep:category BUSINESS_ENTITY OTA_LEARNING_COURSE
288 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
289 * @rep:scope public
290 * @rep:lifecycle active
291 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
292 */
293 --
294 -- {End Of Comments}
295 --
296 procedure Update_activity_version
297 (
298 p_effective_date in date ,
299 p_activity_version_id in number,
303 p_controlling_person_id in number default hr_api.g_number,
300 p_activity_id in number default hr_api.g_number,
301 p_superseded_by_act_version_id in number default hr_api.g_number,
302 p_developer_organization_id in number default hr_api.g_number,
304 p_object_version_number in out nocopy number,
305 p_version_name in varchar2 default hr_api.g_varchar2,
306 p_comments in varchar2 default hr_api.g_varchar2,
307 p_description in varchar2 default hr_api.g_varchar2,
308 p_duration in number default hr_api.g_number,
309 p_duration_units in varchar2 default hr_api.g_varchar2,
310 p_end_date in date default hr_api.g_date,
311 p_intended_audience in varchar2 default hr_api.g_varchar2,
312 p_language_id in number default hr_api.g_number,
313 p_maximum_attendees in number default hr_api.g_number,
314 p_minimum_attendees in number default hr_api.g_number,
315 p_objectives in varchar2 default hr_api.g_varchar2,
316 p_start_date in date default hr_api.g_date,
317 p_success_criteria in varchar2 default hr_api.g_varchar2,
318 p_user_status in varchar2 default hr_api.g_varchar2,
319 p_vendor_id in number default hr_api.g_number,
320 p_actual_cost in number default hr_api.g_number,
321 p_budget_cost in number default hr_api.g_number,
322 p_budget_currency_code in varchar2 default hr_api.g_varchar2,
323 p_expenses_allowed in varchar2 default hr_api.g_varchar2,
324 p_professional_credit_type in varchar2 default hr_api.g_varchar2,
325 p_professional_credits in number default hr_api.g_number,
326 p_maximum_internal_attendees in number default hr_api.g_number,
327 p_tav_information_category in varchar2 default hr_api.g_varchar2,
328 p_tav_information1 in varchar2 default hr_api.g_varchar2,
329 p_tav_information2 in varchar2 default hr_api.g_varchar2,
330 p_tav_information3 in varchar2 default hr_api.g_varchar2,
331 p_tav_information4 in varchar2 default hr_api.g_varchar2,
332 p_tav_information5 in varchar2 default hr_api.g_varchar2,
333 p_tav_information6 in varchar2 default hr_api.g_varchar2,
334 p_tav_information7 in varchar2 default hr_api.g_varchar2,
335 p_tav_information8 in varchar2 default hr_api.g_varchar2,
336 p_tav_information9 in varchar2 default hr_api.g_varchar2,
337 p_tav_information10 in varchar2 default hr_api.g_varchar2,
338 p_tav_information11 in varchar2 default hr_api.g_varchar2,
339 p_tav_information12 in varchar2 default hr_api.g_varchar2,
340 p_tav_information13 in varchar2 default hr_api.g_varchar2,
341 p_tav_information14 in varchar2 default hr_api.g_varchar2,
342 p_tav_information15 in varchar2 default hr_api.g_varchar2,
343 p_tav_information16 in varchar2 default hr_api.g_varchar2,
344 p_tav_information17 in varchar2 default hr_api.g_varchar2,
345 p_tav_information18 in varchar2 default hr_api.g_varchar2,
346 p_tav_information19 in varchar2 default hr_api.g_varchar2,
347 p_tav_information20 in varchar2 default hr_api.g_varchar2,
348 p_inventory_item_id in number default hr_api.g_number,
349 p_organization_id in number default hr_api.g_number,
350 p_rco_id in number default hr_api.g_number,
351 p_version_code in varchar2 default hr_api.g_varchar2,
352 p_keywords in varchar2 default hr_api.g_varchar2,
353 p_business_group_id in number default hr_api.g_number,
354 p_validate in boolean default false,
355 p_data_source in varchar2 default hr_api.g_varchar2
356 ,p_competency_update_level in varchar2 default hr_api.g_varchar2
357
358 );
359 --
360 -- ----------------------------------------------------------------------------
361 -- |-------------------------< delete_activity_version >----------------------|
362 -- ----------------------------------------------------------------------------
363 --
364 -- {Start Of Comments}
365 /*#
366 * This API deletes a course record.
367 *
368 *
369 * <p><b>Licensing</b><br>
370 * This API is licensed for use with Learning Management.
371 *
372 * <p><b>Prerequisites</b><br>
373 * The Course must exist.
374 *
375 * <p><b>Post Success</b><br>
376 * The Course record is deleted from the database.
377 *
378 * <p><b>Post Failure</b><br>
379 * If the API cannot delete the record, an error is raised.
380 * @param p_activity_version_id The unique identifier of the course to be
381 * deleted.
382 * @param p_object_version_number Pass in the current version number of the
383 * Course to be deleted. This object version number must match the object
384 * version number for the record in the database.
385 * @param p_validate If true, then validation alone will be performed and the
386 * database will remain unchanged. If false and all validation checks pass,
387 * then the database will be modified.
388 * @rep:displayname Delete Course
389 * @rep:category BUSINESS_ENTITY OTA_LEARNING_COURSE
390 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
391 * @rep:scope public
395 --
392 * @rep:lifecycle active
393 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
394 */
396 -- {End Of Comments}
397 --
398 procedure delete_activity_version
399 (p_activity_version_id in number
400 ,p_object_version_number in number
401 ,p_validate in boolean default false
402 );
403 end ota_activity_version_api;
[Home] [Help]