DBA Data[Home] [Help]

PACKAGE: APPS.OTA_CERT_MBR_ENROLLMENT_API

Source


1 Package ota_cert_mbr_enrollment_api AUTHID CURRENT_USER as
2 /* $Header: otcmeapi.pkh 120.4 2006/07/13 11:44:44 niarora noship $ */
3 /*#
4  * This package contains Certification Member Enrollment APIs.
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  * @rep:displayname Create Certification Member Enrollment
71  * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
72  * @rep:lifecycle active
73  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
74  * @rep:scope public
75  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
76 */
77 --
78 -- {End Of Comments}
79 --
80 procedure create_cert_mbr_enrollment
81   (
82   p_effective_date               in date,
83   p_validate                     in boolean          default false ,
84   p_cert_prd_enrollment_id       in number,
85   p_cert_member_id               in number,
86   p_member_status_code           in varchar2,
87   p_completion_date              in date             default null,
88   p_business_group_id            in number,
89   p_attribute_category           in varchar2         default null,
90   p_attribute1                   in varchar2         default null,
91   p_attribute2                   in varchar2         default null,
92   p_attribute3                   in varchar2         default null,
93   p_attribute4                   in varchar2         default null,
94   p_attribute5                   in varchar2         default null,
95   p_attribute6                   in varchar2         default null,
96   p_attribute7                   in varchar2         default null,
97   p_attribute8                   in varchar2         default null,
98   p_attribute9                   in varchar2         default null,
99   p_attribute10                  in varchar2         default null,
100   p_attribute11                  in varchar2         default null,
101   p_attribute12                  in varchar2         default null,
102   p_attribute13                  in varchar2         default null,
103   p_attribute14                  in varchar2         default null,
104   p_attribute15                  in varchar2         default null,
105   p_attribute16                  in varchar2         default null,
106   p_attribute17                  in varchar2         default null,
107   p_attribute18                  in varchar2         default null,
108   p_attribute19                  in varchar2         default null,
109   p_attribute20                  in varchar2         default null,
110   p_cert_mbr_enrollment_id       out nocopy number,
111   p_object_version_number        out nocopy number
112   );
113 --
114 -- ----------------------------------------------------------------------------
115 -- |------------------------< update_cert_mbr_enrollment >--------------------|
116 -- ----------------------------------------------------------------------------
117 --
118 -- {Start Of Comments}
119 /*#
120  * This API updates the Certification Member Enrollment.
121  *
122  *
123  * <p><b>Licensing</b><br>
124  * This API is licensed for use with Learning Management.
125  *
126  * <p><b>Prerequisites</b><br>
127  * The Certification Member Enrollment record with the given object version number should exist.
128  *
129  * <p><b>Post Success</b><br>
130  * The Certification Member Enrollment is updated successfully.
131  *
132  * <p><b>Post Failure</b><br>
133  * The API does not update the Certification Member Enrollment record, and raises an error.
134  *
138  * @param p_cert_mbr_enrollment_id The unique identifier for the Certification Member Enrollment record.
135  * @param p_effective_date Reference date for validating that lookup values are
136  * applicable during the start to end active date range. This date does not
137  * determine when the changes take effect.
139  * @param p_object_version_number Pass in the current version number of the Certification
140  * Member Enrollment to be updated. When the API completes if p_validate is false,
141  * will be set to the new version number of the updated Certification Member Enrollment.
142  * If p_validate is true will be set to the same value which was passed in.
143  * @param p_cert_prd_enrollment_id The unique identifier for the parent certification period enrollment record.
144  * @param p_cert_member_id The unique identifier for the certification member record.
145  * @param p_member_status_code Status for the Certification Member Enrollment.
146  * Valid values are defined by 'OTA_CERT_PRD_ENROLL_STATUS'  lookup type.
150  * @param p_attribute_category This context value determines which flexfield
147  * @param p_completion_date The date the certification is completed.
148  * @param p_business_group_id The business group owning the Certification Member
149  * Enrollment record of the certification.
151  * structure to use with the descriptive flexfield segments.
152  * @param p_attribute1 Descriptive flexfield segment.
153  * @param p_attribute2 Descriptive flexfield segment.
154  * @param p_attribute3 Descriptive flexfield segment.
155  * @param p_attribute4 Descriptive flexfield segment.
156  * @param p_attribute5 Descriptive flexfield segment.
157  * @param p_attribute6 Descriptive flexfield segment.
158  * @param p_attribute7 Descriptive flexfield segment.
159  * @param p_attribute8 Descriptive flexfield segment.
160  * @param p_attribute9 Descriptive flexfield segment.
161  * @param p_attribute10 Descriptive flexfield segment.
162  * @param p_attribute11 Descriptive flexfield segment.
163  * @param p_attribute12 Descriptive flexfield segment.
164  * @param p_attribute13 Descriptive flexfield segment.
165  * @param p_attribute14 Descriptive flexfield segment.
166  * @param p_attribute15 Descriptive flexfield segment.
167  * @param p_attribute16 Descriptive flexfield segment.
168  * @param p_attribute17 Descriptive flexfield segment.
169  * @param p_attribute18 Descriptive flexfield segment.
170  * @param p_attribute19 Descriptive flexfield segment.
171  * @param p_attribute20 Descriptive flexfield segment.
172  * @param p_validate If true, then validation alone will be performed and the
173  * database will remain unchanged. If false and all validation checks pass,
174  * then the database will be modified.
175  * @rep:displayname Update Certification Member Enrollment
176  * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
177  * @rep:lifecycle active
178  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
179  * @rep:scope public
180  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
181 */
182 --
183 -- {End Of Comments}
184 --
185 procedure update_cert_mbr_enrollment
186   (
187   p_effective_date               in date,
188   p_cert_mbr_enrollment_id       in number,
189   p_object_version_number        in out nocopy number,
190   p_cert_prd_enrollment_id       in number,
191   p_cert_member_id               in number,
192   p_member_status_code           in varchar2,
193   p_completion_date              in date             default hr_api.g_date,
194   p_business_group_id            in number           default hr_api.g_number,
195   p_attribute_category           in varchar2         default hr_api.g_varchar2,
196   p_attribute1                   in varchar2         default hr_api.g_varchar2,
197   p_attribute2                   in varchar2         default hr_api.g_varchar2,
198   p_attribute3                   in varchar2         default hr_api.g_varchar2,
199   p_attribute4                   in varchar2         default hr_api.g_varchar2,
200   p_attribute5                   in varchar2         default hr_api.g_varchar2,
201   p_attribute6                   in varchar2         default hr_api.g_varchar2,
202   p_attribute7                   in varchar2         default hr_api.g_varchar2,
203   p_attribute8                   in varchar2         default hr_api.g_varchar2,
204   p_attribute9                   in varchar2         default hr_api.g_varchar2,
205   p_attribute10                  in varchar2         default hr_api.g_varchar2,
206   p_attribute11                  in varchar2         default hr_api.g_varchar2,
207   p_attribute12                  in varchar2         default hr_api.g_varchar2,
208   p_attribute13                  in varchar2         default hr_api.g_varchar2,
209   p_attribute14                  in varchar2         default hr_api.g_varchar2,
210   p_attribute15                  in varchar2         default hr_api.g_varchar2,
211   p_attribute16                  in varchar2         default hr_api.g_varchar2,
212   p_attribute17                  in varchar2         default hr_api.g_varchar2,
213   p_attribute18                  in varchar2         default hr_api.g_varchar2,
214   p_attribute19                  in varchar2         default hr_api.g_varchar2,
215   p_attribute20                  in varchar2         default hr_api.g_varchar2,
216   p_validate                     in boolean          default false
217   );
218 --
219 -- ----------------------------------------------------------------------------
220 -- |------------------------< delete_cert_mbr_enrollment >--------------------|
221 -- ----------------------------------------------------------------------------
222 --
223 -- {Start Of Comments}
224 /*#
225  * This API deletes the Certification Member Enrollment.
226  *
227  *
228  * <p><b>Licensing</b><br>
229  * This API is licensed for use with Learning Management.
230  *
231  * <p><b>Prerequisites</b><br>
232  * The Certification Member Enrollment record with the given object version number should exist.
233  *
234  * <p><b>Post Success</b><br>
235  * The Certification Member Enrollment is deleted successfully.
236  *
237  * <p><b>Post Failure</b><br>
238  * The API does not delete the Certification Member Enrollment record, and raises an error.
239  *
240  * @param p_cert_mbr_enrollment_id The unique identifier for the Certification Member
241  * Enrollment record.
242  * @param p_object_version_number Current version number of the Certification Member
243  * Enrollment to be deleted.
244  * @param p_validate If true, then validation alone will be performed and the
245  * database will remain unchanged. If false and all validation checks pass,
246  * then the database will be modified.
247  * @rep:displayname Delete Certification Member Enrollment
248  * @rep:category BUSINESS_ENTITY OTA_CERTIFICATION
249  * @rep:lifecycle active
250  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
251  * @rep:scope public
252  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
253 */
254 --
255 -- {End Of Comments}
256 --
257 
261   ,p_validate                      in     boolean  default false
258 procedure delete_cert_mbr_enrollment
259   (p_cert_mbr_enrollment_id        in     number
260   ,p_object_version_number         in     number
262   );
263 end ota_cert_mbr_enrollment_api;