1 Package ota_lp_member_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otlmeapi.pkh 120.3 2009/05/27 13:15:53 pekasi ship $ */
3 /*#
4 * This package contains learning path component enrollment APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Learning Path Component Enrollment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_lp_member_enrollment >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a learning path component enrollment record.
17 *
18 * This business process allows the user to create a learning path component
19 * enrollment record within the context of a learning path.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Learning Management.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Learning Path, Learning Path Section, Learning Path Component and Learning
26 * Path Enrollment records must exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The learning path component enrollment record is successfully created.
30 *
31 * <p><b>Post Failure</b><br>
32 * The learning path component enrollment record is not created and an error is
33 * raised.
34 *
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_lp_enrollment_id The unique identifier of the learning path
42 * enrollment under which the component enrollment record is being created.
43 * @param p_learning_path_section_id The unique identifier of the learning path
44 * section to which the learning path component belongs.
45 * @param p_learning_path_member_id The unique identifer of the learning path
46 * component to which the enrollment is being made.
47 * @param p_member_status_code Status of the learning path component
48 * enrollment. Valid values are defined by 'OTA_LP_MEMBER_STATUS' lookup type.
49 * @param p_completion_target_date Date before which the learner has to
50 * complete the learning path component.
51 * @param p_completion_date Date on which the learner has completed the
52 * learning path component.
53 * @param p_business_group_id The unique identifer of the business group to
54 * which the learning path belongs.
55 * @param p_attribute_category This context value determines which flexfield
56 * structure to use with the descriptive flexfield segments.
57 * @param p_attribute1 Descriptive flexfield segment.
58 * @param p_attribute2 Descriptive flexfield segment.
59 * @param p_attribute3 Descriptive flexfield segment.
60 * @param p_attribute4 Descriptive flexfield segment.
61 * @param p_attribute5 Descriptive flexfield segment.
62 * @param p_attribute6 Descriptive flexfield segment.
63 * @param p_attribute7 Descriptive flexfield segment.
64 * @param p_attribute8 Descriptive flexfield segment.
65 * @param p_attribute9 Descriptive flexfield segment.
66 * @param p_attribute10 Descriptive flexfield segment.
67 * @param p_attribute11 Descriptive flexfield segment.
68 * @param p_attribute12 Descriptive flexfield segment.
69 * @param p_attribute13 Descriptive flexfield segment.
70 * @param p_attribute14 Descriptive flexfield segment.
71 * @param p_attribute15 Descriptive flexfield segment.
72 * @param p_attribute16 Descriptive flexfield segment.
73 * @param p_attribute17 Descriptive flexfield segment.
74 * @param p_attribute18 Descriptive flexfield segment.
75 * @param p_attribute19 Descriptive flexfield segment.
76 * @param p_attribute20 Descriptive flexfield segment.
77 * @param p_attribute21 Descriptive flexfield segment.
78 * @param p_attribute22 Descriptive flexfield segment.
79 * @param p_attribute23 Descriptive flexfield segment.
80 * @param p_attribute24 Descriptive flexfield segment.
81 * @param p_attribute25 Descriptive flexfield segment.
82 * @param p_attribute26 Descriptive flexfield segment.
83 * @param p_attribute27 Descriptive flexfield segment.
84 * @param p_attribute28 Descriptive flexfield segment.
85 * @param p_attribute29 Descriptive flexfield segment.
86 * @param p_attribute30 Descriptive flexfield segment.
87 * @param p_creator_person_id Unique identifier of the person who created the
88 * learning path component.
89 * @param p_event_id to identify whether this class is enrolled through
90 * learning path or not.
91 * @param p_lp_member_enrollment_id The unique identifier of the learning path
92 * component enrollment record which is being updated.
93 * @param p_object_version_number If p_validate is false, then set to the
94 * version number of the created learning path component enrollment. If
95 * p_validate is true, then the value will be null.
96 * @rep:displayname Create Learning Path Component Enrollment
97 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
98 * @rep:lifecycle active
99 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
100 * @rep:scope public
101 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
102 */
103 --
104 -- {End Of Comments}
105 --
106 procedure create_lp_member_enrollment
107 (
108 p_effective_date in date,
109 p_validate in boolean default false ,
110 p_lp_enrollment_id in number,
111 p_learning_path_section_id in number default null,
112 p_learning_path_member_id in number default null,
113 p_member_status_code in varchar2,
114 p_completion_target_date in date default null,
115 p_completion_date in date default null,
116 p_business_group_id in number,
117 p_attribute_category in varchar2 default null,
118 p_attribute1 in varchar2 default null,
119 p_attribute2 in varchar2 default null,
120 p_attribute3 in varchar2 default null,
121 p_attribute4 in varchar2 default null,
122 p_attribute5 in varchar2 default null,
123 p_attribute6 in varchar2 default null,
124 p_attribute7 in varchar2 default null,
125 p_attribute8 in varchar2 default null,
126 p_attribute9 in varchar2 default null,
127 p_attribute10 in varchar2 default null,
128 p_attribute11 in varchar2 default null,
129 p_attribute12 in varchar2 default null,
130 p_attribute13 in varchar2 default null,
131 p_attribute14 in varchar2 default null,
132 p_attribute15 in varchar2 default null,
133 p_attribute16 in varchar2 default null,
134 p_attribute17 in varchar2 default null,
135 p_attribute18 in varchar2 default null,
136 p_attribute19 in varchar2 default null,
137 p_attribute20 in varchar2 default null,
138 p_attribute21 in varchar2 default null,
139 p_attribute22 in varchar2 default null,
140 p_attribute23 in varchar2 default null,
141 p_attribute24 in varchar2 default null,
142 p_attribute25 in varchar2 default null,
143 p_attribute26 in varchar2 default null,
144 p_attribute27 in varchar2 default null,
145 p_attribute28 in varchar2 default null,
146 p_attribute29 in varchar2 default null,
147 p_attribute30 in varchar2 default null,
148 p_creator_person_id in number default null,
149 p_event_id in number default null,
150 p_lp_member_enrollment_id out nocopy number,
151 p_object_version_number out nocopy number
152 );
153 --
154 -- ----------------------------------------------------------------------------
155 -- |-----------------------< update_lp_member_enrollment >--------------------|
156 -- ----------------------------------------------------------------------------
157 --
158 -- {Start Of Comments}
159 /*#
160 * This API updates the learning path component enrollment record.
161 *
162 * This business process allows the user to update a learning path component
163 * enrollment record within the context of a learning path.
164 *
165 * <p><b>Licensing</b><br>
166 * This API is licensed for use with Learning Management.
167 *
168 * <p><b>Prerequisites</b><br>
169 * The learning path component enrollment record with the given object version
170 * number must exist.
171 *
172 * <p><b>Post Success</b><br>
173 * The learning path component enrollment record is successfully updated.
174 *
175 * <p><b>Post Failure</b><br>
176 * The learning path component enrollment record is not updated and an error is
177 * raised.
178 *
179 * @param p_effective_date Reference date for validating lookup values are
180 * applicable during the start to end active date range. This date does not
181 * determine when the changes take effect.
182 * @param p_lp_member_enrollment_id The unique identifier of the learning path
183 * component enrollment record which is being updated.
184 * @param p_object_version_number Pass in the current version number of the
185 * learning path component enrollment to be updated. When the API completes if
186 * p_validate is false, will be set to the new version number of the updated
187 * learning path component enrollment. If p_validate is true will be set to the
188 * same value which was passed in.
189 * @param p_lp_enrollment_id The unique identifier of the learning path
190 * component enrollment record which is being updated.
191 * @param p_learning_path_section_id The unique identifier of the learning path
192 * section to which the learning path component belongs.
193 * @param p_learning_path_member_id The unique identifer of the learning path
194 * component to which the enrollment is being made.
195 * @param p_member_status_code Status of the learning path component
196 * enrollment. Valid values are defined by 'OTA_LP_MEMBER_STATUS' lookup type.
197 * @param p_completion_target_date Date before which the learner has to
198 * complete the learning path component.
199 * @param p_completion_date Date on which the learner has completed the
200 * learning path component.
201 * @param p_attribute_category This context value determines which flexfield
202 * structure to use with the descriptive flexfield segments.
206 * @param p_attribute4 Descriptive flexfield segment.
203 * @param p_attribute1 Descriptive flexfield segment.
204 * @param p_attribute2 Descriptive flexfield segment.
205 * @param p_attribute3 Descriptive flexfield segment.
207 * @param p_attribute5 Descriptive flexfield segment.
208 * @param p_attribute6 Descriptive flexfield segment.
209 * @param p_attribute7 Descriptive flexfield segment.
210 * @param p_attribute8 Descriptive flexfield segment.
211 * @param p_attribute9 Descriptive flexfield segment.
212 * @param p_attribute10 Descriptive flexfield segment.
213 * @param p_attribute11 Descriptive flexfield segment.
214 * @param p_attribute12 Descriptive flexfield segment.
215 * @param p_attribute13 Descriptive flexfield segment.
216 * @param p_attribute14 Descriptive flexfield segment.
217 * @param p_attribute15 Descriptive flexfield segment.
218 * @param p_attribute16 Descriptive flexfield segment.
219 * @param p_attribute17 Descriptive flexfield segment.
220 * @param p_attribute18 Descriptive flexfield segment.
221 * @param p_attribute19 Descriptive flexfield segment.
222 * @param p_attribute20 Descriptive flexfield segment.
223 * @param p_attribute21 Descriptive flexfield segment.
224 * @param p_attribute22 Descriptive flexfield segment.
225 * @param p_attribute23 Descriptive flexfield segment.
226 * @param p_attribute24 Descriptive flexfield segment.
227 * @param p_attribute25 Descriptive flexfield segment.
228 * @param p_attribute26 Descriptive flexfield segment.
229 * @param p_attribute27 Descriptive flexfield segment.
230 * @param p_attribute28 Descriptive flexfield segment.
231 * @param p_attribute29 Descriptive flexfield segment.
232 * @param p_attribute30 Descriptive flexfield segment.
233 * @param p_creator_person_id The unique identifier of the person who created
234 * the learning path component.
235 * @param p_business_group_id The unique identifer of the business group to
236 * which the learning path belongs.
237 * @param p_validate If true, then validation alone will be performed and the
238 * database will remain unchanged. If false and all validation checks pass,
239 * then the database will be modified.
240 * @param p_event_id to identify whether this class is enrolled through
241 * learning path or not.
242 * @rep:displayname Update Learning Path Component Enrollment
243 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
244 * @rep:lifecycle active
245 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
246 * @rep:scope public
247 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
248 */
249 --
250 -- {End Of Comments}
251 --
252 procedure Update_lp_member_enrollment
253 (
254 p_effective_date in date,
255 p_lp_member_enrollment_id in number,
256 p_object_version_number in out nocopy number,
257 p_lp_enrollment_id in number default hr_api.g_number,
258 p_learning_path_section_id in number default hr_api.g_number,
259 p_learning_path_member_id in number default hr_api.g_number,
260 p_member_status_code in varchar2 default hr_api.g_varchar2,
261 p_completion_target_date in date default hr_api.g_date,
262 p_completion_date in date default hr_api.g_date,
263 p_attribute_category in varchar2 default hr_api.g_varchar2,
264 p_attribute1 in varchar2 default hr_api.g_varchar2,
265 p_attribute2 in varchar2 default hr_api.g_varchar2,
266 p_attribute3 in varchar2 default hr_api.g_varchar2,
267 p_attribute4 in varchar2 default hr_api.g_varchar2,
268 p_attribute5 in varchar2 default hr_api.g_varchar2,
269 p_attribute6 in varchar2 default hr_api.g_varchar2,
270 p_attribute7 in varchar2 default hr_api.g_varchar2,
271 p_attribute8 in varchar2 default hr_api.g_varchar2,
272 p_attribute9 in varchar2 default hr_api.g_varchar2,
273 p_attribute10 in varchar2 default hr_api.g_varchar2,
274 p_attribute11 in varchar2 default hr_api.g_varchar2,
275 p_attribute12 in varchar2 default hr_api.g_varchar2,
276 p_attribute13 in varchar2 default hr_api.g_varchar2,
277 p_attribute14 in varchar2 default hr_api.g_varchar2,
278 p_attribute15 in varchar2 default hr_api.g_varchar2,
279 p_attribute16 in varchar2 default hr_api.g_varchar2,
280 p_attribute17 in varchar2 default hr_api.g_varchar2,
281 p_attribute18 in varchar2 default hr_api.g_varchar2,
282 p_attribute19 in varchar2 default hr_api.g_varchar2,
283 p_attribute20 in varchar2 default hr_api.g_varchar2,
284 p_attribute21 in varchar2 default hr_api.g_varchar2,
285 p_attribute22 in varchar2 default hr_api.g_varchar2,
286 p_attribute23 in varchar2 default hr_api.g_varchar2,
287 p_attribute24 in varchar2 default hr_api.g_varchar2,
288 p_attribute25 in varchar2 default hr_api.g_varchar2,
289 p_attribute26 in varchar2 default hr_api.g_varchar2,
290 p_attribute27 in varchar2 default hr_api.g_varchar2,
291 p_attribute28 in varchar2 default hr_api.g_varchar2,
292 p_attribute29 in varchar2 default hr_api.g_varchar2,
293 p_attribute30 in varchar2 default hr_api.g_varchar2,
294 p_creator_person_id in number default hr_api.g_number,
295 p_business_group_id in number default hr_api.g_number,
299 --
296 p_validate in boolean default false,
297 p_event_id in number default hr_api.g_number
298 );
300 -- ----------------------------------------------------------------------------
301 -- |-----------------------< delete_lp_member_enrollment >--------------------|
302 -- ----------------------------------------------------------------------------
303 --
304 -- {Start Of Comments}
305 /*#
306 * This API deletes a learning path component enrollment record.
307 *
308 * This business process allows the user to delete a learning path component
309 * enrollment within the Learning Path functionality.
310 *
311 * <p><b>Licensing</b><br>
312 * This API is licensed for use with Learning Management.
313 *
314 * <p><b>Prerequisites</b><br>
315 * The learning path component enrollment record with the given object version
316 * number must exist.
317 *
318 * <p><b>Post Success</b><br>
319 * The learning path component enrollment record is successfully removed from
320 * the database.
321 *
322 * <p><b>Post Failure</b><br>
323 * The learning path component enrollment record is not deleted and an error is
324 * raised.
325 *
326 * @param p_lp_member_enrollment_id The unique identifier of the learning path
327 * component enrollment record which is being deleted.
328 * @param p_object_version_number Current version number of the learning path
329 * component enrollment to be deleted.
330 * @param p_validate If true, then validation alone will be performed and the
331 * database will remain unchanged. If false and all validation checks pass,
332 * then the database will be modified.
333 * @rep:displayname Delete learning path component enrollment
334 * @rep:category BUSINESS_ENTITY OTA_LP_SUBSCRIPTION
335 * @rep:lifecycle active
336 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
337 * @rep:scope public
338 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
339 */
340 --
341 -- {End Of Comments}
342 --
343 procedure delete_lp_member_enrollment
344 (p_lp_member_enrollment_id in number
345 ,p_object_version_number in number
346 ,p_validate in boolean default false
347 );
348 end ota_lp_member_enrollment_api;
[Home] [Help]