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