4 * This package contains Learning Certification Enrollment APIs.
1 Package ota_cert_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otcreapi.pkh 120.8.12020000.3 2012/11/22 12:14:40 shwnayak ship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Certification Enrollment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_cert_enrollment >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the Certification Enrollment.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Learning Management.
21 *
22 * <p><b>Prerequisites</b><br>
23 * This Certification and certification components should exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Certification Enrollment is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a Certification Enrollment record and raises an error.
30 *
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_certification_id The unique identifier for the certification record.
38 * @param p_person_id The unique identifier for the person.
39 * @param p_contact_id The unique identifier for the customer contact.
40 * @param p_certification_status_code Status for the Certification Enrollment.
41 * Valid values are defined by 'OTA_CERT_ENROLL_STATUS' lookup type.
42 * @param p_completion_date The date the certification is completed.
43 * @param p_unenrollment_date The date the certification is unsubscribed.
44 * @param p_expiration_date After this date the certification is expired.
45 * @param p_earliest_enroll_date The date from which learner can renew the certification.
46 * @param p_is_history_flag Flag to determine whether learner moved the certification to history.
47 * @param p_business_group_id The business group owning the Certification
48 * Enrollment record of the certification.
49 * @param p_attribute_category This context value determines which flexfield
50 * structure to use with the descriptive flexfield segments.
51 * @param p_attribute1 Descriptive flexfield segment.
52 * @param p_attribute2 Descriptive flexfield segment.
53 * @param p_attribute3 Descriptive flexfield segment.
54 * @param p_attribute4 Descriptive flexfield segment.
55 * @param p_attribute5 Descriptive flexfield segment.
56 * @param p_attribute6 Descriptive flexfield segment.
57 * @param p_attribute7 Descriptive flexfield segment.
58 * @param p_attribute8 Descriptive flexfield segment.
59 * @param p_attribute9 Descriptive flexfield segment.
60 * @param p_attribute10 Descriptive flexfield segment.
61 * @param p_attribute11 Descriptive flexfield segment.
62 * @param p_attribute12 Descriptive flexfield segment.
63 * @param p_attribute13 Descriptive flexfield segment.
64 * @param p_attribute14 Descriptive flexfield segment.
68 * @param p_attribute18 Descriptive flexfield segment.
65 * @param p_attribute15 Descriptive flexfield segment.
66 * @param p_attribute16 Descriptive flexfield segment.
67 * @param p_attribute17 Descriptive flexfield segment.
69 * @param p_attribute19 Descriptive flexfield segment.
70 * @param p_attribute20 Descriptive flexfield segment.
71 * @param p_enrollment_date The date the learner subscribed to this certification.
72 * @param p_cert_enrollment_id The unique identifier for the Certification Enrollment record.
73 * @param p_object_version_number If p_validate is false, then set to the version number of
74 * the created Certification Enrollment. If p_validate is true, then the value will be null.
75 * @rep:displayname Create Certification Enrollment
76 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
77 * @rep:lifecycle active
78 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
79 * @rep:scope public
80 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
81 */
82 --
83 -- {End Of Comments}
84 --
85 procedure create_cert_enrollment
86 (
87 p_effective_date in date,
88 p_validate in boolean default false ,
89 p_certification_id in number,
90 p_person_id in number default null,
91 p_contact_id in number default null,
92 p_certification_status_code in varchar2,
93 p_completion_date in date default null,
94 p_UNENROLLMENT_DATE in date default null,
95 p_EXPIRATION_DATE in date default null,
96 p_EARLIEST_ENROLL_DATE in date default null,
97 p_IS_HISTORY_FLAG in varchar2 default 'N',
98 p_business_group_id in number,
99 p_attribute_category in varchar2 default null,
100 p_attribute1 in varchar2 default null,
101 p_attribute2 in varchar2 default null,
102 p_attribute3 in varchar2 default null,
103 p_attribute4 in varchar2 default null,
104 p_attribute5 in varchar2 default null,
105 p_attribute6 in varchar2 default null,
106 p_attribute7 in varchar2 default null,
107 p_attribute8 in varchar2 default null,
108 p_attribute9 in varchar2 default null,
109 p_attribute10 in varchar2 default null,
110 p_attribute11 in varchar2 default null,
111 p_attribute12 in varchar2 default null,
112 p_attribute13 in varchar2 default null,
113 p_attribute14 in varchar2 default null,
114 p_attribute15 in varchar2 default null,
115 p_attribute16 in varchar2 default null,
116 p_attribute17 in varchar2 default null,
117 p_attribute18 in varchar2 default null,
118 p_attribute19 in varchar2 default null,
119 p_attribute20 in varchar2 default null,
120 p_enrollment_date in date default null,
121 p_cert_enrollment_id out nocopy number,
122 p_object_version_number out nocopy number,
123 p_is_automatic_subscription in varchar2 default 'N'
124 );
125 --
126 -- ----------------------------------------------------------------------------
127 -- |--------------------------< update_cert_enrollment >----------------------|
128 -- ----------------------------------------------------------------------------
129 --
130 -- {Start Of Comments}
131 /*#
132 * This API updates the Certification Enrollment.
133 *
134 *
135 * <p><b>Licensing</b><br>
136 * This API is licensed for use with Learning Management.
137 *
138 * <p><b>Prerequisites</b><br>
139 * The Certification Enrollment record with the given object version number should exist.
140 *
141 * <p><b>Post Success</b><br>
142 * The Certification Enrollment is updated successfully.
143 *
144 * <p><b>Post Failure</b><br>
145 * The API does not update the Certification Enrollment record, and raises an error.
146 *
147 * @param p_effective_date Reference date for validating that lookup values are
148 * applicable during the start to end active date range. This date does not
149 * determine when the changes take effect.
150 * @param p_cert_enrollment_id The unique identifier for the Certification Enrollment record.
151 * @param p_object_version_number Pass in the current version number of the Certification
152 * Enrollment to be updated. When the API completes if p_validate is false,
153 * will be set to the new version number of the updated Certification Enrollment.
154 * If p_validate is true will be set to the same value which was passed in.
155 * @param p_certification_id The unique identifier for the certification record.
156 * @param p_person_id The unique identifier for the person.
157 * @param p_contact_id The unique identifier for the customer contact.
158 * @param p_certification_status_code Status for the Certification Enrollment.
159 * Valid values are defined by 'OTA_CERT_ENROLL_STATUS' lookup type.
160 * @param p_completion_date The date the certification is completed.
161 * @param p_unenrollment_date The date the certification is unsubscribed.
162 * @param p_expiration_date After this date the certification is expired.
163 * @param p_earliest_enroll_date The date from which learner can renew the certification.
164 * @param p_is_history_flag Flag to determine whether learner moved the certification to history.
168 * @param p_attribute1 Descriptive flexfield segment.
165 * @param p_business_group_id The business group owning the Certification Enrollment record of the certification.
166 * @param p_attribute_category This context value determines which flexfield
167 * structure to use with the descriptive flexfield segments.
169 * @param p_attribute2 Descriptive flexfield segment.
170 * @param p_attribute3 Descriptive flexfield segment.
171 * @param p_attribute4 Descriptive flexfield segment.
172 * @param p_attribute5 Descriptive flexfield segment.
173 * @param p_attribute6 Descriptive flexfield segment.
174 * @param p_attribute7 Descriptive flexfield segment.
175 * @param p_attribute8 Descriptive flexfield segment.
176 * @param p_attribute9 Descriptive flexfield segment.
177 * @param p_attribute10 Descriptive flexfield segment.
178 * @param p_attribute11 Descriptive flexfield segment.
179 * @param p_attribute12 Descriptive flexfield segment.
180 * @param p_attribute13 Descriptive flexfield segment.
181 * @param p_attribute14 Descriptive flexfield segment.
182 * @param p_attribute15 Descriptive flexfield segment.
183 * @param p_attribute16 Descriptive flexfield segment.
184 * @param p_attribute17 Descriptive flexfield segment.
185 * @param p_attribute18 Descriptive flexfield segment.
186 * @param p_attribute19 Descriptive flexfield segment.
187 * @param p_attribute20 Descriptive flexfield segment.
188 * @param p_enrollment_date The date the learner subscribed to this certification.
189 * @param p_validate If true, then validation alone will be performed and the
190 * database will remain unchanged. If false and all validation checks pass,
191 * then the database will be modified.
192 * @rep:displayname Update Certification Enrollment
193 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
194 * @rep:lifecycle active
195 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
196 * @rep:scope public
197 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
198 */
199 --
200 -- {End Of Comments}
201 --
202 procedure update_cert_enrollment
203 (
204 p_effective_date in date,
205 p_cert_enrollment_id in number,
206 p_object_version_number in out nocopy number,
207 p_certification_id in number,
208 p_person_id in number default hr_api.g_number,
209 p_contact_id in number default hr_api.g_number,
210 p_certification_status_code in varchar2 default hr_api.g_varchar2,
211 p_completion_date in date default hr_api.g_date,
212 p_UNENROLLMENT_DATE in date default hr_api.g_date,
213 p_EXPIRATION_DATE in date default hr_api.g_date,
214 p_EARLIEST_ENROLL_DATE in date default hr_api.g_date,
215 p_IS_HISTORY_FLAG in varchar2 default hr_api.g_varchar2,
216 p_business_group_id in number default hr_api.g_number,
217 p_attribute_category in varchar2 default hr_api.g_varchar2,
218 p_attribute1 in varchar2 default hr_api.g_varchar2,
219 p_attribute2 in varchar2 default hr_api.g_varchar2,
220 p_attribute3 in varchar2 default hr_api.g_varchar2,
221 p_attribute4 in varchar2 default hr_api.g_varchar2,
222 p_attribute5 in varchar2 default hr_api.g_varchar2,
223 p_attribute6 in varchar2 default hr_api.g_varchar2,
224 p_attribute7 in varchar2 default hr_api.g_varchar2,
225 p_attribute8 in varchar2 default hr_api.g_varchar2,
226 p_attribute9 in varchar2 default hr_api.g_varchar2,
227 p_attribute10 in varchar2 default hr_api.g_varchar2,
228 p_attribute11 in varchar2 default hr_api.g_varchar2,
229 p_attribute12 in varchar2 default hr_api.g_varchar2,
230 p_attribute13 in varchar2 default hr_api.g_varchar2,
231 p_attribute14 in varchar2 default hr_api.g_varchar2,
232 p_attribute15 in varchar2 default hr_api.g_varchar2,
233 p_attribute16 in varchar2 default hr_api.g_varchar2,
234 p_attribute17 in varchar2 default hr_api.g_varchar2,
235 p_attribute18 in varchar2 default hr_api.g_varchar2,
236 p_attribute19 in varchar2 default hr_api.g_varchar2,
237 p_attribute20 in varchar2 default hr_api.g_varchar2,
238 p_enrollment_date in date default hr_api.g_date,
239 p_validate in boolean default false
240 );
241 --
242 -- ----------------------------------------------------------------------------
243 -- |--------------------------< delete_cert_enrollment >----------------------|
244 -- ----------------------------------------------------------------------------
245 --
246 -- {Start Of Comments}
247 /*#
248 * This API deletes the certification enrollment.
249 *
250 *
251 * <p><b>Licensing</b><br>
252 * This API is licensed for use with Learning Management.
253 *
254 * <p><b>Prerequisites</b><br>
255 * The certification enrollment record with the given object version number should exist.
256 *
257 * <p><b>Post Success</b><br>
258 * The certification enrollment is deleted successfully.
259 *
260 * <p><b>Post Failure</b><br>
261 * The API does not delete the certification enrollment record, and raises an error.
262 *
263 * @param p_cert_enrollment_id The unique identifier for the certification enrollment record.
267 * then the database will be modified.
264 * @param p_object_version_number Current version number of the certification enrollment to be deleted.
265 * @param p_validate If true, then validation alone will be performed and the
266 * database will remain unchanged. If false and all validation checks pass,
268 * @rep:displayname Delete certification enrollment
269 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
270 * @rep:lifecycle active
271 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
272 * @rep:scope public
273 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
274 */
275 --
276 -- {End Of Comments}
277 --
278 procedure delete_cert_enrollment
279 (p_cert_enrollment_id in number
280 ,p_object_version_number in number
281 ,p_validate in boolean default false
282 );
283
284 --
285 -- ----------------------------------------------------------------------------
286 -- |------------------------< subscribe_to_certification >--------------------|
287 -- ----------------------------------------------------------------------------
288 --
289 -- {Start Of Comments}
290 /*#
291 * This API subscribes learner to Certification.
292 *
293 *
294 * <p><b>Licensing</b><br>
295 * This API is licensed for use with Learning Management.
296 *
297 * <p><b>Prerequisites</b><br>
298 * The certification enrollment record with the given object version number should exist.
299 *
300 * <p><b>Post Success</b><br>
301 * The Certification subscription is created successfully.
302 *
303 * <p><b>Post Failure</b><br>
304 * The API does not create a Certification subscription record, and raises an error.
305 *
306 * @param p_validate If true, then validation alone will be performed and the
307 * database will remain unchanged. If false and all validation checks pass,
308 * then the database will be modified.
309 * @param p_certification_id The unique identifier for the certification record.
310 * @param p_person_id The unique identifier for the person.
311 * @param p_contact_id The unique identifier for the customer contact.
312 * @param p_business_group_id The business group owning the Certification Enrollment
313 * record of the certification.
314 * @param p_approval_flag The approval flag containing values; 'N' = non-approval,
315 * 'A' = requested approval, 'S' = approved.
316 * @param p_completion_date The date the certification is completed.
317 * @param p_unenrollment_date The date the certification is unsubscribed.
318 * @param p_expiration_date After this date the certification is expired.
319 * @param p_earliest_enroll_date The date from which learner can renew the certification.
320 * @param p_is_history_flag Flag to determine whether learner moved the certification to history.
321 * @param p_attribute_category This context value determines which flexfield
322 * structure to use with the descriptive flexfield segments.
323 * @param p_attribute1 Descriptive flexfield segment.
324 * @param p_attribute2 Descriptive flexfield segment.
325 * @param p_attribute3 Descriptive flexfield segment.
326 * @param p_attribute4 Descriptive flexfield segment.
327 * @param p_attribute5 Descriptive flexfield segment.
328 * @param p_attribute6 Descriptive flexfield segment.
329 * @param p_attribute7 Descriptive flexfield segment.
330 * @param p_attribute8 Descriptive flexfield segment.
331 * @param p_attribute9 Descriptive flexfield segment.
332 * @param p_attribute10 Descriptive flexfield segment.
333 * @param p_attribute11 Descriptive flexfield segment.
334 * @param p_attribute12 Descriptive flexfield segment.
335 * @param p_attribute13 Descriptive flexfield segment.
336 * @param p_attribute14 Descriptive flexfield segment.
337 * @param p_attribute15 Descriptive flexfield segment.
338 * @param p_attribute16 Descriptive flexfield segment.
339 * @param p_attribute17 Descriptive flexfield segment.
340 * @param p_attribute18 Descriptive flexfield segment.
341 * @param p_attribute19 Descriptive flexfield segment.
342 * @param p_attribute20 Descriptive flexfield segment.
343 * @param p_enrollment_date The date the learner subscribed to this certification.
344 * @param p_cert_enrollment_id The unique identifier for the Certification Enrollment record.
345 * @param p_certification_status_code Status for the Certification Enrollment.
346 * Valid values are defined by 'OTA_CERT_ENROLL_STATUS' lookup type.
347 * @param p_enroll_from Flag to determine subscription outside the learner interface.
348 * @rep:displayname Subscribe Certification Enrollment
349 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
350 * @rep:lifecycle active
351 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
352 * @rep:scope public
353 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
354 */
355 --
356 -- {End Of Comments}
357 --
358
359 procedure subscribe_to_certification
360 (p_validate in boolean default false
361 ,p_certification_id IN NUMBER
362 ,p_person_id IN NUMBER default null
363 ,p_contact_id IN NUMBER default null
364 ,p_business_group_id IN NUMBER
365 ,p_approval_flag IN VARCHAR2
366 ,p_completion_date in date default null
367 ,p_unenrollment_date in date default null
368 ,p_expiration_date in date default null
369 ,p_earliest_enroll_date in date default null
370 ,p_is_history_flag in varchar2
371 ,p_attribute_category in varchar2 default null
372 ,p_attribute1 in varchar2 default null
373 ,p_attribute2 in varchar2 default null
374 ,p_attribute3 in varchar2 default null
375 ,p_attribute4 in varchar2 default null
376 ,p_attribute5 in varchar2 default null
380 ,p_attribute9 in varchar2 default null
377 ,p_attribute6 in varchar2 default null
378 ,p_attribute7 in varchar2 default null
379 ,p_attribute8 in varchar2 default null
381 ,p_attribute10 in varchar2 default null
382 ,p_attribute11 in varchar2 default null
383 ,p_attribute12 in varchar2 default null
384 ,p_attribute13 in varchar2 default null
385 ,p_attribute14 in varchar2 default null
386 ,p_attribute15 in varchar2 default null
387 ,p_attribute16 in varchar2 default null
388 ,p_attribute17 in varchar2 default null
389 ,p_attribute18 in varchar2 default null
390 ,p_attribute19 in varchar2 default null
391 ,p_attribute20 in varchar2 default null
392 ,p_enrollment_date in date default null
393 ,p_cert_enrollment_id OUT NOCOPY NUMBER
394 ,p_certification_status_code OUT NOCOPY VARCHAR2
395 ,p_enroll_from in varchar2 default null
396 ,p_is_automatic_subscription in varchar2 default 'N'
397 );
398
399 end ota_cert_enrollment_api;
[Home] [Help]