1 Package ota_resource_booking_api AUTHID CURRENT_USER as
2 /* $Header: ottrbapi.pkh 120.4 2006/03/06 02:29:49 rdola noship $ */
3 /*#
4 * This package contains the Resource Booking APIs.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Resource Booking
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_resource_booking >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API books a resource for 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 * The Class and the Resource must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The resource booking is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The resource booking will not be created and an error will be raised.
30 * @param p_effective_date Reference date for validating lookup values are
31 * applicable during the start to end active date range. This date does not
32 * determine when the changes take effect.
33 * @param p_supplied_resource_id The unique identifier of the resource that is
34 * being booked.
35 * @param p_date_booking_placed {@rep:casecolumn
36 * OTA_RESOURCE_BOOKINGS.DATE_BOOKING_PLACED}
37 * @param p_status Resource Booking status. Valid values are defined by the
38 * 'RESOURCE_BOOKING_STATUS' lookup type.
39 * @param p_event_id The unique identifier of the class for which the resource
40 * is being booked.
41 * @param p_absolute_price {@rep:casecolumn
42 * OTA_RESOURCE_BOOKINGS.ABSOLUTE_PRICE}
43 * @param p_booking_person_id The unique identifier of the person who is
44 * booking the resource.
45 * @param p_comments {@rep:casecolumn OTA_RESOURCE_BOOKINGS.COMMENTS}
46 * @param p_contact_name {@rep:casecolumn OTA_RESOURCE_BOOKINGS.CONTACT_NAME}
47 * @param p_contact_phone_number {@rep:casecolumn
48 * OTA_RESOURCE_BOOKINGS.CONTACT_PHONE_NUMBER}
49 * @param p_delegates_per_unit {@rep:casecolumn
50 * OTA_RESOURCE_BOOKINGS.DELEGATES_PER_UNIT}
51 * @param p_quantity {@rep:casecolumn OTA_RESOURCE_BOOKINGS.QUANTITY}
52 * @param p_required_date_from {@rep:casecolumn
53 * OTA_RESOURCE_BOOKINGS.REQUIRED_DATE_FROM}
54 * @param p_required_date_to {@rep:casecolumn
55 * OTA_RESOURCE_BOOKINGS.REQUIRED_DATE_TO}
56 * @param p_required_end_time {@rep:casecolumn
57 * OTA_RESOURCE_BOOKINGS.REQUIRED_END_TIME}
58 * @param p_required_start_time {@rep:casecolumn
59 * OTA_RESOURCE_BOOKINGS.REQUIRED_START_TIME}
60 * @param p_deliver_to {@rep:casecolumn OTA_RESOURCE_BOOKINGS.DELIVER_TO}
61 * @param p_primary_venue_flag {@rep:casecolumn
62 * OTA_RESOURCE_BOOKINGS.PRIMARY_VENUE_FLAG}
63 * @param p_role_to_play Resource Booking status. Valid values are defined by
64 * the 'TRAINER_PARTICIPATION' lookup type.
65 * @param p_trb_information_category This context value determines which
66 * Flexfield Structure to use with the Resource Booking Descriptive flexfield
67 * segments.
68 * @param p_trb_information1 Descriptive flexfield segment.
69 * @param p_trb_information2 Descriptive flexfield segment.
70 * @param p_trb_information3 Descriptive flexfield segment.
71 * @param p_trb_information4 Descriptive flexfield segment.
72 * @param p_trb_information5 Descriptive flexfield segment.
73 * @param p_trb_information6 Descriptive flexfield segment.
74 * @param p_trb_information7 Descriptive flexfield segment.
75 * @param p_trb_information8 Descriptive flexfield segment.
76 * @param p_trb_information9 Descriptive flexfield segment.
77 * @param p_trb_information10 Descriptive flexfield segment.
78 * @param p_trb_information11 Descriptive flexfield segment.
79 * @param p_trb_information12 Descriptive flexfield segment.
80 * @param p_trb_information13 Descriptive flexfield segment.
81 * @param p_trb_information14 Descriptive flexfield segment.
82 * @param p_trb_information15 Descriptive flexfield segment.
83 * @param p_trb_information16 Descriptive flexfield segment.
84 * @param p_trb_information17 Descriptive flexfield segment.
85 * @param p_trb_information18 Descriptive flexfield segment.
86 * @param p_trb_information19 Descriptive flexfield segment.
87 * @param p_trb_information20 Descriptive flexfield segment.
88 * @param p_validate If true, then validation alone will be performed and the
89 * database will remain unchanged. If false and all validation checks pass,
90 * then the database will be modified.
91 * @param p_resource_booking_id The unique identifier of the resource booking
92 * record.
93 * @param p_object_version_number If p_validate is false, then the number is
94 * set to the version number of the created learning path category Inclusion
95 * record. If p_validate is true, then the value is null.
96 * @param p_display_to_learner_flag Valid values are defined by the 'YES_NO' lookup type.
97 * Specifies whether the booking is displayed to the learner.
98 * @param p_book_entire_period_flag Valid values are defined by the 'YES_NO' lookup type.
99 * Specifies whether the booking lasts for the entire time of the class or session,
100 * starting on the first day at the start time, and ending on the last day at the end time.
101 * @param p_chat_id The unique identifier of the chat for which the resource is being booked.
102 * @param p_forum_id The unique identifier of the forum for which the resource is being booked.
103 * @param p_timezone_code The time zone code of the resource booking.
104 * @rep:displayname Create Resource Booking
105 * @rep:category BUSINESS_ENTITY OTA_RESOURCE_BOOKING
106 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
107 * @rep:scope public
108 * @rep:lifecycle active
109 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
110 */
111 --
112 -- {End Of Comments}
113 --
114 procedure create_resource_booking
115 (p_effective_date in date
116 ,p_supplied_resource_id in number
117 ,p_date_booking_placed in date
118 ,p_status in varchar2
119 ,p_event_id in number default null
120 ,p_absolute_price in number default null
121 ,p_booking_person_id in number default null
122 ,p_comments in varchar2 default null
123 ,p_contact_name in varchar2 default null
124 ,p_contact_phone_number in varchar2 default null
125 ,p_delegates_per_unit in number default null
126 ,p_quantity in number default null
127 ,p_required_date_from in date default null
128 ,p_required_date_to in date default null
129 ,p_required_end_time in varchar2 default null
130 ,p_required_start_time in varchar2 default null
131 ,p_deliver_to in varchar2 default null
132 ,p_primary_venue_flag in varchar2 default null
133 ,p_role_to_play in varchar2 default null
134 ,p_trb_information_category in varchar2 default null
135 ,p_trb_information1 in varchar2 default null
136 ,p_trb_information2 in varchar2 default null
137 ,p_trb_information3 in varchar2 default null
138 ,p_trb_information4 in varchar2 default null
139 ,p_trb_information5 in varchar2 default null
140 ,p_trb_information6 in varchar2 default null
141 ,p_trb_information7 in varchar2 default null
142 ,p_trb_information8 in varchar2 default null
143 ,p_trb_information9 in varchar2 default null
144 ,p_trb_information10 in varchar2 default null
145 ,p_trb_information11 in varchar2 default null
146 ,p_trb_information12 in varchar2 default null
147 ,p_trb_information13 in varchar2 default null
148 ,p_trb_information14 in varchar2 default null
149 ,p_trb_information15 in varchar2 default null
150 ,p_trb_information16 in varchar2 default null
151 ,p_trb_information17 in varchar2 default null
152 ,p_trb_information18 in varchar2 default null
153 ,p_trb_information19 in varchar2 default null
154 ,p_trb_information20 in varchar2 default null
155 ,p_display_to_learner_flag in varchar2 default null
156 ,p_book_entire_period_flag in varchar2 default null
157 -- ,p_unbook_request_flag in varchar2 default null
158 ,p_chat_id in number default null
159 ,p_forum_id in number default null
160 ,p_validate in boolean default false
161 ,p_resource_booking_id out nocopy number
162 ,p_object_version_number out nocopy NUMBER
163 ,p_timezone_code IN VARCHAR2 DEFAULT NULL
164 );
165 --
166 -- ----------------------------------------------------------------------------
167 -- |-------------------------< update_resource_booking >----------------------|
168 -- ----------------------------------------------------------------------------
169 --
170 -- {Start Of Comments}
171 /*#
172 * This API updates a resource booking record.
173 *
174 *
175 * <p><b>Licensing</b><br>
176 * This API is licensed for use with Learning Management.
177 *
178 * <p><b>Prerequisites</b><br>
179 * The resource booking record must exist.
180 *
181 * <p><b>Post Success</b><br>
182 * The resource booking is succeesfully updated.
183 *
184 * <p><b>Post Failure</b><br>
185 * The resource booking record is not updated and an error is raised.
186 * @param p_effective_date Reference date for validating lookup values are
187 * applicable during the start to end active date range. This date does not
188 * determine when the changes take effect.
189 * @param p_supplied_resource_id The unique identifier of the resource booking
190 * record.
191 * @param p_date_booking_placed {@rep:casecolumn
192 * OTA_RESOURCE_BOOKINGS.DATE_BOOKING_PLACED}
193 * @param p_status Resource Booking status. Valid values are defined by the
194 * 'RESOURCE_BOOKING_STATUS' lookup type.
195 * @param p_event_id The unique identifier of the class for which the resource
196 * is being booked.
197 * @param p_absolute_price {@rep:casecolumn
198 * OTA_RESOURCE_BOOKINGS.ABSOLUTE_PRICE}
199 * @param p_booking_person_id The unique identifier of the person who is
200 * booking the resource.
201 * @param p_comments {@rep:casecolumn OTA_RESOURCE_BOOKINGS.COMMENTS}
202 * @param p_contact_name {@rep:casecolumn OTA_RESOURCE_BOOKINGS.CONTACT_NAME}
203 * @param p_contact_phone_number {@rep:casecolumn
204 * OTA_RESOURCE_BOOKINGS.CONTACT_PHONE_NUMBER}
205 * @param p_delegates_per_unit {@rep:casecolumn
206 * OTA_RESOURCE_BOOKINGS.DELEGATES_PER_UNIT}
207 * @param p_quantity {@rep:casecolumn OTA_RESOURCE_BOOKINGS.QUANTITY}
208 * @param p_required_date_from {@rep:casecolumn
209 * OTA_RESOURCE_BOOKINGS.REQUIRED_DATE_FROM}
210 * @param p_required_date_to {@rep:casecolumn
211 * OTA_RESOURCE_BOOKINGS.REQUIRED_DATE_TO}
212 * @param p_required_end_time {@rep:casecolumn
213 * OTA_RESOURCE_BOOKINGS.REQUIRED_END_TIME}
214 * @param p_required_start_time {@rep:casecolumn
215 * OTA_RESOURCE_BOOKINGS.REQUIRED_START_TIME}
216 * @param p_deliver_to {@rep:casecolumn OTA_RESOURCE_BOOKINGS.DELIVER_TO}
217 * @param p_primary_venue_flag {@rep:casecolumn
218 * OTA_RESOURCE_BOOKINGS.PRIMARY_VENUE_FLAG}
219 * @param p_role_to_play Resource Booking status. Valid values are defined by
220 * the 'TRAINER_PARTICIPATION' lookup type.
221 * @param p_trb_information_category This context value determines which
222 * Flexfield Structure to use with the Resource Booking Descriptive flexfield
223 * segments.
224 * @param p_trb_information1 Descriptive flexfield segment.
225 * @param p_trb_information2 Descriptive flexfield segment.
226 * @param p_trb_information3 Descriptive flexfield segment.
227 * @param p_trb_information4 Descriptive flexfield segment.
228 * @param p_trb_information5 Descriptive flexfield segment.
229 * @param p_trb_information6 Descriptive flexfield segment.
230 * @param p_trb_information7 Descriptive flexfield segment.
231 * @param p_trb_information8 Descriptive flexfield segment.
232 * @param p_trb_information9 Descriptive flexfield segment.
233 * @param p_trb_information10 Descriptive flexfield segment.
234 * @param p_trb_information11 Descriptive flexfield segment.
235 * @param p_trb_information12 Descriptive flexfield segment.
236 * @param p_trb_information13 Descriptive flexfield segment.
237 * @param p_trb_information14 Descriptive flexfield segment.
238 * @param p_trb_information15 Descriptive flexfield segment.
239 * @param p_trb_information16 Descriptive flexfield segment.
240 * @param p_trb_information17 Descriptive flexfield segment.
241 * @param p_trb_information18 Descriptive flexfield segment.
242 * @param p_trb_information19 Descriptive flexfield segment.
243 * @param p_trb_information20 Descriptive flexfield segment.
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 * @param p_resource_booking_id The unique identifier of the resource booking
248 * record.
249 * @param p_object_version_number Pass in the current version number of the
250 * resource booking record to be updated. When the API completes, if p_validate
251 * is false, the number is set to the new version number of the updated
252 * resource booking record. If p_validate is true the number remains unchanged.
253 * @param p_display_to_learner_flag Valid values are defined by the 'YES_NO' lookup type.
254 * Specifies whether the booking is displayed to the learner.
255 * @param p_book_entire_period_flag Valid values are defined by the 'YES_NO' lookup type.
256 * Specifies whether the booking lasts for the entire time of the class or session,
257 * starting on the first day at the start time, and ending on the last day at the end time.
258 * @param p_chat_id The unique identifier of the chat for which the resource is being booked.
259 * @param p_forum_id The unique identifier of the forum for which the resource is being booked.
260 * @param p_timezone_code The time zone code of the resource booking.
261 * @rep:displayname Update Resource Booking
262 * @rep:category BUSINESS_ENTITY OTA_RESOURCE_BOOKING
263 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
264 * @rep:scope public
265 * @rep:lifecycle active
266 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
267 */
268 --
269 -- {End Of Comments}
270 --
271 procedure update_resource_booking
272 (p_effective_date in date
273 ,p_supplied_resource_id in number
274 ,p_date_booking_placed in date
275 ,p_status in varchar2
276 ,p_event_id in number default hr_api.g_number
277 ,p_absolute_price in number default hr_api.g_number
278 ,p_booking_person_id in number default hr_api.g_number
279 ,p_comments in varchar2 default hr_api.g_varchar2
280 ,p_contact_name in varchar2 default hr_api.g_varchar2
281 ,p_contact_phone_number in varchar2 default hr_api.g_varchar2
282 ,p_delegates_per_unit in number default hr_api.g_number
283 ,p_quantity in number default hr_api.g_number
284 ,p_required_date_from in date default hr_api.g_date
285 ,p_required_date_to in date default hr_api.g_date
286 ,p_required_end_time in varchar2 default hr_api.g_varchar2
287 ,p_required_start_time in varchar2 default hr_api.g_varchar2
288 ,p_deliver_to in varchar2 default hr_api.g_varchar2
289 ,p_primary_venue_flag in varchar2 default hr_api.g_varchar2
290 ,p_role_to_play in varchar2 default hr_api.g_varchar2
291 ,p_trb_information_category in varchar2 default hr_api.g_varchar2
292 ,p_trb_information1 in varchar2 default hr_api.g_varchar2
293 ,p_trb_information2 in varchar2 default hr_api.g_varchar2
294 ,p_trb_information3 in varchar2 default hr_api.g_varchar2
295 ,p_trb_information4 in varchar2 default hr_api.g_varchar2
296 ,p_trb_information5 in varchar2 default hr_api.g_varchar2
297 ,p_trb_information6 in varchar2 default hr_api.g_varchar2
298 ,p_trb_information7 in varchar2 default hr_api.g_varchar2
299 ,p_trb_information8 in varchar2 default hr_api.g_varchar2
300 ,p_trb_information9 in varchar2 default hr_api.g_varchar2
301 ,p_trb_information10 in varchar2 default hr_api.g_varchar2
302 ,p_trb_information11 in varchar2 default hr_api.g_varchar2
303 ,p_trb_information12 in varchar2 default hr_api.g_varchar2
304 ,p_trb_information13 in varchar2 default hr_api.g_varchar2
305 ,p_trb_information14 in varchar2 default hr_api.g_varchar2
306 ,p_trb_information15 in varchar2 default hr_api.g_varchar2
307 ,p_trb_information16 in varchar2 default hr_api.g_varchar2
308 ,p_trb_information17 in varchar2 default hr_api.g_varchar2
309 ,p_trb_information18 in varchar2 default hr_api.g_varchar2
310 ,p_trb_information19 in varchar2 default hr_api.g_varchar2
311 ,p_trb_information20 in varchar2 default hr_api.g_varchar2
312 ,p_display_to_learner_flag in varchar2 default hr_api.g_varchar2
313 ,p_book_entire_period_flag in varchar2 default hr_api.g_varchar2
314 -- ,p_unbook_request_flag in varchar2 default hr_api.g_varchar2
315 ,p_chat_id in number default hr_api.g_number
316 ,p_forum_id in number default hr_api.g_number
317 ,p_validate in boolean
318 ,p_resource_booking_id in number
319 ,p_object_version_number in out nocopy number
320 ,p_timezone_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
321 );
322 --
323 -- ----------------------------------------------------------------------------
324 -- |-------------------------< delete_resource_booking >----------------------|
325 -- ----------------------------------------------------------------------------
326 --
327 -- {Start Of Comments}
328 /*#
329 * This API deletes the resource booking record.
330 *
331 *
332 * <p><b>Licensing</b><br>
333 * This API is licensed for use with Learning Management.
334 *
335 * <p><b>Prerequisites</b><br>
336 * The resource booking record must exist.
337 *
338 * <p><b>Post Success</b><br>
339 * The resource booking is succeesfully deleted.
340 *
341 * <p><b>Post Failure</b><br>
342 * The resource booking is not deleted and an error will be raised.
343 * @param p_resource_booking_id The unique identifier of the resource booking
344 * record.
345 * @param p_object_version_number Current version number of the resource
346 * booking record to be deleted.
347 * @param p_validate If true, then validation alone will be performed and the
348 * database will remain unchanged. If false and all validation checks pass,
349 * then the database will be modified.
350 * @rep:displayname Delete Resource Booking
351 * @rep:category BUSINESS_ENTITY OTA_RESOURCE_BOOKING
352 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
353 * @rep:scope public
354 * @rep:lifecycle active
355 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
356 */
357 --
358 -- {End Of Comments}
359 --
360 procedure delete_resource_booking
361 (
362 p_resource_booking_id in number,
363 p_object_version_number in number,
364 p_validate in boolean
365 );
366
367 end ota_resource_booking_api;
[Home] [Help]