[Home] [Help]
PACKAGE: APPS.IBY_ASSIGN_PUB
Source
1 PACKAGE IBY_ASSIGN_PUB AS
2 /*$Header: ibyasgns.pls 120.2 2005/06/08 23:10:23 rameshsh noship $*/
3
4 --
5 --
6 TYPE updateDocAttributesRec IS RECORD (
7 payment_request_id
8 IBY_DOCS_PAYABLE_ALL.payment_service_request_id%TYPE,
9 int_bank_acct_id
10 IBY_DOCS_PAYABLE_ALL.internal_bank_account_id%TYPE,
11 pay_profile_id
12 IBY_DOCS_PAYABLE_ALL.payment_profile_id%TYPE,
13 bank_acct_flag
14 BOOLEAN,
15 pay_profile_flag
16 BOOLEAN
17 );
18
19 --
20 -- Used to update of the IBY_DOCS_PAYABLE_ALL table.
21 --
22 --TYPE updateDocsTabType IS TABLE OF updateDocAttributesRec
23 -- INDEX BY BINARY_INTEGER;
24
25 --
26 --
27 --
28 TYPE unassignedDocRec IS RECORD (
29 document_id
30 IBY_DOCS_PAYABLE_ALL.document_payable_id%TYPE,
31 calling_app_id
32 IBY_DOCS_PAYABLE_ALL.calling_app_id%TYPE,
33 calling_app_doc_id1
34 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref1%TYPE,
35 calling_app_doc_id2
36 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref2%TYPE,
37 calling_app_doc_id3
38 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref3%TYPE,
39 calling_app_doc_id4
40 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref4%TYPE,
41 calling_app_doc_id5
42 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref5%TYPE,
43 pay_proc_ttype_cd
44 IBY_DOCS_PAYABLE_ALL.pay_proc_trxn_type_code%TYPE,
45 int_bank_acct_id
46 IBY_DOCS_PAYABLE_ALL.internal_bank_account_id%TYPE := -1,
47 pay_profile_id
48 IBY_DOCS_PAYABLE_ALL.payment_profile_id%TYPE := -1
49 );
50
51 TYPE unassignedDocsTabType IS TABLE OF unassignedDocRec
52 INDEX BY BINARY_INTEGER;
53
54 --
55 --
56 TYPE assignCriteriaType IS RECORD (
57 document_id
58 IBY_DOCS_PAYABLE_ALL.document_payable_id%TYPE,
59 calling_app_id
60 IBY_DOCS_PAYABLE_ALL.calling_app_id%TYPE,
61 calling_app_doc_id1
62 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref1%TYPE,
63 calling_app_doc_id2
64 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref2%TYPE,
65 calling_app_doc_id3
66 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref3%TYPE,
67 calling_app_doc_id4
68 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref4%TYPE,
69 calling_app_doc_id5
70 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref5%TYPE,
71 pay_proc_ttype_cd
72 IBY_DOCS_PAYABLE_ALL.pay_proc_trxn_type_code%TYPE,
73 int_bank_acct_id
74 IBY_DOCS_PAYABLE_ALL.internal_bank_account_id%TYPE,
75 payment_profile_id
76 IBY_DOCS_PAYABLE_ALL.payment_profile_id%TYPE,
77 payment_currency
78 IBY_DOCS_PAYABLE_ALL.payment_currency_code%TYPE,
79 payment_method
80 IBY_DOCS_PAYABLE_ALL.payment_method_code%TYPE,
81 payment_format
82 IBY_DOCS_PAYABLE_ALL.payment_format_code%TYPE,
83 org_id
84 IBY_DOCS_PAYABLE_ALL.org_id%TYPE,
85 org_type
86 IBY_DOCS_PAYABLE_ALL.org_type%TYPE,
87 payment_date
88 IBY_DOCS_PAYABLE_ALL.payment_date%TYPE,
89 ext_payee_id
90 IBY_DOCS_PAYABLE_ALL.ext_payee_id%TYPE
91 );
92
93 --
94 -- Table of assignment criteria.
95 --
96 TYPE assignCriteriaTabType IS TABLE OF assignCriteriaType
97 INDEX BY BINARY_INTEGER;
98
99 --
100 -- Table of bank accounts. Used by dummy CE API is available
101 --
102 TYPE bankAccounts IS TABLE OF IBY_DOCS_PAYABLE_ALL.
103 internal_bank_account_id%TYPE INDEX BY BINARY_INTEGER;
104
105 --
106 --
107 --
108 TYPE setDocAttributesRec IS RECORD (
109 doc_id
110 IBY_DOCS_PAYABLE_ALL.document_payable_id%TYPE,
111 ca_id
112 IBY_DOCS_PAYABLE_ALL.calling_app_id%TYPE,
113 ca_doc_id1
114 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref1%TYPE,
115 ca_doc_id2
116 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref2%TYPE,
117 ca_doc_id3
118 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref3%TYPE,
119 ca_doc_id4
120 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref4%TYPE,
121 ca_doc_id5
122 IBY_DOCS_PAYABLE_ALL.calling_app_doc_unique_ref5%TYPE,
123 pp_tt_cd
124 IBY_DOCS_PAYABLE_ALL.pay_proc_trxn_type_code%TYPE,
125 int_bank_acct_id
126 IBY_DOCS_PAYABLE_ALL.internal_bank_account_id%TYPE,
127 pay_profile_id
128 IBY_DOCS_PAYABLE_ALL.payment_profile_id%TYPE,
129 status
130 IBY_DOCS_PAYABLE_ALL.document_status%TYPE
131 );
132
133 --
134 -- Used to update of the IBY_DOCS_PAYABLE_ALL table.
135 --
136 TYPE setDocAttribsTabType IS TABLE OF setDocAttributesRec
137 INDEX BY BINARY_INTEGER;
138
139
140 /*--------------------------------------------------------------------
141 | NAME:
142 | performAssignments
143 |
144 | PURPOSE:
145 |
146 |
147 |
148 | PARAMETERS:
149 | IN
150 |
151 |
152 | OUT
153 |
154 |
155 | RETURNS:
156 |
157 | NOTES:
158 |
159 *---------------------------------------------------------------------*/
160 PROCEDURE performAssignments(
161 p_payment_request_id IN IBY_PAY_SERVICE_REQUESTS.
162 payment_service_request_id%type,
163 x_return_status IN OUT NOCOPY VARCHAR2
164 );
165
166 /*--------------------------------------------------------------------
167 | NAME:
168 | getRequestAttributes
169 |
170 | PURPOSE:
171 |
172 |
173 |
174 | PARAMETERS:
175 | IN
176 |
177 |
178 | OUT
179 |
180 |
181 | RETURNS:
182 |
183 | NOTES:
184 |
185 *---------------------------------------------------------------------*/
186 PROCEDURE getRequestAttributes(
187 p_payReqId IN IBY_PAY_SERVICE_REQUESTS.payment_service_request_id%TYPE,
188 x_caPayReqCd IN OUT NOCOPY
189 IBY_PAY_SERVICE_REQUESTS.call_app_pay_service_req_code%TYPE,
190 x_caId IN OUT NOCOPY
191 IBY_PAY_SERVICE_REQUESTS.calling_app_id%TYPE,
192 x_bankAcctId IN OUT NOCOPY
193 IBY_PAY_SERVICE_REQUESTS.internal_bank_account_id%TYPE,
194 x_profileId IN OUT NOCOPY
195 IBY_PAY_SERVICE_REQUESTS.payment_profile_id%TYPE
196 );
197
198 /*--------------------------------------------------------------------
199 | NAME:
200 | updateDocumentAssignments
201 |
202 | PURPOSE:
203 |
204 |
205 |
206 | PARAMETERS:
207 | IN
208 |
209 |
210 | OUT
211 |
212 |
213 | RETURNS:
214 |
215 | NOTES:
216 |
217 *---------------------------------------------------------------------*/
218 PROCEDURE updateDocumentAssignments(
219 p_updateDocsRec IN IBY_ASSIGN_PUB.updateDocAttributesRec
220 );
221
222 /*--------------------------------------------------------------------
223 | NAME:
224 | dummyCEAPI
225 |
226 | PURPOSE:
227 |
228 |
229 |
230 | PARAMETERS:
231 | IN
232 |
233 |
234 | OUT
235 |
236 |
237 | RETURNS:
238 |
239 | NOTES:
240 |
241 *---------------------------------------------------------------------*/
242 PROCEDURE dummyCEAPI(
243 p_payCurrency IN IBY_DOCS_PAYABLE_ALL.payment_currency_code%TYPE,
244 p_pmtDate IN IBY_DOCS_PAYABLE_ALL.payment_date%TYPE,
245 p_OrgID IN IBY_DOCS_PAYABLE_ALL.org_id%TYPE,
246 x_bankAccounts IN OUT NOCOPY IBY_ASSIGN_PUB.bankAccounts
247 );
248
249 /*--------------------------------------------------------------------
250 | NAME:
251 | setDocumentAssignments
252 |
253 | PURPOSE:
254 |
255 |
256 |
257 | PARAMETERS:
258 | IN
259 |
260 |
261 | OUT
262 |
263 |
264 | RETURNS:
265 |
266 | NOTES:
267 |
268 *---------------------------------------------------------------------*/
269 PROCEDURE setDocumentAssignments(
270 p_setDocAttribsTab IN IBY_ASSIGN_PUB.setDocAttribsTabType
271 );
272
273 /*--------------------------------------------------------------------
274 | NAME:
275 | getProfileFromProfileDrivers
276 |
277 | PURPOSE:
278 |
279 |
280 |
281 | PARAMETERS:
282 | IN
283 |
284 |
285 | OUT
286 |
287 |
288 | RETURNS:
289 |
290 | NOTES:
291 |
292 *---------------------------------------------------------------------*/
293 FUNCTION getProfileFromProfileDrivers(
294 p_pmt_method_cd IN IBY_DOCS_PAYABLE_ALL.payment_method_code%TYPE,
295 p_org_id IN IBY_DOCS_PAYABLE_ALL.org_id%TYPE,
296 p_org_type IN IBY_DOCS_PAYABLE_ALL.org_type%TYPE,
297 p_pmt_currency IN IBY_DOCS_PAYABLE_ALL.payment_currency_code%TYPE,
298 p_int_bank_acct_id IN IBY_DOCS_PAYABLE_ALL.internal_bank_account_id%TYPE
299 ) RETURN NUMBER;
300
301 /*--------------------------------------------------------------------
302 | NAME:
303 | getProfileFromPayeeFormat
304 |
305 | PURPOSE:
306 |
307 |
308 |
309 | PARAMETERS:
310 | IN
311 |
312 |
313 | OUT
314 |
315 |
316 | RETURNS:
317 |
318 | NOTES:
319 |
320 *---------------------------------------------------------------------*/
321 FUNCTION getProfileFromPayeeFormat(
322 p_payee_id IN IBY_DOCS_PAYABLE_ALL.ext_payee_id%TYPE
323 ) RETURN NUMBER;
324
325 /*--------------------------------------------------------------------
326 | NAME:
327 | finalizeStatuses
328 |
329 | PURPOSE:
330 |
331 |
332 |
333 | PARAMETERS:
334 | IN
335 |
336 | OUT
337 |
338 |
339 | RETURNS:
340 |
341 | NOTES:
342 |
343 *---------------------------------------------------------------------*/
344 PROCEDURE finalizeStatuses(
345 p_payReqID IN IBY_PAY_SERVICE_REQUESTS.payment_service_request_id%TYPE,
346 x_req_status IN OUT NOCOPY VARCHAR2
347 );
348
349 /*--------------------------------------------------------------------
350 | NAME:
354 |
351 | updateRequestStatus
352 |
353 | PURPOSE:
355 |
356 |
357 | PARAMETERS:
358 | IN
359 |
360 | OUT
361 |
362 |
363 | RETURNS:
364 |
365 | NOTES:
366 |
367 *---------------------------------------------------------------------*/
368 PROCEDURE updateRequestStatus(
369 p_payReqID IN IBY_PAY_SERVICE_REQUESTS.payment_service_request_id%TYPE,
370 x_req_status IN OUT NOCOPY VARCHAR2
371 );
372
373 /*--------------------------------------------------------------------
374 | NAME:
375 | hookForAssignments
376 |
377 | PURPOSE:
378 |
379 |
380 |
381 | PARAMETERS:
382 | IN
383 |
384 | OUT
385 |
386 |
387 | RETURNS:
388 |
389 | NOTES:
390 | This method should be implemented on-site by the customer
391 | (if the customer wants to implement any custom defaulting
392 | logic for documents that do not have their internal bank
393 | account, and/or payment profile).
394 |
395 | This method will ship with an empty body out-of-the-box
396 | from Oracle Payments.
397 |
398 *---------------------------------------------------------------------*/
399 PROCEDURE hookForAssignments(
400 x_unassgnDocsTab IN OUT NOCOPY IBY_ASSIGN_PUB.unassignedDocsTabType
401 );
402
403 /*--------------------------------------------------------------------
404 | NAME:
405 | dummyAsgnHook
406 |
407 | PURPOSE:
408 | Dummy hook; To be used for testing purposes.
409 |
410 |
411 | PARAMETERS:
412 | IN
413 |
414 | OUT
415 |
416 |
417 | RETURNS:
418 |
419 | NOTES:
420 |
421 *---------------------------------------------------------------------*/
422 PROCEDURE dummyAsgnHook(
423 x_unassgnDocsTab IN OUT NOCOPY IBY_ASSIGN_PUB.unassignedDocsTabType
424 );
425
426 /*--------------------------------------------------------------------
427 | NAME:
428 | populateDocAttributes
429 |
430 | PURPOSE:
431 |
432 |
433 | PARAMETERS:
434 | IN
435 |
436 | OUT
437 |
438 |
439 | RETURNS:
440 |
441 | NOTES:
442 |
443 *---------------------------------------------------------------------*/
444 PROCEDURE populateDocAttributes(
445 p_hookAsgnDocsTab IN IBY_ASSIGN_PUB.unassignedDocsTabType,
446 x_setDocAttribsTab IN OUT NOCOPY IBY_ASSIGN_PUB.setDocAttribsTabType
447 );
448
449 /*--------------------------------------------------------------------
450 | NAME:
451 | raiseBizEvents
452 |
453 | PURPOSE:
454 |
455 |
456 |
457 | PARAMETERS:
458 | IN
459 |
460 | OUT
461 |
462 |
463 | RETURNS:
464 |
465 | NOTES:
466 |
467 *---------------------------------------------------------------------*/
468 PROCEDURE raiseBizEvents(
469 p_payreq_id IN VARCHAR2,
470 p_cap_payreq_id IN VARCHAR2,
471 p_cap_id IN NUMBER
472 );
473
474 /*--------------------------------------------------------------------
475 | NAME:
476 | getXMLClob
477 |
478 | PURPOSE:
479 |
480 |
481 |
482 | PARAMETERS:
483 | IN
484 |
485 | OUT
486 |
487 |
488 | RETURNS:
489 |
490 | NOTES:
491 |
492 *---------------------------------------------------------------------*/
493 FUNCTION getXMLClob(
494 p_payreq_id IN VARCHAR2
495 )
496 RETURN CLOB;
497
498 END IBY_ASSIGN_PUB;