1 PACKAGE OTA_FINANCE_LINE_API AUTHID CURRENT_USER as
2 /* $Header: ottflapi.pkh 120.5 2006/09/11 10:28:57 niarora noship $ */
3 /*#
4 * This package contains Finance Lines APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Finance Lines.
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_finance_line >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a Finance Line.
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 * Finance Header record must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Finance Line is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a Finance Line record, and raises an error.
30 *
31 * @param p_finance_line_id The unique identifier for finance line.
32 * @param p_finance_header_id The identifier of the finance header
33 * to which this finance line is linked.
34 * @param p_cancelled_flag The current state of this finance line.
35 * Permissible values Y and N.
36 * @param p_date_raised The date of creation of theis finance line.
37 * @param p_line_type The type of line. Valid values are: course payment,
38 * pre-purchase,delegate etc.
39 * @param p_object_version_number If p_validate is false, then set to the
40 * version number of the created learning path section.
41 * If p_validate is true, then the value will be null.
42 * @param p_sequence_number The order in which this line appears under the header.
43 * @param p_transfer_status Status of transfer.
44 * @param p_comments Comments text.
45 * @param p_currency_code The currency code of the finance line.
46 * @param p_money_amount The money amount which this line is charging or paying.
47 * @param p_standard_amount The money or unit value before a discount has
48 * been applied.
49 * @param p_trans_information_category This context value determines which
50 * flexfield structure to use with the descriptive flexfield segments.
51 * @param p_trans_information1 Transfer Descriptive flexfield segment.
52 * @param p_trans_information2 Transfer Descriptive flexfield segment.
53 * @param p_trans_information3 Transfer Descriptive flexfield segment.
54 * @param p_trans_information4 Transfer Descriptive flexfield segment.
55 * @param p_trans_information5 Transfer Descriptive flexfield segment.
56 * @param p_trans_information6 Transfer Descriptive flexfield segment.
57 * @param p_trans_information7 Transfer Descriptive flexfield segment.
58 * @param p_trans_information8 Transfer Descriptive flexfield segment.
59 * @param p_trans_information9 Transfer Descriptive flexfield segment.
60 * @param p_trans_information10 Transfer Descriptive flexfield segment.
61 * @param p_trans_information11 Transfer Descriptive flexfield segment.
62 * @param p_trans_information12 Transfer Descriptive flexfield segment.
63 * @param p_trans_information13 Transfer Descriptive flexfield segment.
64 * @param p_trans_information14 Transfer Descriptive flexfield segment.
65 * @param p_trans_information15 Transfer Descriptive flexfield segment.
66 * @param p_trans_information16 Transfer Descriptive flexfield segment.
67 * @param p_trans_information17 Transfer Descriptive flexfield segment.
68 * @param p_trans_information18 Transfer Descriptive flexfield segment.
69 * @param p_trans_information19 Transfer Descriptive flexfield segment.
70 * @param p_trans_information20 Transfer Descriptive flexfield segment.
71 * @param p_transfer_date Date on which the finance header is transferred
72 * to a financial system.
73 * @param p_transfer_message Message associated with the transfer of the
74 * finance header.
75 * @param p_unitary_amount The amount of training units being bought or used.
76 * @param p_booking_deal_id Foreign key to OTA_BOOKING_DEALS.
77 * @param p_booking_id Foreign key to OTA_DELEGATE_BOOKINGS.
78 * @param p_resource_allocation_id Foreign key to OTA_RESOURCE_ALLOCATIONS.
79 * @param p_resource_booking_id Foreign key to OTA_RESOURCE_BOOKINGS.
80 * @param p_last_update_date Standard Who Column.
81 * @param p_last_updated_by Standard Who Column.
82 * @param p_last_update_login Standard Who Column.
83 * @param p_created_by Standard Who Column.
84 * @param p_creation_date Standard Who Column.
85 * @param p_tfl_information_category This context value determines which
86 * flexfield structure to use with the descriptive flexfield segments.
87 * @param p_tfl_information1 Descriptive flexfield segment.
88 * @param p_tfl_information2 Descriptive flexfield segment.
89 * @param p_tfl_information3 Descriptive flexfield segment.
90 * @param p_tfl_information4 Descriptive flexfield segment.
91 * @param p_tfl_information5 Descriptive flexfield segment.
92 * @param p_tfl_information6 Descriptive flexfield segment.
93 * @param p_tfl_information7 Descriptive flexfield segment.
94 * @param p_tfl_information8 Descriptive flexfield segment.
95 * @param p_tfl_information9 Descriptive flexfield segment.
96 * @param p_tfl_information10 Descriptive flexfield segment.
97 * @param p_tfl_information11 Descriptive flexfield segment.
98 * @param p_tfl_information12 Descriptive flexfield segment.
99 * @param p_tfl_information13 Descriptive flexfield segment.
100 * @param p_tfl_information14 Descriptive flexfield segment.
101 * @param p_tfl_information15 Descriptive flexfield segment.
102 * @param p_tfl_information16 Descriptive flexfield segment.
103 * @param p_tfl_information17 Descriptive flexfield segment.
104 * @param p_tfl_information18 Descriptive flexfield segment.
105 * @param p_tfl_information19 Descriptive flexfield segment.
106 * @param p_tfl_information20 Descriptive flexfield segment.
107 * @param p_validate If true, then validation alone will be performed and the
108 * database will remain unchanged. If false and all validation checks pass,
109 * then the database will be modified.
110 * @param p_effective_date Reference date for validating that lookup values
111 * are applicable during the start to end active date range. This date
112 * does not determine when the changes take effect.
113 * @rep:displayname Create Finance Lines
114 * @rep:category BUSINESS_ENTITY OTA_FINANCE_LINE
115 * @rep:lifecycle active
116 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
117 * @rep:scope public
118 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
119 */
120 --
121 -- {End Of Comments}
122 --
123 procedure CREATE_FINANCE_LINE
124 (
125 P_FINANCE_LINE_ID OUT NOCOPY NUMBER,
126 P_FINANCE_HEADER_ID IN NUMBER,
127 P_CANCELLED_FLAG IN VARCHAR2,
128 P_DATE_RAISED IN OUT NOCOPY DATE,
129 P_LINE_TYPE IN VARCHAR2,
130 P_OBJECT_VERSION_NUMBER OUT NOCOPY NUMBER,
131 P_SEQUENCE_NUMBER IN OUT NOCOPY NUMBER,
132 P_TRANSFER_STATUS IN VARCHAR2,
133 P_COMMENTS IN VARCHAR2,
134 P_CURRENCY_CODE IN VARCHAR2,
135 P_MONEY_AMOUNT IN NUMBER,
136 P_STANDARD_AMOUNT IN NUMBER,
137 P_TRANS_INFORMATION_CATEGORY IN VARCHAR2,
138 P_TRANS_INFORMATION1 IN VARCHAR2,
139 P_TRANS_INFORMATION10 IN VARCHAR2,
140 P_TRANS_INFORMATION11 IN VARCHAR2,
141 P_TRANS_INFORMATION12 IN VARCHAR2,
142 P_TRANS_INFORMATION13 IN VARCHAR2,
143 P_TRANS_INFORMATION14 IN VARCHAR2,
144 P_TRANS_INFORMATION15 IN VARCHAR2,
145 P_TRANS_INFORMATION16 IN VARCHAR2,
146 P_TRANS_INFORMATION17 IN VARCHAR2,
147 P_TRANS_INFORMATION18 IN VARCHAR2,
148 P_TRANS_INFORMATION19 IN VARCHAR2,
149 P_TRANS_INFORMATION2 IN VARCHAR2,
150 P_TRANS_INFORMATION20 IN VARCHAR2,
151 P_TRANS_INFORMATION3 IN VARCHAR2,
152 P_TRANS_INFORMATION4 IN VARCHAR2,
153 P_TRANS_INFORMATION5 IN VARCHAR2,
154 P_TRANS_INFORMATION6 IN VARCHAR2,
155 P_TRANS_INFORMATION7 IN VARCHAR2,
156 P_TRANS_INFORMATION8 IN VARCHAR2,
157 P_TRANS_INFORMATION9 IN VARCHAR2,
158 P_TRANSFER_DATE IN DATE ,
159 P_TRANSFER_MESSAGE IN VARCHAR2,
160 P_UNITARY_AMOUNT IN NUMBER,
161 P_BOOKING_DEAL_ID IN NUMBER,
162 P_BOOKING_ID IN NUMBER,
163 P_RESOURCE_ALLOCATION_ID IN NUMBER,
164 P_RESOURCE_BOOKING_ID IN NUMBER,
165 P_LAST_UPDATE_DATE IN DATE,
166 P_LAST_UPDATED_BY IN NUMBER,
167 P_LAST_UPDATE_LOGIN IN NUMBER,
168 P_CREATED_BY IN NUMBER,
169 P_CREATION_DATE IN DATE ,
170 P_TFL_INFORMATION_CATEGORY IN VARCHAR2,
171 P_TFL_INFORMATION1 IN VARCHAR2,
172 P_TFL_INFORMATION2 IN VARCHAR2,
173 P_TFL_INFORMATION3 IN VARCHAR2,
174 P_TFL_INFORMATION4 IN VARCHAR2,
175 P_TFL_INFORMATION5 IN VARCHAR2,
176 P_TFL_INFORMATION6 IN VARCHAR2,
177 P_TFL_INFORMATION7 IN VARCHAR2,
178 P_TFL_INFORMATION8 IN VARCHAR2,
179 P_TFL_INFORMATION9 IN VARCHAR2,
180 P_TFL_INFORMATION10 IN VARCHAR2,
181 P_TFL_INFORMATION11 IN VARCHAR2,
182 P_TFL_INFORMATION12 IN VARCHAR2,
183 P_TFL_INFORMATION13 IN VARCHAR2,
184 P_TFL_INFORMATION14 IN VARCHAR2,
185 P_TFL_INFORMATION15 IN VARCHAR2,
186 P_TFL_INFORMATION16 IN VARCHAR2,
187 P_TFL_INFORMATION17 IN VARCHAR2,
188 P_TFL_INFORMATION18 IN VARCHAR2,
189 P_TFL_INFORMATION19 IN VARCHAR2,
190 P_TFL_INFORMATION20 IN VARCHAR2,
191 P_VALIDATE IN boolean default false,
192 P_EFFECTIVE_DATE IN DATE
193
194 );
195 --
196 -- ----------------------------------------------------------------------------
197 -- |---------------------------< update_finance_line >------------------------|
198 -- ----------------------------------------------------------------------------
199 --
200 -- {Start Of Comments}
201 /*#
202 * This API updates a Finance Line.
203 *
204 *
205 * <p><b>Licensing</b><br>
206 * This API is licensed for use with Learning Management.
207 *
208 * <p><b>Prerequisites</b><br>
209 * Finance Line record with the given object version number should exist.
210 *
211 * <p><b>Post Success</b><br>
212 * The Finance Line is updated successfully.
213 *
214 * <p><b>Post Failure</b><br>
215 * The API does not update a Finance Line record, and raises an error.
216 *
217 * @param p_finance_line_id The unique identifier for the finance line.
218 * @param p_object_version_number If p_validate is false, then set to the version
219 * number of the created learning path section. If p_validate is true, then the value will be null.
220 * @param p_new_object_version_number obsolete.
221 * @param p_finance_header_id The identifier of the finance header to which this finance line is linked.
222 * @param p_cancelled_flag The current state of this finance line.
223 * Permissible values Y and N.
224 * @param p_date_raised The date of creation of this finance line.
225 * @param p_line_type The type of line. Valid values are: course payment,pre-purchase,delegate etc.
226 * @param p_sequence_number The order in which this line appears under the header.
227 * @param p_transfer_status Status of transfer.
228 * @param p_comments Comments text.
229 * @param p_currency_code The currency code of the finance line.
230 * @param p_money_amount The money amount which this line is charging or paying.
231 * @param p_standard_amount The money or unit value before a discount has been applied.
232 * @param p_trans_information_category This context value determines which
233 * flexfield structure to use with the descriptive flexfield segments.
234 * @param p_trans_information1 Transfer Descriptive flexfield segment.
235 * @param p_trans_information2 Transfer Descriptive flexfield segment.
236 * @param p_trans_information3 Transfer Descriptive flexfield segment.
237 * @param p_trans_information4 Transfer Descriptive flexfield segment.
238 * @param p_trans_information5 Transfer Descriptive flexfield segment.
239 * @param p_trans_information6 Transfer Descriptive flexfield segment.
240 * @param p_trans_information7 Transfer Descriptive flexfield segment.
241 * @param p_trans_information8 Transfer Descriptive flexfield segment.
242 * @param p_trans_information9 Transfer Descriptive flexfield segment.
243 * @param p_trans_information10 Transfer Descriptive flexfield segment.
244 * @param p_trans_information11 Transfer Descriptive flexfield segment.
245 * @param p_trans_information12 Transfer Descriptive flexfield segment.
246 * @param p_trans_information13 Transfer Descriptive flexfield segment.
247 * @param p_trans_information14 Transfer Descriptive flexfield segment.
248 * @param p_trans_information15 Transfer Descriptive flexfield segment.
249 * @param p_trans_information16 Transfer Descriptive flexfield segment.
250 * @param p_trans_information17 Transfer Descriptive flexfield segment.
251 * @param p_trans_information18 Transfer Descriptive flexfield segment.
252 * @param p_trans_information19 Transfer Descriptive flexfield segment.
253 * @param p_trans_information20 Transfer Descriptive flexfield segment.
254 * @param p_transfer_date Date on which the finance header is transferred
255 * to a financial system.
256 * @param p_transfer_message Message associated with the transfer of the
257 * finance header.
258 * @param p_unitary_amount The amount of training units being bought or used.
259 * @param p_booking_deal_id Foreign key to OTA_BOOKING_DEALS.
260 * @param p_booking_id Foreign key to OTA_DELEGATE_BOOKINGS.
261 * @param p_resource_allocation_id Foreign key to OTA_RESOURCE_ALLOCATIONS.
262 * @param p_resource_booking_id Foreign key to OTA_RESOURCE_BOOKINGS.
263 * @param p_last_update_date Standard Who Column.
264 * @param p_last_updated_by Standard Who Column.
265 * @param p_last_update_login Standard Who Column.
266 * @param p_created_by Standard Who Column.
267 * @param p_creation_date Standard Who Column.
268 * @param p_tfl_information_category This context value determines which
269 * flexfield structure to use with the descriptive flexfield segments.
270 * @param p_tfl_information1 Descriptive flexfield segment.
271 * @param p_tfl_information2 Descriptive flexfield segment.
272 * @param p_tfl_information3 Descriptive flexfield segment.
273 * @param p_tfl_information4 Descriptive flexfield segment.
274 * @param p_tfl_information5 Descriptive flexfield segment.
275 * @param p_tfl_information6 Descriptive flexfield segment.
276 * @param p_tfl_information7 Descriptive flexfield segment.
277 * @param p_tfl_information8 Descriptive flexfield segment.
278 * @param p_tfl_information9 Descriptive flexfield segment.
279 * @param p_tfl_information10 Descriptive flexfield segment.
280 * @param p_tfl_information11 Descriptive flexfield segment.
281 * @param p_tfl_information12 Descriptive flexfield segment.
282 * @param p_tfl_information13 Descriptive flexfield segment.
283 * @param p_tfl_information14 Descriptive flexfield segment.
284 * @param p_tfl_information15 Descriptive flexfield segment.
285 * @param p_tfl_information16 Descriptive flexfield segment.
286 * @param p_tfl_information17 Descriptive flexfield segment.
287 * @param p_tfl_information18 Descriptive flexfield segment.
288 * @param p_tfl_information19 Descriptive flexfield segment.
289 * @param p_tfl_information20 Descriptive flexfield segment.
290 * @param p_validate If true, then validation alone will be performed and the
291 * database will remain unchanged. If false and all validation checks pass,
292 * then the database will be modified.
293 * @param p_transaction_type Type of transaction. Valid values are : cancel_line,reinstate_line,
294 * cancel_header_line, etc.
295 * @param p_effective_date Reference date for validating that lookup values
296 * are applicable during the start to end active date range. This date
297 * does not determine when the changes take effect.
298 * @rep:displayname Update Finance Lines
299 * @rep:category BUSINESS_ENTITY OTA_FINANCE_LINE
300 * @rep:lifecycle active
301 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
302 * @rep:scope public
303 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
304 */
305 --
306 -- {End Of Comments}
307 --
308 procedure UPDATE_FINANCE_LINE
309 (
310 P_FINANCE_LINE_ID IN NUMBER,
311 P_OBJECT_VERSION_NUMBER IN OUT NOCOPY NUMBER,
312 P_NEW_OBJECT_VERSION_NUMBER OUT NOCOPY NUMBER,
313 P_FINANCE_HEADER_ID IN NUMBER,
314 P_CANCELLED_FLAG IN VARCHAR2,
318 P_TRANSFER_STATUS IN VARCHAR2,
315 P_DATE_RAISED IN OUT NOCOPY DATE,
316 P_LINE_TYPE IN VARCHAR2,
317 P_SEQUENCE_NUMBER IN OUT NOCOPY NUMBER,
319 P_COMMENTS IN VARCHAR2,
320 P_CURRENCY_CODE IN VARCHAR2,
321 P_MONEY_AMOUNT IN NUMBER,
322 P_STANDARD_AMOUNT IN NUMBER,
323 P_TRANS_INFORMATION_CATEGORY IN VARCHAR2,
324 P_TRANS_INFORMATION1 IN VARCHAR2,
325 P_TRANS_INFORMATION10 IN VARCHAR2,
326 P_TRANS_INFORMATION11 IN VARCHAR2,
327 P_TRANS_INFORMATION12 IN VARCHAR2,
328 P_TRANS_INFORMATION13 IN VARCHAR2,
329 P_TRANS_INFORMATION14 IN VARCHAR2,
330 P_TRANS_INFORMATION15 IN VARCHAR2,
331 P_TRANS_INFORMATION16 IN VARCHAR2,
332 P_TRANS_INFORMATION17 IN VARCHAR2,
333 P_TRANS_INFORMATION18 IN VARCHAR2,
334 P_TRANS_INFORMATION19 IN VARCHAR2,
335 P_TRANS_INFORMATION2 IN VARCHAR2,
336 P_TRANS_INFORMATION20 IN VARCHAR2,
337 P_TRANS_INFORMATION3 IN VARCHAR2,
338 P_TRANS_INFORMATION4 IN VARCHAR2,
339 P_TRANS_INFORMATION5 IN VARCHAR2,
340 P_TRANS_INFORMATION6 IN VARCHAR2,
341 P_TRANS_INFORMATION7 IN VARCHAR2,
342 P_TRANS_INFORMATION8 IN VARCHAR2,
343 P_TRANS_INFORMATION9 IN VARCHAR2,
344 P_TRANSFER_DATE IN DATE ,
345 P_TRANSFER_MESSAGE IN VARCHAR2,
346 P_UNITARY_AMOUNT IN NUMBER,
347 P_BOOKING_DEAL_ID IN NUMBER,
348 P_BOOKING_ID IN NUMBER,
349 P_RESOURCE_ALLOCATION_ID IN NUMBER,
350 P_RESOURCE_BOOKING_ID IN NUMBER,
351 P_LAST_UPDATE_DATE IN DATE,
352 P_LAST_UPDATED_BY IN NUMBER,
353 P_LAST_UPDATE_LOGIN IN NUMBER,
354 P_CREATED_BY IN NUMBER,
355 P_CREATION_DATE IN DATE ,
356 P_TFL_INFORMATION_CATEGORY IN VARCHAR2,
357 P_TFL_INFORMATION1 IN VARCHAR2,
358 P_TFL_INFORMATION2 IN VARCHAR2,
359 P_TFL_INFORMATION3 IN VARCHAR2,
360 P_TFL_INFORMATION4 IN VARCHAR2,
361 P_TFL_INFORMATION5 IN VARCHAR2,
362 P_TFL_INFORMATION6 IN VARCHAR2,
363 P_TFL_INFORMATION7 IN VARCHAR2,
364 P_TFL_INFORMATION8 IN VARCHAR2,
365 P_TFL_INFORMATION9 IN VARCHAR2,
366 P_TFL_INFORMATION10 IN VARCHAR2,
367 P_TFL_INFORMATION11 IN VARCHAR2,
368 P_TFL_INFORMATION12 IN VARCHAR2,
369 P_TFL_INFORMATION13 IN VARCHAR2,
370 P_TFL_INFORMATION14 IN VARCHAR2,
371 P_TFL_INFORMATION15 IN VARCHAR2,
372 P_TFL_INFORMATION16 IN VARCHAR2,
373 P_TFL_INFORMATION17 IN VARCHAR2,
374 P_TFL_INFORMATION18 IN VARCHAR2,
375 P_TFL_INFORMATION19 IN VARCHAR2,
376 P_TFL_INFORMATION20 IN VARCHAR2,
377 P_VALIDATE IN boolean default false,
378 P_TRANSACTION_TYPE IN VARCHAR2 default 'UPDATE',
379 P_EFFECTIVE_DATE IN DATE
380
381 );
382 --
383 -- ----------------------------------------------------------------------------
384 -- |---------------------------< delete_finance_line >------------------------|
385 -- ----------------------------------------------------------------------------
386 --
387 -- {Start Of Comments}
388 /*#
389 * This API Deletes a Finance Line.
390 *
391 *
392 * <p><b>Licensing</b><br>
393 * This API is licensed for use with Learning Management.
394 *
395 * <p><b>Prerequisites</b><br>
396 * Finance Line record with the given object version number should exist.
397 *
398 * <p><b>Post Success</b><br>
399 * The Finance Line is deleted successfully.
400 *
401 * <p><b>Post Failure</b><br>
402 * The API does not delete a Finance Line record, and raises an error.
403 *
404 * @param p_validate If true, then validation alone will be performed and the
405 * database will remain unchanged. If false and all validation checks pass,
406 * then the database will be modified.
407 * @param p_finance_line_id The unique identifier for the finance line.
408 * @param p_object_version_number If p_validate is false, then set to the
409 * version number of the created learning path section.
410 * If p_validate is true, then the value will be null.
411 * @rep:displayname Delete Finance Lines
412 * @rep:category BUSINESS_ENTITY OTA_FINANCE_LINE
413 * @rep:lifecycle active
414 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
415 * @rep:scope public
416 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
417 */
418 --
419 -- {End Of Comments}
420 --
421 procedure DELETE_FINANCE_LINE
422 (p_validate in boolean default false
423 ,p_finance_line_id in number
424 ,p_object_version_number in number
425 );
426
427 end ota_FINANCE_LINE_api;
428
[Home] [Help]