1 Package ota_tdb_api_ins2 AUTHID CURRENT_USER as
2 /* $Header: ottdb02t.pkh 120.9.12010000.2 2009/08/12 14:12:22 smahanka ship $ */
3 /*#
4 * This package creates a learner enrollment in a class.
5 * @rep:scope private
6 * @rep:product ota
7 * @rep:displayname Enrollment
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_enrollment >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a learner enrollment in a class.
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 * User should have learner access for the class for which enrollment is to be
24 * created.
25 *
26 * <p><b>Post Success</b><br>
27 * An enrollment record created in the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * An enrollment record is not created and an error is raised.
31 * @param p_booking_id If p_validate is false, then this ID uniquely identifies
32 * the enrollment created. If p_validate is true, then it is set to null.
33 * @param p_booking_status_type_id {@rep:casecolumn
34 * OTA_BOOKING_STATUS_TYPES.BOOKING_STATUS_TYPE_ID}.
35 * @param p_delegate_person_id Identifies the person for whom the enrollment
36 * record will be created.
37 * @param p_contact_id Identifies the contact of the customer for which the
38 * enrollment record is created.
39 * @param p_business_group_id {@rep:casecolumn OTA_EVENTS.BUSINESS_GROUP_ID}.
40 * @param p_event_id Identifies the class in which the person or contact is
41 * enrolling.
42 * @param p_customer_id Identifies the customer for which the enrollment record
43 * is being created.
44 * @param p_authorizer_person_id {@rep:casecolumn
45 * OTA_DELEGATE_BOOKINGS.AUTHORIZER_PERSON_ID}.
46 * @param p_date_booking_placed Identifies the date on which the enrollment is
47 * being created.
48 * @param p_corespondent {@rep:casecolumn OTA_DELEGATE_BOOKINGS.CORESPONDENT}.
49 * @param p_internal_booking_flag This flag should have value Y for internal
50 * enrollments and N for external enrollments.
51 * @param p_number_of_places Identifies the number of places needed in the
52 * class.
53 * @param p_object_version_number If p_validate is false, then set to the
54 * version number of the created enrollment. If p_validate is true, then the
55 * value will be null.
56 * @param p_administrator {@rep:casecolumn OTA_DELEGATE_BOOKINGS.ADMINISTRATOR}.
57 * @param p_booking_priority Enrollment Priority. Valid values are defined by
58 * the 'PRIORITY_LEVEL' lookup type.
59 * @param p_comments Comment text.
60 * @param p_contact_address_id {@rep:casecolumn
61 * OTA_DELEGATE_BOOKINGS.CONTACT_ADDRESS_ID}.
62 * @param p_delegate_contact_phone {@rep:casecolumn
63 * OTA_DELEGATE_BOOKINGS.DELEGATE_CONTACT_PHONE}.
64 * @param p_delegate_contact_fax {@rep:casecolumn
65 * OTA_DELEGATE_BOOKINGS.DELEGATE_CONTACT_FAX}.
66 * @param p_third_party_customer_id {@rep:casecolumn
67 * OTA_DELEGATE_BOOKINGS.THIRD_PARTY_CUSTOMER_ID}.
68 * @param p_third_party_contact_id {@rep:casecolumn
69 * OTA_DELEGATE_BOOKINGS.THIRD_PARTY_CONTACT_ID}.
70 * @param p_third_party_address_id {@rep:casecolumn
71 * OTA_DELEGATE_BOOKINGS.THIRD_PARTY_ADDRESS_ID}.
72 * @param p_third_party_contact_phone {@rep:casecolumn
73 * OTA_DELEGATE_BOOKINGS.THIRD_PARTY_CONTACT_PHONE}.
74 * @param p_third_party_contact_fax {@rep:casecolumn
75 * OTA_DELEGATE_BOOKINGS.THIRD_PARTY_CONTACT_FAX}.
76 * @param p_date_status_changed {@rep:casecolumn
77 * OTA_DELEGATE_BOOKINGS.DATE_STATUS_CHANGED}.
78 * @param p_failure_reason Identifies the failure reason. Valid values are
79 * defined by the 'DELEGATE_FAILURE_REASON' lookup type.
80 * @param p_attendance_result {@rep:casecolumn
81 * OTA_DELEGATE_BOOKINGS.ATTENDANCE_RESULT}.
82 * @param p_language_id {@rep:casecolumn OTA_DELEGATE_BOOKINGS.LANGUAGE_ID}.
83 * @param p_source_of_booking Identifies the source of the enrollment. Valid
84 * values are defined by the 'BOOKING_SOURCE' lookup type.
85 * @param p_special_booking_instructions {@rep:casecolumn
86 * OTA_DELEGATE_BOOKINGS.SPECIAL_BOOKING_INSTRUCTIONS}.
87 * @param p_successful_attendance_flag {@rep:casecolumn
88 * OTA_DELEGATE_BOOKINGS.SUCCESSFUL_ATTENDANCE_FLAG}.
89 * @param p_tdb_information_category This context value determines which
90 * Flexfield Structure to use with the Descriptive flexfield segment
91 * @param p_tdb_information1 Descriptive flexfield segment.
92 * @param p_tdb_information2 Descriptive flexfield segment.
93 * @param p_tdb_information3 Descriptive flexfield segment.
94 * @param p_tdb_information4 Descriptive flexfield segment.
95 * @param p_tdb_information5 Descriptive flexfield segment.
96 * @param p_tdb_information6 Descriptive flexfield segment.
97 * @param p_tdb_information7 Descriptive flexfield segment.
98 * @param p_tdb_information8 Descriptive flexfield segment.
99 * @param p_tdb_information9 Descriptive flexfield segment.
100 * @param p_tdb_information10 Descriptive flexfield segment.
101 * @param p_tdb_information11 Descriptive flexfield segment.
102 * @param p_tdb_information12 Descriptive flexfield segment.
103 * @param p_tdb_information13 Descriptive flexfield segment.
104 * @param p_tdb_information14 Descriptive flexfield segment.
105 * @param p_tdb_information15 Descriptive flexfield segment.
106 * @param p_tdb_information16 Descriptive flexfield segment.
107 * @param p_tdb_information17 Descriptive flexfield segment.
108 * @param p_tdb_information18 Descriptive flexfield segment.
109 * @param p_tdb_information19 Descriptive flexfield segment.
110 * @param p_tdb_information20 Descriptive flexfield segment.
111 * @param p_create_finance_line Identifies whether a finance line needs to be
112 * created.
113 * @param p_finance_header_id Identifies the finance header.
114 * @param p_currency_code {@rep:casecolumn OTA_FINANCE_LINES.CURRENCY_CODE}.
115 * @param p_standard_amount {@rep:casecolumn OTA_FINANCE_LINES.STANDARD_AMOUNT}.
116 * @param p_unitary_amount {@rep:casecolumn OTA_FINANCE_LINES.UNITARY_AMOUNT}.
117 * @param p_money_amount {@rep:casecolumn OTA_FINANCE_LINES.MONEY_AMOUNT}.
118 * @param p_booking_deal_id {@rep:casecolumn OTA_FINANCE_LINES.BOOKING_DEAL_ID}.
119 * @param p_booking_deal_type Identifies the type of booking deal.
120 * @param p_finance_line_id Identifies the finance line.
121 * @param p_enrollment_type Enrollment type is S for student, null for others.
122 * @param p_validate If true, then validation alone will be performed and the
123 * database will remain unchanged. If false and all validation checks pass,
124 * then the database will be modified.
125 * @param p_organization_id {@rep:casecolumn
126 * OTA_DELEGATE_BOOKINGS.ORGANIZATION_ID}.
127 * @param p_sponsor_person_id {@rep:casecolumn
128 * OTA_DELEGATE_BOOKINGS.SPONSOR_PERSON_ID}.
129 * @param p_sponsor_assignment_id {@rep:casecolumn
130 * OTA_DELEGATE_BOOKINGS.SPONSOR_ASSIGNMENT_ID}.
131 * @param p_person_address_id {@rep:casecolumn
132 * OTA_DELEGATE_BOOKINGS.PERSON_ADDRESS_ID}.
133 * @param p_delegate_assignment_id {@rep:casecolumn
134 * OTA_DELEGATE_BOOKINGS.DELEGATE_ASSIGNMENT_ID}.
135 * @param p_delegate_contact_id Identifies the contact of the customer for whom
136 * the enrollment record is being created.
137 * @param p_delegate_contact_email {@rep:casecolumn
138 * OTA_DELEGATE_BOOKINGS.DELEGATE_CONTACT_EMAIL}.
139 * @param p_third_party_email {@rep:casecolumn
140 * OTA_DELEGATE_BOOKINGS.THIRD_PARTY_EMAIL}.
141 * @param p_person_address_type {@rep:casecolumn
142 * OTA_DELEGATE_BOOKINGS.PERSON_ADDRESS_TYPE}.
143 * @param p_line_id {@rep:casecolumn OTA_DELEGATE_BOOKINGS.LINE_ID}.
144 * @param p_org_id {@rep:casecolumn OTA_DELEGATE_BOOKINGS.ORG_ID}.
145 * @param p_daemon_flag {@rep:casecolumn OTA_DELEGATE_BOOKINGS.DAEMON_FLAG}.
146 * @param p_daemon_type {@rep:casecolumn OTA_DELEGATE_BOOKINGS.DAEMON_TYPE}.
147 * @param p_old_event_id {@rep:casecolumn OTA_DELEGATE_BOOKINGS.OLD_EVENT_ID}.
148 * @param p_quote_line_id {@rep:casecolumn OTA_DELEGATE_BOOKINGS.QUOTE_LINE_ID}.
149 * @param p_interface_source {@rep:casecolumn
150 * OTA_DELEGATE_BOOKINGS.INTERFACE_SOURCE}.
151 * @param p_total_training_time {@rep:casecolumn
152 * OTA_DELEGATE_BOOKINGS.TOTAL_TRAINING_TIME}.
153 * @param p_content_player_status Player status of Courses imported from
154 * iLearning.
155 * @param p_score Test Score of Courses imported from iLearning.
156 * @param p_completed_content {@rep:casecolumn
157 * OTA_DELEGATE_BOOKINGS.COMPLETED_CONTENT}.
158 * @param p_total_content {@rep:casecolumn OTA_DELEGATE_BOOKINGS.TOTAL_CONTENT}.
159 * @param p_booking_justification_id Identifies the enrollment justification
160 * for the enrollment record.
161 * @param p_override_prerequisites Determines whether the course and
162 * competency prerequisites check is to be overridden. Valid values are Y and
163 * N. Default value is N.
164 * @param p_book_from Specifies whether the enrollment originates from the
165 * learner or admin. Valid value is 'AME' when coming from the learner;
166 * otherwise it is null.
167 * @param p_override_learner_access Determines whether the learner access
168 * check is to be overridden. Valid values are Y and N. Default value is N.
169 * @param p_is_history_flag Determines whether the enrollment record should
170 * be moved to history. Valid values are Y and N. Default value is N.
171 * @rep:displayname Create Enrollment
172 * @rep:category BUSINESS_ENTITY OTA_LEARNER_ENROLLMENT
173 * @rep:scope private
174 * @rep:lifecycle active
175 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
176 */
177 --
178 -- {End Of Comments}
179 --
180 procedure Create_Enrollment
181 (
182 p_booking_id in out nocopy number,
183 p_booking_status_type_id in number,
184 p_delegate_person_id in number default null,
185 p_contact_id in number,
186 p_business_group_id in number,
187 p_event_id in number,
188 p_customer_id in number default null,
189 p_authorizer_person_id in number default null,
190 p_date_booking_placed in date,
191 p_corespondent in varchar2 default null,
192 p_internal_booking_flag in varchar2,
193 p_number_of_places in number,
194 p_object_version_number in out nocopy number,
195 p_administrator in number default null,
196 p_booking_priority in varchar2 default null,
197 p_comments in varchar2 default null,
198 p_contact_address_id in number default null,
199 p_delegate_contact_phone in varchar2 default null,
200 p_delegate_contact_fax in varchar2 default null,
201 p_third_party_customer_id in number default null,
202 p_third_party_contact_id in number default null,
203 p_third_party_address_id in number default null,
204 p_third_party_contact_phone in varchar2 default null,
205 p_third_party_contact_fax in varchar2 default null,
206 p_date_status_changed in date default null,
207 p_failure_reason in varchar2 default null,
208 p_attendance_result in varchar2 default null,
209 p_language_id in number default null,
210 p_source_of_booking in varchar2 default null,
211 p_special_booking_instructions in varchar2 default null,
212 p_successful_attendance_flag in varchar2 default null,
213 p_tdb_information_category in varchar2 default null,
214 p_tdb_information1 in varchar2 default null,
215 p_tdb_information2 in varchar2 default null,
216 p_tdb_information3 in varchar2 default null,
217 p_tdb_information4 in varchar2 default null,
218 p_tdb_information5 in varchar2 default null,
219 p_tdb_information6 in varchar2 default null,
220 p_tdb_information7 in varchar2 default null,
221 p_tdb_information8 in varchar2 default null,
222 p_tdb_information9 in varchar2 default null,
223 p_tdb_information10 in varchar2 default null,
224 p_tdb_information11 in varchar2 default null,
225 p_tdb_information12 in varchar2 default null,
226 p_tdb_information13 in varchar2 default null,
227 p_tdb_information14 in varchar2 default null,
228 p_tdb_information15 in varchar2 default null,
229 p_tdb_information16 in varchar2 default null,
230 p_tdb_information17 in varchar2 default null,
231 p_tdb_information18 in varchar2 default null,
232 p_tdb_information19 in varchar2 default null,
233 p_tdb_information20 in varchar2 default null,
234 p_create_finance_line in varchar2 default null,
235 p_finance_header_id in number default null,
236 p_currency_code in varchar2 default null,
237 p_standard_amount in number default null,
238 p_unitary_amount in number default null,
239 p_money_amount in number default null,
240 p_booking_deal_id in number default null,
241 p_booking_deal_type in varchar2 default null,
242 p_finance_line_id in out nocopy number,
243 p_enrollment_type in varchar2,
244 p_validate in boolean default false,
245 p_organization_id in number default null,
246 p_sponsor_person_id in number default null,
247 p_sponsor_assignment_id in number default null,
248 p_person_address_id in number default null,
249 p_delegate_assignment_id in number default null,
250 p_delegate_contact_id in number default null,
251 p_delegate_contact_email in varchar2 default null,
252 p_third_party_email in varchar2 default null,
253 p_person_address_type in varchar2 default null,
254 p_line_id in number default null,
255 p_org_id in number default null,
256 p_daemon_flag in varchar2 default null,
257 p_daemon_type in varchar2 default null,
258 p_old_event_id in number default null,
259 p_quote_line_id in number default null,
260 p_interface_source in varchar2 default null,
261 p_total_training_time in varchar2 default null,
262 p_content_player_status in varchar2 default null,
263 p_score in number default null,
264 p_completed_content in number default null,
265 p_total_content in number default null,
266 p_booking_justification_id in number default null,
267 p_override_prerequisites in varchar2 default 'N',
268 p_book_from in varchar2 default null,
269 p_override_learner_access in varchar2 default 'N',
270 p_is_history_flag in varchar2 default 'N',
271 p_is_mandatory_enrollment in varchar2 default 'N'
272
273 );
274 end ota_tdb_api_ins2;
[Home] [Help]