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