1 Package ota_certification_api AUTHID CURRENT_USER as
2 /* $Header: otcrtapi.pkh 120.5 2006/07/14 09:29:45 niarora noship $ */
3 /*#
4 * This package contains learning certification APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Learning Certification
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_certification >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a learning certification.
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 * The Business group record must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The learning certification is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create learning certification 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_name The name of the learning certification.
38 * @param p_business_group_id The business group for the certification.
39 * @param p_public_flag This flag determines that no learner access is defined and
40 * grants access to all learners within a business group.
41 * @param p_initial_completion_date The initial date by which learners must complete the learning certification.
42 * @param p_initial_completion_duration The initial duration provided to learners to complete
43 * the learning certification.
44 * @param p_initial_compl_duration_units The duration units for initial completion duration.
45 * @param p_renewal_duration The renewal duration provided to learners to re-certify the learning certification.
46 * @param p_renewal_duration_units The duration units for renewal duration.
47 * @param p_notify_days_before_expire Learners are notified this number of days before
48 * certification initial completion/expiration.
49 * @param p_start_date_active Learning certification active start date.
50 * @param p_end_date_active Learning certification active end date. After this date the object is not active anymore.
51 * @param p_description The description for learning certification.
52 * @param p_objectives The objectives for learning certification.
53 * @param p_purpose The purpose of the learning certification.
54 * @param p_keywords The keywords for learning certification.
55 * @param p_end_date_comments The comments for end date field.
56 * @param p_initial_period_comments The comments for initial completion.
57 * @param p_renewal_period_comments The comments for renewal completion.
58 * @param p_attribute_category This context value determines which flexfield
59 * structure to use with the descriptive flexfield segments.
60 * @param p_attribute1 Descriptive flexfield segment.
61 * @param p_attribute2 Descriptive flexfield segment.
62 * @param p_attribute3 Descriptive flexfield segment.
63 * @param p_attribute4 Descriptive flexfield segment.
64 * @param p_attribute5 Descriptive flexfield segment.
65 * @param p_attribute6 Descriptive flexfield segment.
66 * @param p_attribute7 Descriptive flexfield segment.
67 * @param p_attribute8 Descriptive flexfield segment.
68 * @param p_attribute9 Descriptive flexfield segment.
69 * @param p_attribute10 Descriptive flexfield segment.
70 * @param p_attribute11 Descriptive flexfield segment.
71 * @param p_attribute12 Descriptive flexfield segment.
72 * @param p_attribute13 Descriptive flexfield segment.
73 * @param p_attribute14 Descriptive flexfield segment.
74 * @param p_attribute15 Descriptive flexfield segment.
75 * @param p_attribute16 Descriptive flexfield segment.
76 * @param p_attribute17 Descriptive flexfield segment.
77 * @param p_attribute18 Descriptive flexfield segment.
78 * @param p_attribute19 Descriptive flexfield segment.
79 * @param p_attribute20 Descriptive flexfield segment.
80 * @param p_validity_duration The duration certification would be valid once completed.
81 * @param p_validity_duration_units The units for validity duration.
82 * @param p_renewable_flag The flag to determine certification as renewable.
83 * @param p_validity_start_type The flag to determine validity start.
84 * @param p_competency_update_level The flag to detemine competency updation.
85 * @param p_certification_id The unique identifier for the learning certification record.
86 * @param p_object_version_number If p_validate is false, then set to the version number
87 * of the created learning certification. If p_validate is true, then the value will be null.
88 * @rep:displayname Create Learning Certification
89 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
90 * @rep:lifecycle active
91 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
92 * @rep:scope public
93 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 procedure create_certification
99 (p_effective_date in date
100 ,p_validate in boolean default false
101 ,p_name in varchar2
102 ,p_business_group_id in number
103 ,p_public_flag in varchar2 default 'Y'
104 ,p_initial_completion_date in date default null
105 ,p_initial_completion_duration in number default null
106 ,p_initial_compl_duration_units in varchar2 default null
107 ,p_renewal_duration in number default null
108 ,p_renewal_duration_units in varchar2 default null
109 ,p_notify_days_before_expire in number default null
110 ,p_start_date_active in date default null
111 ,p_end_date_active in date default null
112 ,p_description in varchar2 default null
113 ,p_objectives in varchar2 default null
114 ,p_purpose in varchar2 default null
115 ,p_keywords in varchar2 default null
116 ,p_end_date_comments in varchar2 default null
117 ,p_initial_period_comments in varchar2 default null
118 ,p_renewal_period_comments in varchar2 default null
119 ,p_attribute_category in varchar2 default null
120 ,p_attribute1 in varchar2 default null
121 ,p_attribute2 in varchar2 default null
122 ,p_attribute3 in varchar2 default null
123 ,p_attribute4 in varchar2 default null
124 ,p_attribute5 in varchar2 default null
125 ,p_attribute6 in varchar2 default null
126 ,p_attribute7 in varchar2 default null
127 ,p_attribute8 in varchar2 default null
128 ,p_attribute9 in varchar2 default null
129 ,p_attribute10 in varchar2 default null
130 ,p_attribute11 in varchar2 default null
131 ,p_attribute12 in varchar2 default null
132 ,p_attribute13 in varchar2 default null
133 ,p_attribute14 in varchar2 default null
134 ,p_attribute15 in varchar2 default null
135 ,p_attribute16 in varchar2 default null
136 ,p_attribute17 in varchar2 default null
137 ,p_attribute18 in varchar2 default null
138 ,p_attribute19 in varchar2 default null
139 ,p_attribute20 in varchar2 default null
140 ,p_VALIDITY_DURATION in NUMBER default null
141 ,p_VALIDITY_DURATION_UNITS in VARCHAR2 default null
142 ,p_RENEWABLE_FLAG in VARCHAR2 default null
143 ,p_VALIDITY_START_TYPE in VARCHAR2 default null
144 ,p_COMPETENCY_UPDATE_LEVEL in VARCHAR2 default null
145 ,p_certification_id out nocopy number
146 ,p_object_version_number out nocopy number
147 );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |---------------------------< update_certification >-----------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155 * This API updates the certification.
156 *
157 *
158 * <p><b>Licensing</b><br>
159 * This API is licensed for use with Learning Management.
160 *
161 * <p><b>Prerequisites</b><br>
162 * The certification record with the given object version number should exist.
163 *
164 * <p><b>Post Success</b><br>
165 * The certification is updated successfully.
166 *
167 * <p><b>Post Failure</b><br>
168 * The API does not update the certification record, and raises an error.
169 *
170 * @param p_effective_date Reference date for validating lookup values are applicable
171 * during the start to end active date range. This date does not determine when
172 * the changes take effect.
173 * @param p_certification_id The unique identifier for the learning certification record.
174 * @param p_object_version_number Pass in the current version number of the Certification to
175 * be updated. When the API completes if p_validate is false, will be set to the new
176 * version number of the updated Certification. If p_validate is true will be set
177 * to the same value which was passed in.
178 * @param p_name The name of the learning certification.
179 * @param p_public_flag This flag determines that no learner access is defined and grants
180 * access to all learners within a business group.
181 * @param p_initial_completion_date The initial date by which learners must complete the learning certification.
182 * @param p_initial_completion_duration The initial duration provided to learners to complete the learning certification.
183 * @param p_initial_compl_duration_units The duration units for initial completion duration.
184 * @param p_renewal_duration The renewal duration provided to learners to re-certify the learning certification.
185 * @param p_renewal_duration_units The duration units for renewal duration.
186 * @param p_notify_days_before_expire Learners are notified this number of days before
187 * certification initial completion/expiration.
188 * @param p_start_date_active Learning certification active start date.
189 * @param p_end_date_active Learning certification active end date. After this date the object is not active anymore.
190 * @param p_description The description for learning certification.
191 * @param p_objectives The objectives for learning certification.
192 * @param p_purpose The purpose of the learning certification.
193 * @param p_keywords The keywords for learning certification.
194 * @param p_end_date_comments The comments for end date field.
195 * @param p_initial_period_comments The comments for initial completion.
196 * @param p_renewal_period_comments The comments for renewal completion.
197 * @param p_attribute_category This context value determines which flexfield
198 * structure to use with the descriptive flexfield segments.
199 * @param p_attribute1 Descriptive flexfield segment.
200 * @param p_attribute2 Descriptive flexfield segment.
201 * @param p_attribute3 Descriptive flexfield segment.
202 * @param p_attribute4 Descriptive flexfield segment.
203 * @param p_attribute5 Descriptive flexfield segment.
204 * @param p_attribute6 Descriptive flexfield segment.
205 * @param p_attribute7 Descriptive flexfield segment.
206 * @param p_attribute8 Descriptive flexfield segment.
207 * @param p_attribute9 Descriptive flexfield segment.
208 * @param p_attribute10 Descriptive flexfield segment.
209 * @param p_attribute11 Descriptive flexfield segment.
210 * @param p_attribute12 Descriptive flexfield segment.
211 * @param p_attribute13 Descriptive flexfield segment.
212 * @param p_attribute14 Descriptive flexfield segment.
213 * @param p_attribute15 Descriptive flexfield segment.
214 * @param p_attribute16 Descriptive flexfield segment.
215 * @param p_attribute17 Descriptive flexfield segment.
216 * @param p_attribute18 Descriptive flexfield segment.
217 * @param p_attribute19 Descriptive flexfield segment.
218 * @param p_attribute20 Descriptive flexfield segment.
219 * @param p_business_group_id The business group for the certification record.
220 * @param p_validity_duration The duration certification would be valid once completed.
221 * @param p_validity_duration_units The units for validity duration.
222 * @param p_renewable_flag The flag to determine certification as renewable.
223 * @param p_validity_start_type The flag to determine validity start.
224 * @param p_competency_update_level The flag to detemine competency updation.
225 * @param p_validate If true, then validation alone will be performed and the
226 * database will remain unchanged. If false and all validation checks pass,
227 * then the database will be modified.
228 * @rep:displayname Update Learning Certification
229 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
230 * @rep:lifecycle active
231 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
232 * @rep:scope public
233 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
234 */
235 --
236 -- {End Of Comments}
237 --
238 procedure update_certification
239 (p_effective_date in date
240 ,p_certification_id in number
241 ,p_object_version_number in out nocopy number
242 ,p_name in varchar2 default hr_api.g_varchar2
243 ,p_public_flag in varchar2 default hr_api.g_varchar2
244 ,p_initial_completion_date in date default hr_api.g_date
245 ,p_initial_completion_duration in number default hr_api.g_number
246 ,p_initial_compl_duration_units in varchar2 default hr_api.g_varchar2
247 ,p_renewal_duration in number default hr_api.g_number
248 ,p_renewal_duration_units in varchar2 default hr_api.g_varchar2
249 ,p_notify_days_before_expire in number default hr_api.g_number
250 ,p_start_date_active in date default hr_api.g_date
251 ,p_end_date_active in date default hr_api.g_date
252 ,p_description in varchar2 default hr_api.g_varchar2
253 ,p_objectives in varchar2 default hr_api.g_varchar2
254 ,p_purpose in varchar2 default hr_api.g_varchar2
255 ,p_keywords in varchar2 default hr_api.g_varchar2
256 ,p_end_date_comments in varchar2 default hr_api.g_varchar2
257 ,p_initial_period_comments in varchar2 default hr_api.g_varchar2
258 ,p_renewal_period_comments in varchar2 default hr_api.g_varchar2
259 ,p_attribute_category in varchar2 default hr_api.g_varchar2
260 ,p_attribute1 in varchar2 default hr_api.g_varchar2
261 ,p_attribute2 in varchar2 default hr_api.g_varchar2
262 ,p_attribute3 in varchar2 default hr_api.g_varchar2
263 ,p_attribute4 in varchar2 default hr_api.g_varchar2
264 ,p_attribute5 in varchar2 default hr_api.g_varchar2
265 ,p_attribute6 in varchar2 default hr_api.g_varchar2
266 ,p_attribute7 in varchar2 default hr_api.g_varchar2
267 ,p_attribute8 in varchar2 default hr_api.g_varchar2
268 ,p_attribute9 in varchar2 default hr_api.g_varchar2
269 ,p_attribute10 in varchar2 default hr_api.g_varchar2
270 ,p_attribute11 in varchar2 default hr_api.g_varchar2
271 ,p_attribute12 in varchar2 default hr_api.g_varchar2
272 ,p_attribute13 in varchar2 default hr_api.g_varchar2
273 ,p_attribute14 in varchar2 default hr_api.g_varchar2
274 ,p_attribute15 in varchar2 default hr_api.g_varchar2
275 ,p_attribute16 in varchar2 default hr_api.g_varchar2
276 ,p_attribute17 in varchar2 default hr_api.g_varchar2
277 ,p_attribute18 in varchar2 default hr_api.g_varchar2
278 ,p_attribute19 in varchar2 default hr_api.g_varchar2
279 ,p_attribute20 in varchar2 default hr_api.g_varchar2
280 ,p_business_group_id in number default hr_api.g_number
281 ,p_VALIDITY_DURATION in NUMBER default hr_api.g_number
282 ,p_VALIDITY_DURATION_UNITS in VARCHAR2 default hr_api.g_varchar2
283 ,p_RENEWABLE_FLAG in VARCHAR2 default hr_api.g_varchar2
284 ,p_VALIDITY_START_TYPE in VARCHAR2 default hr_api.g_varchar2
288 --
285 ,p_COMPETENCY_UPDATE_LEVEL in VARCHAR2 default hr_api.g_varchar2
286 ,p_validate in boolean default false
287 );
289 -- ----------------------------------------------------------------------------
290 -- |---------------------------< delete_certification >-----------------------|
291 -- ----------------------------------------------------------------------------
292 --
293 -- {Start Of Comments}
294 /*#
295 * This API deletes the certification.
296 *
297 *
298 * <p><b>Licensing</b><br>
299 * This API is licensed for use with Learning Management.
300 *
301 * <p><b>Prerequisites</b><br>
302 * The certification record with the given object version number should exist.
303 *
304 * <p><b>Post Success</b><br>
305 * The certification enrollment is deleted successfully.
306 *
307 * <p><b>Post Failure</b><br>
308 * The API does not delete the certification record, and raises an error.
309 *
310 * @param p_certification_id The unique identifier for the certification record.
311 * @param p_object_version_number Current version number of the certification to be deleted.
312 * @param p_validate If true, then validation alone will be performed and the
313 * database will remain unchanged. If false and all validation checks pass,
314 * then the database will be modified.
315 * @rep:displayname Delete Certification
316 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
317 * @rep:lifecycle active
318 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
319 * @rep:scope public
320 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
321 */
322 --
323 -- {End Of Comments}
324 --
325
326 procedure delete_certification
327 (p_certification_id in number
328 ,p_object_version_number in number
329 ,p_validate in boolean default false
330 );
331 end ota_certification_api;
[Home] [Help]