1 Package ota_learning_path_api AUTHID CURRENT_USER as
2 /* $Header: otlpsapi.pkh 120.3 2005/11/07 03:26:28 rdola noship $ */
3 /*#
4 * This package contains the Learning Path APIs.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Learning Path
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_learning_path >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a Learning Path, which is a collection of Courses
17 * associated with Completion Targets.
18 *
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 business group must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The learning path will be successfully created.
28 *
29 * <p><b>Post Failure</b><br>
30 * The learning path will not be created and an error will be 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_path_name The translated name associated with this learning path.
38 * @param p_business_group_id The unique identifier of the business group that
42 * Valid values are defined by the 'OTA_DURATION_UNITS' lookup type.
39 * owns the learning path.
40 * @param p_duration {@rep:casecolumn OTA_LEARNING_PATHS.DURATION}.
41 * @param p_duration_units The completion target units of the learning path.
43 * @param p_start_date_active The date on which learners can begin to subscribe
44 * to the learning path.
45 * @param p_end_date_active The date on which the learning path becomes no
46 * longer available to learners.
47 * @param p_description The translated description associated with this
48 * learning path.
49 * @param p_objectives The translated objectives associated with this learning
50 * path.
51 * @param p_keywords The translated keyword associated with this learning path.
52 * @param p_purpose The translated purpose associated with this learning path.
53 * @param p_attribute_category This context value determines which flexfield
54 * structure to use with the descriptive flexfield segments.
55 * @param p_attribute1 Descriptive flexfield segment.
56 * @param p_attribute2 Descriptive flexfield segment.
57 * @param p_attribute3 Descriptive flexfield segment.
58 * @param p_attribute4 Descriptive flexfield segment.
59 * @param p_attribute5 Descriptive flexfield segment.
60 * @param p_attribute6 Descriptive flexfield segment.
61 * @param p_attribute7 Descriptive flexfield segment.
62 * @param p_attribute8 Descriptive flexfield segment.
63 * @param p_attribute9 Descriptive flexfield segment.
64 * @param p_attribute10 Descriptive flexfield segment.
65 * @param p_attribute11 Descriptive flexfield segment.
66 * @param p_attribute12 Descriptive flexfield segment.
67 * @param p_attribute13 Descriptive flexfield segment.
68 * @param p_attribute14 Descriptive flexfield segment.
69 * @param p_attribute15 Descriptive flexfield segment.
70 * @param p_attribute16 Descriptive flexfield segment.
71 * @param p_attribute17 Descriptive flexfield segment.
72 * @param p_attribute18 Descriptive flexfield segment.
73 * @param p_attribute19 Descriptive flexfield segment.
74 * @param p_attribute20 Descriptive flexfield segment.
75 * @param p_learning_path_id The unique identifier for the learning path.
76 * @param p_object_version_number If p_validate is false, then the number is
77 * set to the version number of the created learning path. If p_validate is
78 * true, then the value is null.
79 * @param p_person_id Identifies the person for whom the learning path is
80 * created. Applies only to personal learning paths.
81 * @param p_public_flag Identifies whether the catalog learning path is public.
82 * Permissible values are Y and N.
83 * @param p_source_function_code Source of the learning path when created from
84 * Talent Management. Valid values are defined by the
85 * 'OTA_PLAN_COMPONENT_SOURCE' lookup.
86 * @param p_contact_id Identifies the external contact for whom you create the
87 * learning path record. Applies only to personal learning paths.
88 * @param p_source_id Learning path source identifier: Appraisal ID,
89 * for example, if the learning path is created from Appraisals.
90 * @param p_assignment_id Identifies the assignment for which you create the
91 * learning path record.
92 * @param p_display_to_learner_flag Decides whether the learning path should be
93 * visible to the learner. Applies only to personal learning paths.
94 * @param p_notify_days_before_target Days before which a reminder notification
95 * is sent to the learners subscribed to the learning path. Applies only to
96 * catalog learning paths.
97 * @param p_path_source_code Source of creation of the learning path. Valid
98 * values are CATALOG, EMPLOYEE, MANAGER, TALENT_MGMT.
99 * @param p_competency_update_level Valid values are defined by the
100 * 'OTA_COMPETENCY_UPDATE_LEVEL' lookup type. Specifies the mode of competency
101 * update. This value overrides the value set at the workflow level.
102 * @rep:displayname Create Learning Path
103 * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH
104 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
105 * @rep:scope public
106 * @rep:lifecycle active
107 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
108 */
109 --
110 -- {End Of Comments}
111 --
112 procedure create_learning_path
113 (
114 p_effective_date in date,
115 p_validate in boolean default false ,
116 p_path_name in varchar2,
117 p_business_group_id in number,
118 p_duration in number default null,
119 p_duration_units in varchar2 default null,
120 p_start_date_active in date default null,
121 p_end_date_active in date default null,
122 p_description in varchar2 default null,
123 p_objectives in varchar2 default null,
124 p_keywords in varchar2 default null,
125 p_purpose in varchar2 default null,
126 p_attribute_category in varchar2 default null,
127 p_attribute1 in varchar2 default null,
128 p_attribute2 in varchar2 default null,
129 p_attribute3 in varchar2 default null,
130 p_attribute4 in varchar2 default null,
131 p_attribute5 in varchar2 default null,
132 p_attribute6 in varchar2 default null,
133 p_attribute7 in varchar2 default null,
134 p_attribute8 in varchar2 default null,
135 p_attribute9 in varchar2 default null,
136 p_attribute10 in varchar2 default null,
140 p_attribute14 in varchar2 default null,
137 p_attribute11 in varchar2 default null,
138 p_attribute12 in varchar2 default null,
139 p_attribute13 in varchar2 default null,
141 p_attribute15 in varchar2 default null,
142 p_attribute16 in varchar2 default null,
143 p_attribute17 in varchar2 default null,
144 p_attribute18 in varchar2 default null,
145 p_attribute19 in varchar2 default null,
146 p_attribute20 in varchar2 default null,
147 p_path_source_code in varchar2 default null,
148 p_source_function_code in varchar2 default null,
149 p_assignment_id in number default null,
150 p_source_id in number default null,
151 p_notify_days_before_target in number default null,
152 p_person_id in number default null,
153 p_contact_id in number default null,
154 p_display_to_learner_flag in varchar2 default null,
155 p_public_flag in varchar2 default 'Y',
156 p_competency_update_level in varchar2 default null ,
157 p_learning_path_id out nocopy number,
158 p_object_version_number out nocopy number
159 );
160 --
161 -- ----------------------------------------------------------------------------
162 -- |---------------------------< update_learning_path >-----------------------|
163 -- ----------------------------------------------------------------------------
164 --
165 -- {Start Of Comments}
166 /*#
167 * This API updates a Learning Path.
168 *
169 *
170 * <p><b>Licensing</b><br>
171 * This API is licensed for use with Learning Management.
172 *
173 * <p><b>Prerequisites</b><br>
174 * The learning path record with the given object version number should exist.
175 *
176 * <p><b>Post Success</b><br>
177 * The learning path will be successfully updated.
178 *
179 * <p><b>Post Failure</b><br>
180 * The learning path will not be updated and an error will be raised.
181 * @param p_effective_date Reference date for validating lookup values are
182 * applicable during the start to end active date range. This date does not
183 * determine when the changes take effect.
184 * @param p_learning_path_id The unique identifer for the learning path.
185 * @param p_object_version_number Pass in the current version number of the
186 * learning path to be updated. When the API completes if p_validate is false,
187 * the number is set to the new version number of the updated learning path. If
188 * p_validate is true the number remains unchanged.
189 * @param p_path_name The translated name associated with this learning path.
190 * @param p_description The translated description associated with this
191 * learning path.
192 * @param p_objectives The translated objectives associated with this learning
193 * path.
194 * @param p_keywords The translated keyword associated with this learning path.
195 * @param p_purpose The translated purpose associated with this learning path.
196 * @param p_duration {@rep:casecolumn OTA_LEARNING_PATHS.DURATION}.
197 * @param p_duration_units The completion target units of the learning path.
198 * Valid values are defined by the 'OTA_DURATION_UNITS' lookup type.
199 * @param p_start_date_active The date on which learners can begin to subscribe
200 * to the learning path.
201 * @param p_end_date_active The date on which the learning path becomes no
202 * longer available to learners.
203 * @param p_attribute_category This context value determines which flexfield
204 * structure to use with the descriptive flexfield segments.
205 * @param p_attribute1 Descriptive flexfield segment.
206 * @param p_attribute2 Descriptive flexfield segment.
207 * @param p_attribute3 Descriptive flexfield segment.
208 * @param p_attribute4 Descriptive flexfield segment.
209 * @param p_attribute5 Descriptive flexfield segment.
210 * @param p_attribute6 Descriptive flexfield segment.
211 * @param p_attribute7 Descriptive flexfield segment.
212 * @param p_attribute8 Descriptive flexfield segment.
213 * @param p_attribute9 Descriptive flexfield segment.
214 * @param p_attribute10 Descriptive flexfield segment.
215 * @param p_attribute11 Descriptive flexfield segment.
216 * @param p_attribute12 Descriptive flexfield segment.
217 * @param p_attribute13 Descriptive flexfield segment.
218 * @param p_attribute14 Descriptive flexfield segment.
219 * @param p_attribute15 Descriptive flexfield segment.
220 * @param p_attribute16 Descriptive flexfield segment.
221 * @param p_attribute17 Descriptive flexfield segment.
222 * @param p_attribute18 Descriptive flexfield segment.
223 * @param p_attribute19 Descriptive flexfield segment.
224 * @param p_attribute20 Descriptive flexfield segment.
225 * @param p_business_group_id The unique identifier of the business group that
226 * owns this learning path.
227 * @param p_validate If true, then validation alone will be performed and the
228 * database will remain unchanged. If false and all validation checks pass,
229 * then the database will be modified.
230 * @param p_assignment_id Identifies the assignment for which you create the
231 * learning path record.
232 * @param p_source_id Learning path source identifier: Appraisal ID, for
233 * example, if the learning path is created from Appraisals.
234 * @param p_public_flag Identifies whether the catalog learning path is public.
235 * Permissible values are Y and N.
239 * learning path record. Applies only to personal learning paths.
236 * @param p_path_source_code Source of creation of the learning path. Valid
237 * values are CATALOG, EMPLOYEE, MANAGER, TALENT_MGMT.
238 * @param p_contact_id Identifies the external contact for whom you create the
240 * @param p_display_to_learner_flag Decides whether the learning path should be
241 * visible to the learner. Applies only to personal learning paths.
242 * @param p_source_function_code Source of the learning path when created from
243 * Talent Management. Valid values are defined by the
244 * 'OTA_PLAN_COMPONENT_SOURCE' lookup.
245 * @param p_notify_days_before_target Days before which a reminder notification
246 * is sent to the learners subscribed to the learning path. Applies only to
247 * catalog learning paths.
248 * @param p_person_id Identifies the person for whom the learning path is
249 * created. Applies only to personal learning paths.
250 * @param p_competency_update_level Valid values are defined by the
251 * 'OTA_COMPETENCY_UPDATE_LEVEL' lookup type. Specifies the mode of competency
252 * update. This value overrides the value set at the workflow level.
253 * @rep:displayname Update Learning Path
254 * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH
255 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
256 * @rep:scope public
257 * @rep:lifecycle active
258 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
259 */
260 --
261 -- {End Of Comments}
262 --
263 procedure Update_learning_path
264 (
265 p_effective_date in date,
266 p_learning_path_id in number,
267 p_object_version_number in out nocopy number,
268 p_path_name in varchar2 default hr_api.g_varchar2,
269 p_description in varchar2 default hr_api.g_varchar2,
270 p_objectives in varchar2 default hr_api.g_varchar2,
271 p_keywords in varchar2 default hr_api.g_varchar2,
272 p_purpose in varchar2 default hr_api.g_varchar2,
273 p_duration in number default hr_api.g_number,
274 p_duration_units in varchar2 default hr_api.g_varchar2,
275 p_start_date_active in date default hr_api.g_date,
276 p_end_date_active in date default hr_api.g_date,
277 p_attribute_category in varchar2 default hr_api.g_varchar2,
278 p_attribute1 in varchar2 default hr_api.g_varchar2,
279 p_attribute2 in varchar2 default hr_api.g_varchar2,
280 p_attribute3 in varchar2 default hr_api.g_varchar2,
281 p_attribute4 in varchar2 default hr_api.g_varchar2,
282 p_attribute5 in varchar2 default hr_api.g_varchar2,
283 p_attribute6 in varchar2 default hr_api.g_varchar2,
284 p_attribute7 in varchar2 default hr_api.g_varchar2,
285 p_attribute8 in varchar2 default hr_api.g_varchar2,
286 p_attribute9 in varchar2 default hr_api.g_varchar2,
287 p_attribute10 in varchar2 default hr_api.g_varchar2,
288 p_attribute11 in varchar2 default hr_api.g_varchar2,
289 p_attribute12 in varchar2 default hr_api.g_varchar2,
290 p_attribute13 in varchar2 default hr_api.g_varchar2,
291 p_attribute14 in varchar2 default hr_api.g_varchar2,
292 p_attribute15 in varchar2 default hr_api.g_varchar2,
293 p_attribute16 in varchar2 default hr_api.g_varchar2,
294 p_attribute17 in varchar2 default hr_api.g_varchar2,
295 p_attribute18 in varchar2 default hr_api.g_varchar2,
296 p_attribute19 in varchar2 default hr_api.g_varchar2,
297 p_attribute20 in varchar2 default hr_api.g_varchar2,
298 p_business_group_id in number default hr_api.g_number,
299 p_path_source_code in varchar2 default hr_api.g_varchar2,
300 p_source_function_code in varchar2 default hr_api.g_varchar2,
301 p_assignment_id in number default hr_api.g_number,
302 p_source_id in number default hr_api.g_number,
303 p_notify_days_before_target in number default hr_api.g_number,
304 p_person_id in number default hr_api.g_number,
305 p_contact_id in number default hr_api.g_number,
306 p_display_to_learner_flag in varchar2 default hr_api.g_varchar2,
307 p_public_flag in varchar2 default hr_api.g_varchar2,
308 p_validate in boolean default false
309 ,p_competency_update_level in varchar2 default hr_api.g_varchar2
310 );
311 --
312 -- ----------------------------------------------------------------------------
313 -- |---------------------------< delete_learning_path >-----------------------|
314 -- ----------------------------------------------------------------------------
315 --
316 -- {Start Of Comments}
317 /*#
318 * This API deletes the Learning Path.
319 *
320 * A Learning Path cannot be deleted if any learners have subscribed to it.
321 *
322 * <p><b>Licensing</b><br>
323 * This API is licensed for use with Learning Management.
324 *
325 * <p><b>Prerequisites</b><br>
326 * The learning path should not have any subscribers.
327 *
328 * <p><b>Post Success</b><br>
329 * The learning path will be deleted from the database.
330 *
331 * <p><b>Post Failure</b><br>
332 * The learning path will not be deleted and an error will be raised.
333 * @param p_learning_path_id The unique identifier for the learning path.
334 * @param p_object_version_number Current version number of the learning path
335 * to be deleted.
336 * @param p_validate If true, then validation alone will be performed and the
337 * database will remain unchanged. If false and all validation checks pass,
338 * then the database will be modified.
339 * @rep:displayname Delete Learning Path
340 * @rep:category BUSINESS_ENTITY OTA_LEARNING_PATH
341 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
342 * @rep:scope public
343 * @rep:lifecycle active
344 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
345 */
346 --
347 -- {End Of Comments}
348 --
349 procedure delete_learning_path
350 (p_learning_path_id in number
351 ,p_object_version_number in number
352 ,p_validate in boolean default false
353 );
354 end ota_learning_path_api;
[Home] [Help]