1 Package ota_cert_prd_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otcpeapi.pkh 120.7 2008/09/22 11:03:27 pekasi ship $ */
3 /*#
4 * This package contains Learning Certification Period Enrollment APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Certification Period Enrollment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_cert_prd_enrollment >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the Certification Period 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 * Certification must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Certification Period Enrollment is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a Certification Period Enrollment record and raises an error.
30 *
31 * @param p_effective_date Reference date for validating that 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_cert_enrollment_id The unique identifier for the parent certification enrollment record.
38 * @param p_period_status_code Status for the Certification Period Enrollment.
39 * Valid values are defined by 'OTA_CERT_PRD_ENROLL_STATUS' lookup type.
40 * @param p_completion_date The date the certification is completed.
41 * @param p_cert_period_start_date The date the certification period begins.
42 * @param p_cert_period_end_date After this date the certification period ends.
43 * @param p_business_group_id The business group owning the Certification Period
44 * Enrollment record of the certification.
45 * @param p_attribute_category This context value determines which flexfield
46 * structure to use with the descriptive flexfield segments.
47 * @param p_attribute1 Descriptive flexfield segment.
48 * @param p_attribute2 Descriptive flexfield segment.
49 * @param p_attribute3 Descriptive flexfield segment.
50 * @param p_attribute4 Descriptive flexfield segment.
51 * @param p_attribute5 Descriptive flexfield segment.
52 * @param p_attribute6 Descriptive flexfield segment.
53 * @param p_attribute7 Descriptive flexfield segment.
54 * @param p_attribute8 Descriptive flexfield segment.
55 * @param p_attribute9 Descriptive flexfield segment.
56 * @param p_attribute10 Descriptive flexfield segment.
57 * @param p_attribute11 Descriptive flexfield segment.
58 * @param p_attribute12 Descriptive flexfield segment.
59 * @param p_attribute13 Descriptive flexfield segment.
60 * @param p_attribute14 Descriptive flexfield segment.
61 * @param p_attribute15 Descriptive flexfield segment.
62 * @param p_attribute16 Descriptive flexfield segment.
63 * @param p_attribute17 Descriptive flexfield segment.
64 * @param p_attribute18 Descriptive flexfield segment.
65 * @param p_attribute19 Descriptive flexfield segment.
66 * @param p_attribute20 Descriptive flexfield segment.
67 * @param p_expiration_date After this date the certification is expired.
68 * @param p_cert_prd_enrollment_id The unique identifier for the Certification Period Enrollment record.
69 * @param p_object_version_number If p_validate is false, then set to the version number of the created
70 * Certification Period Enrollment. If p_validate is true, then the value will be null.
71 * @rep:displayname Create Certification Period Enrollment
72 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
73 * @rep:lifecycle active
74 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
75 * @rep:scope public
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 procedure create_cert_prd_enrollment
82 (
83 p_effective_date in date,
84 p_validate in boolean default false ,
85 p_cert_enrollment_id in number,
86 p_period_status_code in varchar2,
87 p_completion_date in date default null,
88 p_cert_period_start_date in date default null,
89 p_cert_period_end_date in date default null,
90 p_business_group_id in number,
91 p_attribute_category in varchar2 default null,
92 p_attribute1 in varchar2 default null,
93 p_attribute2 in varchar2 default null,
94 p_attribute3 in varchar2 default null,
95 p_attribute4 in varchar2 default null,
96 p_attribute5 in varchar2 default null,
97 p_attribute6 in varchar2 default null,
98 p_attribute7 in varchar2 default null,
99 p_attribute8 in varchar2 default null,
100 p_attribute9 in varchar2 default null,
101 p_attribute10 in varchar2 default null,
102 p_attribute11 in varchar2 default null,
103 p_attribute12 in varchar2 default null,
104 p_attribute13 in varchar2 default null,
105 p_attribute14 in varchar2 default null,
106 p_attribute15 in varchar2 default null,
107 p_attribute16 in varchar2 default null,
108 p_attribute17 in varchar2 default null,
109 p_attribute18 in varchar2 default null,
110 p_attribute19 in varchar2 default null,
111 p_attribute20 in varchar2 default null,
112 p_expiration_date in date default null,
113 p_cert_prd_enrollment_id out nocopy number,
114 p_object_version_number out nocopy number
115 );
116 --
117 -- ----------------------------------------------------------------------------
118 -- |------------------------< update_cert_prd_enrollment >--------------------|
119 -- ----------------------------------------------------------------------------
120 --
121 -- {Start Of Comments}
122 /*#
123 * This API updates the Certification Period Enrollment.
124 *
125 *
126 * <p><b>Licensing</b><br>
127 * This API is licensed for use with Learning Management.
128 *
129 * <p><b>Prerequisites</b><br>
130 * The Certification Period Enrollment record with the given object version number should exist.
131 *
132 * <p><b>Post Success</b><br>
133 * The Certification Period Enrollment is updated successfully.
134 *
135 * <p><b>Post Failure</b><br>
136 * The API does not update the Certification Period Enrollment record, and raises an error.
137 *
138 * @param p_effective_date Reference date for validating that lookup values are applicable during
139 * the start to end active date range. This date does not determine when the changes take effect.
140 * @param p_cert_prd_enrollment_id The unique identifier for the Certification Period Enrollment record.
141 * @param p_object_version_number Pass in the current version number of the Certification Period
142 * Enrollment to be updated. When the API completes if p_validate is false, will be set to the
143 * new version number of the updated Certification Period Enrollment. If p_validate is true
144 * will be set to the same value which was passed in.
145 * @param p_cert_enrollment_id The unique identifier for the parent certification enrollment record.
146 * @param p_period_status_code Status for the Certification Period Enrollment. Valid values are
147 * defined by 'OTA_CERT_PRD_ENROLL_STATUS' lookup type.
148 * @param p_completion_date The date the certification is completed.
149 * @param p_cert_period_start_date The date the certification period begin.
150 * @param p_cert_period_end_date After this date the certification period end.
151 * @param p_business_group_id The business group owning the Certification Period Enrollment record
152 * of the certification.
153 * @param p_attribute_category This context value determines which flexfield
154 * structure to use with the descriptive flexfield segments.
155 * @param p_attribute1 Descriptive flexfield segment.
156 * @param p_attribute2 Descriptive flexfield segment.
157 * @param p_attribute3 Descriptive flexfield segment.
158 * @param p_attribute4 Descriptive flexfield segment.
159 * @param p_attribute5 Descriptive flexfield segment.
160 * @param p_attribute6 Descriptive flexfield segment.
161 * @param p_attribute7 Descriptive flexfield segment.
162 * @param p_attribute8 Descriptive flexfield segment.
163 * @param p_attribute9 Descriptive flexfield segment.
164 * @param p_attribute10 Descriptive flexfield segment.
165 * @param p_attribute11 Descriptive flexfield segment.
166 * @param p_attribute12 Descriptive flexfield segment.
167 * @param p_attribute13 Descriptive flexfield segment.
168 * @param p_attribute14 Descriptive flexfield segment.
169 * @param p_attribute15 Descriptive flexfield segment.
170 * @param p_attribute16 Descriptive flexfield segment.
171 * @param p_attribute17 Descriptive flexfield segment.
172 * @param p_attribute18 Descriptive flexfield segment.
173 * @param p_attribute19 Descriptive flexfield segment.
174 * @param p_attribute20 Descriptive flexfield segment.
175 * @param p_expiration_date After this date the certification period is expired.
176 * @param p_validate If true, then validation alone will be performed and the
177 * database will remain unchanged. If false and all validation checks pass,
178 * then the database will be modified.
179 * @rep:displayname Update Certification Period Enrollment
180 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
181 * @rep:lifecycle active
182 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
183 * @rep:scope public
184 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
185 */
186 --
187 -- {End Of Comments}
188 --
189 procedure update_cert_prd_enrollment
190 (
191 p_effective_date in date,
192 p_cert_prd_enrollment_id in number,
193 p_object_version_number in out nocopy number,
194 p_cert_enrollment_id in number,
195 p_period_status_code in varchar2,
196 p_completion_date in date default hr_api.g_date,
197 p_cert_period_start_date in date default hr_api.g_date,
198 p_cert_period_end_date in date default hr_api.g_date,
199 p_business_group_id in number default hr_api.g_number,
200 p_attribute_category in varchar2 default hr_api.g_varchar2,
201 p_attribute1 in varchar2 default hr_api.g_varchar2,
202 p_attribute2 in varchar2 default hr_api.g_varchar2,
203 p_attribute3 in varchar2 default hr_api.g_varchar2,
204 p_attribute4 in varchar2 default hr_api.g_varchar2,
205 p_attribute5 in varchar2 default hr_api.g_varchar2,
206 p_attribute6 in varchar2 default hr_api.g_varchar2,
207 p_attribute7 in varchar2 default hr_api.g_varchar2,
208 p_attribute8 in varchar2 default hr_api.g_varchar2,
209 p_attribute9 in varchar2 default hr_api.g_varchar2,
210 p_attribute10 in varchar2 default hr_api.g_varchar2,
211 p_attribute11 in varchar2 default hr_api.g_varchar2,
212 p_attribute12 in varchar2 default hr_api.g_varchar2,
213 p_attribute13 in varchar2 default hr_api.g_varchar2,
214 p_attribute14 in varchar2 default hr_api.g_varchar2,
215 p_attribute15 in varchar2 default hr_api.g_varchar2,
216 p_attribute16 in varchar2 default hr_api.g_varchar2,
217 p_attribute17 in varchar2 default hr_api.g_varchar2,
218 p_attribute18 in varchar2 default hr_api.g_varchar2,
219 p_attribute19 in varchar2 default hr_api.g_varchar2,
220 p_attribute20 in varchar2 default hr_api.g_varchar2,
221 p_expiration_date in date default hr_api.g_date,
222 p_validate in boolean default false
223 );
224 --
225 -- ----------------------------------------------------------------------------
226 -- |------------------------< delete_cert_prd_enrollment >--------------------|
227 -- ----------------------------------------------------------------------------
228 --
229 -- {Start Of Comments}
230 /*#
231 * This API deletes the Certification Period Enrollment.
232 *
233 *
234 * <p><b>Licensing</b><br>
235 * This API is licensed for use with Learning Management.
236 *
237 * <p><b>Prerequisites</b><br>
238 * The Certification Period Enrollment record with the given object version number should exist.
239 *
240 * <p><b>Post Success</b><br>
241 * The Certification Period Enrollment is deleted successfully.
242 *
243 * <p><b>Post Failure</b><br>
244 * The API does not delete the Certification Period Enrollment record, and raises an error.
245 *
246 * @param p_cert_prd_enrollment_id The unique identifier for the Certification Period Enrollment record.
247 * @param p_object_version_number Current version number of the Certification Period Enrollment to be deleted.
248 * @param p_validate If true, then validation alone will be performed and the
249 * database will remain unchanged. If false and all validation checks pass,
250 * then the database will be modified.
251 * @rep:displayname Delete Certification Period Enrollment
252 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
253 * @rep:lifecycle active
254 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
255 * @rep:scope public
256 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
257 */
258 --
259 -- {End Of Comments}
260 --
261 procedure delete_cert_prd_enrollment
262 (p_cert_prd_enrollment_id in number
263 ,p_object_version_number in number
264 ,p_validate in boolean default false
265 );
266
267 --
268 -- ----------------------------------------------------------------------------
269 -- |------------------------< renew_cert_prd_enrollment >---------------------|
270 -- ----------------------------------------------------------------------------
271 --
272 -- {Start Of Comments}
273 /*#
274 * This API renews the Certification Period Enrollment.
275 *
276 *
277 * <p><b>Licensing</b><br>
278 * This API is licensed for use with Learning Management.
279 *
280 * <p><b>Prerequisites</b><br>
281 * The Certification Period Enrollment record with the given object version number should exist.
282 *
283 * <p><b>Post Success</b><br>
284 * The Certification Period Enrollment is renewed successfully.
285 *
286 * <p><b>Post Failure</b><br>
287 * The API does not renew the Certification Period Enrollment record, and raises an error.
288 *
289 * @param p_validate If true, then validation alone will be performed and the
290 * database will remain unchanged. If false and all validation checks pass,
291 * then the database will be modified.
292 * @param p_cert_enrollment_id The unique identifier for the parent Certification Enrollment record.
293 * @param p_cert_prd_enrollment_id The unique identifier for the Certification Period Enrollment record.
294 * @param p_cert_period_start_date The period start date for the Certification Period Enrollment record.
295 * @param p_certification_status_code Status for the Certification Enrollment. Valid values are defined
296 * by 'OTA_CERT_ENROLL_STATUS' lookup type.
297 * @rep:displayname Renew Certification Period Enrollment
298 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
299 * @rep:lifecycle active
300 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
301 * @rep:scope public
302 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
303 */
304 --
305 -- {End Of Comments}
306 --
307
308 procedure renew_cert_prd_enrollment(p_validate in boolean default false
309 ,p_cert_enrollment_id in number
310 ,p_cert_period_start_date in date default sysdate
311 ,p_cert_prd_enrollment_id OUT NOCOPY number
312 ,p_certification_status_code OUT NOCOPY VARCHAR2);
313
314 end ota_cert_prd_enrollment_api;
[Home] [Help]