4 * This package contains Certification Member Enrollment APIs.
1 Package ota_cert_mbr_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otcmeapi.pkh 120.4.12020000.4 2012/12/03 13:10:15 jaysridh ship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Certification Member Enrollment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_cert_mbr_enrollment >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the Certification Member 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 Member Enrollment is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a Certification Member 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_prd_enrollment_id The unique identifier for the parent certification
38 * period enrollment record.
39 * @param p_cert_member_id The unique identifier for the certification member record.
40 * @param p_member_status_code Status for the Certification Member Enrollment.
41 * Valid values are defined by 'OTA_CERT_MBR_ENROLL_STATUS' lookup type.
42 * @param p_completion_date The date the certification is completed.
43 * @param p_business_group_id The business group owning the Certification Member
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_cert_mbr_enrollment_id The unique identifier for the Certification Member Enrollment record.
68 * @param p_object_version_number If p_validate is false, then set to the version number of the created
69 * Certification Member Enrollment. If p_validate is true, then the value will be null.
70 * @param p_is_recert If 'Y' then the certification member enrollment record is created for a cancelled/
71 * rejected subscription. If 'N' then the record is created for renewal purpose.
72 * @rep:displayname Create Certification Member Enrollment
73 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
74 * @rep:lifecycle active
75 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
76 * @rep:scope public
77 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
78 */
79 --
80 -- {End Of Comments}
81 --
82 procedure create_cert_mbr_enrollment
83 (
84 p_effective_date in date,
85 p_validate in boolean default false ,
86 p_cert_prd_enrollment_id in number,
87 p_cert_member_id in number,
88 p_member_status_code in varchar2,
89 p_completion_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,
104 p_attribute13 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,
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_cert_mbr_enrollment_id out nocopy number,
113 p_object_version_number out nocopy number,
114 p_is_recert in varchar2 default 'N' --Bug 15938221
115 );
116 --
117 -- ----------------------------------------------------------------------------
118 -- |------------------------< update_cert_mbr_enrollment >--------------------|
119 -- ----------------------------------------------------------------------------
120 --
121 -- {Start Of Comments}
122 /*#
123 * This API updates the Certification Member 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>
133 * The Certification Member Enrollment is updated successfully.
130 * The Certification Member Enrollment record with the given object version number should exist.
131 *
132 * <p><b>Post Success</b><br>
134 *
135 * <p><b>Post Failure</b><br>
136 * The API does not update the Certification Member Enrollment record, and raises an error.
137 *
138 * @param p_effective_date Reference date for validating that lookup values are
139 * applicable during the start to end active date range. This date does not
140 * determine when the changes take effect.
141 * @param p_cert_mbr_enrollment_id The unique identifier for the Certification Member Enrollment record.
142 * @param p_object_version_number Pass in the current version number of the Certification
143 * Member Enrollment to be updated. When the API completes if p_validate is false,
144 * will be set to the new version number of the updated Certification Member Enrollment.
145 * If p_validate is true will be set to the same value which was passed in.
146 * @param p_cert_prd_enrollment_id The unique identifier for the parent certification period enrollment record.
147 * @param p_cert_member_id The unique identifier for the certification member record.
148 * @param p_member_status_code Status for the Certification Member Enrollment.
149 * Valid values are defined by 'OTA_CERT_PRD_ENROLL_STATUS' lookup type.
150 * @param p_completion_date The date the certification is completed.
151 * @param p_business_group_id The business group owning the Certification Member
152 * Enrollment record 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_validate If true, then validation alone will be performed and the
176 * database will remain unchanged. If false and all validation checks pass,
177 * then the database will be modified.
178 * @rep:displayname Update Certification Member Enrollment
179 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
180 * @rep:lifecycle active
181 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
182 * @rep:scope public
183 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
184 */
185 --
186 -- {End Of Comments}
187 --
188 procedure update_cert_mbr_enrollment
192 p_object_version_number in out nocopy number,
189 (
190 p_effective_date in date,
191 p_cert_mbr_enrollment_id in number,
193 p_cert_prd_enrollment_id in number,
194 p_cert_member_id in number,
195 p_member_status_code in varchar2,
196 p_completion_date in date default hr_api.g_date,
197 p_business_group_id in number default hr_api.g_number,
198 p_attribute_category in varchar2 default hr_api.g_varchar2,
199 p_attribute1 in varchar2 default hr_api.g_varchar2,
200 p_attribute2 in varchar2 default hr_api.g_varchar2,
201 p_attribute3 in varchar2 default hr_api.g_varchar2,
202 p_attribute4 in varchar2 default hr_api.g_varchar2,
203 p_attribute5 in varchar2 default hr_api.g_varchar2,
204 p_attribute6 in varchar2 default hr_api.g_varchar2,
205 p_attribute7 in varchar2 default hr_api.g_varchar2,
206 p_attribute8 in varchar2 default hr_api.g_varchar2,
207 p_attribute9 in varchar2 default hr_api.g_varchar2,
208 p_attribute10 in varchar2 default hr_api.g_varchar2,
209 p_attribute11 in varchar2 default hr_api.g_varchar2,
210 p_attribute12 in varchar2 default hr_api.g_varchar2,
211 p_attribute13 in varchar2 default hr_api.g_varchar2,
212 p_attribute14 in varchar2 default hr_api.g_varchar2,
213 p_attribute15 in varchar2 default hr_api.g_varchar2,
214 p_attribute16 in varchar2 default hr_api.g_varchar2,
215 p_attribute17 in varchar2 default hr_api.g_varchar2,
216 p_attribute18 in varchar2 default hr_api.g_varchar2,
217 p_attribute19 in varchar2 default hr_api.g_varchar2,
218 p_attribute20 in varchar2 default hr_api.g_varchar2,
219 p_validate in boolean default false
220 );
221 --
222 -- ----------------------------------------------------------------------------
223 -- |------------------------< delete_cert_mbr_enrollment >--------------------|
224 -- ----------------------------------------------------------------------------
225 --
226 -- {Start Of Comments}
227 /*#
228 * This API deletes the Certification Member Enrollment.
229 *
230 *
231 * <p><b>Licensing</b><br>
232 * This API is licensed for use with Learning Management.
233 *
234 * <p><b>Prerequisites</b><br>
235 * The Certification Member Enrollment record with the given object version number should exist.
236 *
237 * <p><b>Post Success</b><br>
238 * The Certification Member Enrollment is deleted successfully.
239 *
240 * <p><b>Post Failure</b><br>
241 * The API does not delete the Certification Member Enrollment record, and raises an error.
242 *
243 * @param p_cert_mbr_enrollment_id The unique identifier for the Certification Member
244 * Enrollment record.
245 * @param p_object_version_number Current version number of the Certification Member
246 * Enrollment to be deleted.
247 * @param p_validate If true, then validation alone will be performed and the
251 * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
248 * database will remain unchanged. If false and all validation checks pass,
249 * then the database will be modified.
250 * @rep:displayname Delete Certification Member Enrollment
252 * @rep:lifecycle active
253 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
254 * @rep:scope public
255 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
256 */
257 --
258 -- {End Of Comments}
259 --
260
261 procedure delete_cert_mbr_enrollment
262 (p_cert_mbr_enrollment_id in number
263 ,p_object_version_number in number
264 ,p_validate in boolean default false
265 );
266 end ota_cert_mbr_enrollment_api;