[Home] [Help]
PACKAGE: APPS.PAY_PPMV4_SS
Source
1 package pay_ppmv4_ss AUTHID CURRENT_USER as
2 /* $Header: pyppmwrs.pkh 120.5 2011/11/11 08:58:34 panumala ship $ */
3 ---------------------------------------------------------------------------
4 ---------------------------------- CONSTANTS ------------------------------
5 ---------------------------------------------------------------------------
6 C_COMMA constant varchar2(4) default ',';
7 --
8 -- Amount Type Codes.
9 --
10 C_PERCENTAGE constant varchar2(64)
11 default pay_pss_tx_steps_pkg.C_PERCENTAGE;
12 C_MONETARY constant varchar2(64)
13 default pay_pss_tx_steps_pkg.C_MONETARY;
14 C_REMAINING_PAY constant varchar2(64)
15 default pay_pss_tx_steps_pkg.C_REMAINING_PAY;
16 --
17 -- Amount Type Combinations.
18 --
19 C_PERCENTAGE_ONLY constant varchar2(64) default 'PERCENTAGE_ONLY';
20 C_EITHER_AMOUNT constant varchar2(64) default 'EITHER_AMOUNT';
21 C_MONETARY_ONLY constant varchar2(64) default 'MONETARY_ONLY';
22 --
23 -- Payment Method tables.
24 --
25 C_PAY_PERSONAL_PAYMENT_METHODS constant varchar2(2000)
26 default pay_pss_tx_steps_pkg.C_PAY_PERSONAL_PAYMENT_METHODS;
27 --
28 -- Transaction entry states.
29 --
30 C_STATE_NEW constant varchar2(64)
31 default pay_pss_tx_steps_pkg.C_STATE_NEW;
32 C_STATE_FREED constant varchar2(64)
33 default pay_pss_tx_steps_pkg.C_STATE_FREED;
34 C_STATE_EXISTING constant varchar2(64)
35 default pay_pss_tx_steps_pkg.C_STATE_EXISTING;
36 C_STATE_DELETED constant varchar2(64)
37 default pay_pss_tx_steps_pkg.C_STATE_DELETED;
38 C_STATE_UPDATED constant varchar2(64)
39 default pay_pss_tx_steps_pkg.C_STATE_UPDATED;
40 --
41 -- Payment Type Codes.
42 --
43 C_CASH constant varchar2(2000) default pay_pss_tx_steps_pkg.C_CASH;
44 C_CHECK constant varchar2(2000) default pay_pss_tx_steps_pkg.C_CHECK;
45 C_DEPOSIT constant varchar2(2000) default pay_pss_tx_steps_pkg.C_DEPOSIT;
46 --
47 -- Payment Type Combinations.
48 --
49 C_CASH_ONLY constant varchar2(64) default 'CASH_ONLY';
50 C_CHECK_ONLY constant varchar2(64) default 'CHECK_ONLY';
51 C_DEPOSIT_ONLY constant varchar2(64) default 'DEPOSIT_ONLY';
52 C_CASH_AND_CHECK constant varchar2(64) default 'CASH_AND_CHECK';
53 C_CASH_AND_DEPOSIT constant varchar2(64) default 'CASH_AND_DEPOSIT';
54 C_CHECK_AND_DEPOSIT constant varchar2(64) default 'CHECK_AND_DEPOSIT';
55 C_ALL constant varchar2(64) default 'ALL';
56 --
57 -- Configuration options.
58 --
59 C_BRANCH_VALIDATION constant varchar2(64) default 'C_BRANCH_VALIDATION';
60 C_CURRENT_ASSIGNMENT_ID constant varchar2(64) default 'P_ASSIGNMENT_ID';
61 C_CASH_LIST constant varchar2(64) default 'CASH_LIST';
62 C_CHECK_LIST constant varchar2(64) default 'CHECK_LIST';
63 C_DEPOSIT_LIST constant varchar2(64) default 'DEPOSIT_LIST';
64 C_EFFECTIVE_DATE constant varchar2(64) default 'P_EFFECTIVE_DATE';
65 C_MAXIMUM_PAYMENT_METHODS constant varchar2(64) default 'MAXIMUM_PAYMENT_METHODS';
66 C_OBSCURE_ACCOUNT_NUMBER constant varchar2(64) default 'OBSCURE_ACCOUNT_NUMBER';
67 C_PERMITTED_AMOUNT_TYPES constant varchar2(64) default 'PERMITTED_AMOUNT_TYPES';
68 C_PERMITTED_PAYMENT_TYPES constant varchar2(64) default 'PERMITTED_PAYMENT_TYPES';
69 C_CURRENT_PERSON_ID constant varchar2(64) default 'CURRENT_PERSON_ID';
70 C_SUMMARY_BANK_DETAILS constant varchar2(64) default 'SUMMARY_BANK_DETAILS';
71 C_VIEW_ONLY constant varchar2(64) default 'VIEW_ONLY';
72 --
73 -- Configuration NULL value.
74 --
75 C_CONFIG_NULL constant varchar2(64) default 'NULL';
76 --
77 C_MAX_PAYMENT_METHODS constant number default 10;
78 C_MIN_PAYMENT_METHODS constant number default 1;
79 C_DEFAULT_PAYMENT_METHODS constant number default 5;
80 --
81 C_LIST_SEPARATOR constant varchar2(64) default '|';
82 --
83 -- Page labels.
84 --
85 C_SUMMARY_PAGE constant varchar2(64) default 'SUMMARY';
86 C_REVIEW_PAGE constant varchar2(64) default 'REVIEW';
87 --
88 -- Workflow item attributes for Payments self-service.
89 --
90 C_PSS_TXID_WF_ATTRIBUTE constant varchar2(64) default
91 'PAY_PSS_TRANSACTION_ID';
92 C_BUS_GROUP_ID_WF_ATTR constant varchar2(64) default
93 'PAY_PSS_BUS_GROUP_ID';
94 C_BRANCH_CODE_CHK_WF_ATTR constant varchar2(64) default
95 'PAY_PSS_BRANCH_CODE_CHK';
96 C_LEG_CODE_WF_ATTR constant varchar2(64) default
97 'PAY_PSS_LEG_CODE';
98 C_ID_FLEX_NUM_WF_ATTR constant varchar2(64) default
99 'PAY_PSS_ID_FLEX_NUM';
100 C_FLEX_STRUCT_CODE_WF_ATTR constant varchar2(64) default
101 'PAY_PSS_FLEX_STRUCT_CODE';
102 C_DEF_PAYMENT_TYPE_WF_ATTR constant varchar2(64) default
103 'PAY_PSS_DEFAULT_PAYMENT_TYPE';
104 C_PRENOTE_REQUIRED_WF_ATTR constant varchar2(64) default
105 'PAY_PSS_PRENOTE_REQUIRED';
106 C_USE_CHECK_WF_ATTR constant varchar2(64) default
107 'PAY_PSS_USE_CHECK';
108 C_VIEW_ONLY_WF_ATTR constant varchar2(64) default
109 'PAY_PSS_VIEW_ONLY';
110 C_PAYMENT_TYPES_WF_ATTR constant varchar2(64) default
111 'PAY_PSS_PAYMENT_TYPES';
112 C_AMOUNT_TYPES_WF_ATTR constant varchar2(64) default
113 'PAY_PSS_AMOUNT_TYPES';
114 C_MAX_PAY_METHODS_WF_ATTR constant varchar2(64) default
115 'PAY_PSS_MAX_PAY_METHODS';
116 C_CA_OPM_ID_WF_ATTR constant varchar2(64) default
117 'PAY_PSS_CA_OPM_ID';
118 C_CH_OPM_ID_WF_ATTR constant varchar2(64) default
119 'PAY_PSS_CH_OPM_ID';
120 C_MT_OPM_ID_WF_ATTR constant varchar2(64) default
121 'PAY_PSS_MT_OPM_ID';
122 C_PREPAYMENTS_WF_ATTR constant varchar2(64) default
123 'PAY_PSS_PREPAYMENTS';
124 --
125 -- Flags to for different stages of getting the configuration.
126 --
127 C_GOT_CONFIG1_WF_ATTR constant varchar2(64) default
128 'PAY_PSS_GOT_CONFIG1';
129 C_GOT_CONFIG2_WF_ATTR constant varchar2(64) default
130 'PAY_PSS_GOT_CONFIG2';
131
132 --
133 --Foriegn Account Enhancement Variables
134 --
135
136 C_FACCT_ALWD_WF_ATTR constant varchar2(64) default 'PAY_PSS_FACCT_ALWD';
137 C_FAA_CH_OPMID_LST_WF_ATTR constant varchar2(64) default 'PAY_PSS_FAA_CH_OPMID_LST';
138 C_FAA_CA_OPMID_LST_WF_ATTR constant varchar2(64) default 'PAY_PSS_FAA_CA_OPMID_LST';
139 C_FAA_MT_OPMID_LST_WF_ATTR constant varchar2(64) default 'PAY_PSS_FAA_MT_OPMID_LST';
140 C_PAYROLL_ID constant varchar2(64) default 'PAY_PSS_PAYROLL_ID';
141 C_YES constant varchar2(64) default 'Y';
142 C_NO constant varchar2(64) default 'N';
143
144 --
145 -- HR transaction tables TRANSACTION_ID.
146 --
147 C_HR_TXID_WF_ATTRIBUTE constant varchar2(64) default 'TRANSACTION_ID';
148 ---------------------------------------------------------------------------
149 -------------------------------- DATA TYPES -------------------------------
150 ---------------------------------------------------------------------------
151 type t_number_tbl is table of number index by binary_integer;
152 ---------------------------------------------------------------------------
153 ----------------------- FUNCTIONS AND PROCEDURES --------------------------
154 ---------------------------------------------------------------------------
155 ------------------------------< include_in_page >--------------------------
156 --
157 -- {Start Of Comments}
158 --
159 -- Description:
160 -- Called at the end of an operation such as DELETE or SORT-BY-PRIORITY
161 -- to update the Remaining Pay PPM, if necessary. This is necessary when
162 -- the Remaining Pay PPM is deleted or is moved up the priority order.
163 --
164 -- Prerequisites:
165 -- None.
166 --
167 -- Post Success:
168 -- 'Y' if the PPM should be included in the page.
169 -- 'N' if the PPM should not be included in the page.
170 --
171 -- Post Failure:
172 -- Should not occur.
173 --
174 -- Access Status:
175 -- Internal Development Use Only.
176 --
177 -- {End Of Comments}
178 --
179 function include_in_page
180 (p_page in varchar2
181 ,p_state in varchar2
182 ) return varchar2;
183 ----------------------------< post_submit_work >----------------------------
184 --
185 -- {Start Of Comments}
186 --
187 -- Description:
188 -- Carries out additional updates after the user has clicked Continue
189 -- on the Summary Page. The updates in question are:
190 -- * Update the HR Transaction Tables.
191 -- * Update the real priority values for the user's changes.
192 -- These updates are not performed if no changes have been made.
193 --
194 -- Prerequisites:
195 -- None.
196 --
197 -- Post Success:
198 -- p_return_status = FND_MSG_PUB.G_RET_STS_SUCCESS
199 -- A new lowest priority PPM is updated to become the Remaining Pay PPM.
200 --
201 -- Post Failure:
202 -- p_return_status <> FND_MSG_PUB.G_RET_STS_SUCCESS
203 -- p_msg_count > 0
204 -- p_msg_data contains error information
205 --
206 -- Access Status:
207 -- Internal Development Use Only.
208 --
209 -- {End Of Comments}
210 --
211 procedure post_submit_work
212 (p_item_type in varchar2
213 ,p_item_key in varchar2
214 ,p_activity_id in varchar2
215 ,p_login_person_id in varchar2
216 ,p_transaction_id in varchar2
217 ,p_assignment_id in varchar2
218 ,p_effective_date in varchar2
219 ,p_return_status out nocopy varchar2
220 ,p_msg_count out nocopy number
221 ,p_msg_data out nocopy varchar2
222 );
223 ------------------------< update_remaining_pay_ppm >-----------------------
224 --
225 -- {Start Of Comments}
226 --
227 -- Description:
228 -- Called at the end of an operation such as DELETE or SORT-BY-PRIORITY
229 -- to update the Remaining Pay PPM, if necessary. This is necessary when
230 -- the Remaining Pay PPM is deleted or is moved up the priority order.
231 --
232 -- Prerequisites:
233 -- None.
234 --
235 -- Post Success:
236 -- A new lowest priority PPM is updated to become the Remaining Pay PPM.
237 --
238 -- Post Failure:
239 -- An exception is raised.
240 --
241 -- Access Status:
242 -- Internal Development Use Only.
243 --
244 -- {End Of Comments}
245 --
246 procedure update_remaining_pay_ppm
247 (p_transaction_id in number
248 );
249 ----------------------------------< db2tts >-------------------------------
250 --
251 -- {Start Of Comments}
252 --
253 -- Description:
254 -- Reads the user's existing PPMs and creates transaction table
255 -- entries for them. db2tts is only called once per for each
256 -- payments self-service session.
257 --
258 -- Prerequisites:
259 -- Assumes that the user has no future-dated PPM changes and that
260 -- the user's PPMs are consistent with the Amount Type configuration
261 -- (P_AMOUNT_TYPE).
262 --
263 -- Post Success:
264 -- p_return_status = FND_MSG_PUB.G_RET_STS_SUCCESS
265 --
266 -- The transaction tables are populated with values from the user's
267 -- existing PPMs.
268 -- P_PREPAYMENTS:
269 -- Y - there are future-dated prepayments.
270 -- N - there are no future-dated prepayments.
271 -- P_TRANSACTION_ID:
272 -- The transaction_id to be used in view object queries.
273 --
274 -- Post Failure:
275 -- p_return_status <> FND_MSG_PUB.G_RET_STS_SUCCESS
276 -- p_msg_count > 0
277 -- p_msg_data contains error information
278 --
279 -- The transaction tables are not affected.
280 --
281 -- Access Status:
282 -- Internal Development Use Only.
283 --
284 -- {End Of Comments}
285 --
286 procedure db2tts
287 (p_assignment_id in varchar2
288 ,p_effective_date in varchar2
289 ,p_amount_type in varchar2
290 ,p_item_type in varchar2 default null
291 ,p_item_key in varchar2 default null
292 ,p_run_type_id in varchar2 default null
293 ,p_transaction_id out nocopy varchar2
294 ,p_prepayments out nocopy varchar2
295 ,p_return_status out nocopy varchar2
296 ,p_msg_count out nocopy number
297 ,p_msg_data out nocopy varchar2
298 );
299 ---------------------------------< getconfig >-----------------------------
300 --
301 -- {Start Of Comments}
302 --
303 -- Description:
304 -- Reads and validates the PSS configuration. Also, checks that the
305 -- configuration options are consistent with the employees's PPMs.
306 --
307 -- This routine must be called before any other PLSQL code.
308 --
309 -- Prerequisites:
310 -- The calling code is executing within the context of a workflow.
311 --
312 -- Post Success:
313 -- p_return_status = FND_MSG_PUB.G_RET_STS_SUCCESS
314 --
315 -- The configuration values are returned in the OUT parameters.
316 -- P_VIEW_ONLY:
317 -- Y - view only.
318 -- N - editing is allowed.
319 -- P_PAYMENT_TYPES:
320 -- C_CASH_ONLY
321 -- C_CHECK_ONLY
322 -- C_DEPOSIT_ONLY
323 -- C_CASH_AND_CHECK
324 -- C_CASH_AND_DEPOSIT
325 -- C_CHECK_AND_DEPOSIT
326 -- C_ALL
327 -- P_AMOUNT_TYPE:
328 -- C_PERCENTAGE_ONLY
329 -- C_MONETARY_ONLY
330 -- C_EITHER_AMOUNT
331 -- P_PRENOTE_REQUIRED:
332 -- Y - prenotification is required on the payroll.
333 -- N - prenotification is not required on the payroll.
334 -- P_USE_CHECK:
335 -- Y - Use US spelling "Check" instead of "Cheque".
336 --
337 -- Post Failure:
338 -- p_return_status <> FND_MSG_PUB.G_RET_STS_SUCCESS
339 -- p_msg_count > 0
340 -- p_msg_data contains error information
341 --
342 -- Access Status:
343 -- Internal Development Use Only.
344 --
345 -- {End Of Comments}
346 --
347 procedure getconfig
348 (p_item_type in varchar2
349 ,p_item_key in varchar2
350 ,p_activity_id in varchar2
351 ,p_person_id in varchar2
352 ,p_assignment_id in varchar2
353 ,p_effective_date in varchar2
354 ,p_run_type_id in varchar2 default null
355 ,p_business_group_id out nocopy varchar2
356 ,p_territory_code out nocopy varchar2
357 ,p_id_flex_num out nocopy varchar2
358 ,p_flex_struct_code out nocopy varchar2
359 ,p_default_payment_type out nocopy varchar2
360 ,p_prenote_required out nocopy varchar2
361 ,p_use_check out nocopy varchar2
362 ,p_view_only out nocopy varchar2
363 ,p_payment_types out nocopy varchar2
364 ,p_amount_types out nocopy varchar2
365 ,p_max_pay_methods out nocopy varchar2
366 ,p_cash_opmid out nocopy varchar2
367 ,p_check_opmid out nocopy varchar2
368 ,p_deposit_opmid out nocopy varchar2
369 ,p_obscure_prompt out nocopy varchar2
370 ,p_obscure_digits out nocopy varchar2
371 ,p_obscure_char out nocopy varchar2
372 ,p_return_status out nocopy varchar2
373 ,p_msg_count out nocopy number
374 ,p_msg_data out nocopy varchar2
375 ,p_branch_validation out nocopy varchar2
376 ,p_show_paymthd_lov out nocopy varchar2
377 ,p_faa_ch_opmid_list out nocopy varchar2
378 ,p_faa_ca_opmid_list out nocopy varchar2
379 ,p_faa_mt_opmid_list out nocopy varchar2
380 ,p_payroll_id out nocopy varchar2
381 );
382 --------------------------------< gettxstepids >---------------------------
383 --
384 -- {Start Of Comments}
385 --
386 -- Description:
387 -- Returns a comma-separated list of transaction_step_ids for PPMs
388 -- according to a flag.
389 -- P_SUMMARY_PAGE:
390 -- TRUE - get the transaction_step_ids for PPMs to be displayed on
391 -- the Summary Page. The list is ordered by logical_priority.
392 -- P_REVIEW_PAGE:
393 -- TRUE - get the transaction_step_ids for PPMs to be displayed on
394 -- the Review (and Confirmation) Page. The list is ordered
395 -- by logical priority for non-deleted PPMs.
396 -- P_FREED:
400 -- One (and only one) of these flags must be set to TRUE.
397 -- TRUE - get the transaction_step_ids for freed PPMs i.e. PPMs that
398 -- correspond to newly created PPMs that are subsequently
399 -- deleted.
401 --
402 -- Prerequisites:
403 -- None.
404 --
405 -- Post Success:
406 -- The transaction_step_id list is returned (it's NULL if there are
407 -- no transaction_step_ids).
408 --
409 -- Post Failure:
410 -- An exception is raised.
411 --
412 -- Access Status:
413 -- Internal Development Use Only.
414 --
415 -- {End Of Comments}
416 --
417 function gettxstepids
418 (p_transaction_id in varchar2
419 ,p_review_page in boolean default false
420 ,p_summary_page in boolean default false
421 ,p_freed in boolean default false
422 ) return varchar2;
423 -----------------------------< alloc_real_priorities >---------------------
424 --
425 -- {Start Of Comments}
426 --
427 -- Description:
428 -- Allocates real priorities to the PPMs that would exist if the user's
429 -- changes were committed.
430 --
431 -- Prerequisites:
432 -- None.
433 --
434 -- Post Success:
435 -- p_success is set to true.
436 -- The transaction table entries are updated with the new real priority
437 -- values.
438 --
439 -- Post Failure:
440 -- p_success is set to false.
441 -- An exception is raised if there was an unhandled exception.
442 --
443 -- Access Status:
444 -- Internal Development Use Only.
445 --
446 -- {End Of Comments}
447 --
448 procedure alloc_real_priorities
449 (p_transaction_id in varchar2
450 ,p_assignment_id in varchar2
451 ,p_effective_date in varchar2
452 ,p_success out nocopy boolean
453 );
454 ----------------------------< update_logical_priority >--------------------
455 --
456 -- {Start Of Comments}
457 --
458 -- Description:
459 -- Updates a transaction table entry with a new logical priority value.
460 -- Does any necessary update of state. p_logical_priority is set
461 -- internally - it has a valid value.
462 --
463 -- Prerequisites:
464 -- None.
465 --
466 -- Post Success:
467 -- The transaction table entry is updated with the new logical priority
468 -- value.
469 --
470 -- Post Failure:
471 -- An exception is raised.
472 --
473 -- Access Status:
474 -- Internal Development Use Only.
475 --
476 -- {End Of Comments}
477 --
478 procedure update_logical_priority
479 (p_transaction_step_id in varchar2
480 ,p_logical_priority in varchar2
481 ,p_amount_type in varchar2
482 );
483 ----------------------------------< enter_ppm >----------------------------
484 --
485 -- {Start Of Comments}
486 --
487 -- Description:
488 -- Handles validation of user changes and saving of the transaction data
489 -- when a PPM is created or updated.
490 --
491 -- Prerequisites:
492 -- None.
493 --
494 -- Post Success:
495 -- P_USER_ERROR:
496 -- Y - the validation of the user's changes revealed errors.
497 -- N - the user's changed were okay and the transaction data was saved.
498 --
499 -- Post Failure:
500 -- An exception is raised.
501 --
502 -- Access Status:
503 -- Internal Development Use Only.
504 --
505 -- {End Of Comments}
506 --
507 procedure enter_ppm
508 (p_transaction_id in varchar2
509 ,p_transaction_step_id in out nocopy varchar2
510 ,p_source_table in varchar2
511 default pay_pss_tx_steps_pkg.C_PAY_PERSONAL_PAYMENT_METHODS
512 ,p_assignment_id in varchar2
513 ,p_payment_type in varchar2
514 ,p_currency_code in varchar2
515 ,p_org_payment_method_id in varchar2
516 ,p_territory_code in varchar2
517 ,p_effective_date in varchar2
518 ,p_amount_type in varchar2
519 ,p_amount in number
520 ,p_external_account_id in number default null
521 ,p_attribute_category in varchar2 default null
522 ,p_attribute1 in varchar2 default null
523 ,p_attribute2 in varchar2 default null
524 ,p_attribute3 in varchar2 default null
525 ,p_attribute4 in varchar2 default null
526 ,p_attribute5 in varchar2 default null
527 ,p_attribute6 in varchar2 default null
528 ,p_attribute7 in varchar2 default null
529 ,p_attribute8 in varchar2 default null
530 ,p_attribute9 in varchar2 default null
531 ,p_attribute10 in varchar2 default null
532 ,p_attribute11 in varchar2 default null
533 ,p_attribute12 in varchar2 default null
534 ,p_attribute13 in varchar2 default null
535 ,p_attribute14 in varchar2 default null
536 ,p_attribute15 in varchar2 default null
537 ,p_attribute16 in varchar2 default null
538 ,p_attribute17 in varchar2 default null
539 ,p_attribute18 in varchar2 default null
540 ,p_attribute19 in varchar2 default null
541 ,p_attribute20 in varchar2 default null
545 ,p_ppm_information2 in varchar2 default null
542 ,p_run_type_id in varchar2 default null
543 ,p_ppm_information_category in varchar2 default null
544 ,p_ppm_information1 in varchar2 default null
546 ,p_ppm_information3 in varchar2 default null
547 ,p_ppm_information4 in varchar2 default null
548 ,p_ppm_information5 in varchar2 default null
549 ,p_ppm_information6 in varchar2 default null
550 ,p_ppm_information7 in varchar2 default null
551 ,p_ppm_information8 in varchar2 default null
552 ,p_ppm_information9 in varchar2 default null
553 ,p_ppm_information10 in varchar2 default null
554 ,p_ppm_information11 in varchar2 default null
555 ,p_ppm_information12 in varchar2 default null
556 ,p_ppm_information13 in varchar2 default null
557 ,p_ppm_information14 in varchar2 default null
558 ,p_ppm_information15 in varchar2 default null
559 ,p_ppm_information16 in varchar2 default null
560 ,p_ppm_information17 in varchar2 default null
561 ,p_ppm_information18 in varchar2 default null
562 ,p_ppm_information19 in varchar2 default null
563 ,p_ppm_information20 in varchar2 default null
564 ,p_ppm_information21 in varchar2 default null
565 ,p_ppm_information22 in varchar2 default null
566 ,p_ppm_information23 in varchar2 default null
567 ,p_ppm_information24 in varchar2 default null
568 ,p_ppm_information25 in varchar2 default null
569 ,p_ppm_information26 in varchar2 default null
570 ,p_ppm_information27 in varchar2 default null
571 ,p_ppm_information28 in varchar2 default null
572 ,p_ppm_information29 in varchar2 default null
573 ,p_ppm_information30 in varchar2 default null
574 ,p_return_status out nocopy varchar2
575 ,p_msg_count out nocopy number
576 ,p_msg_data out nocopy varchar2
577 );
578 ---------------------------------< delete_ppm >----------------------------
579 --
580 -- {Start Of Comments}
581 --
582 -- Description:
583 -- Updates transaction tables following delete of a PPM.
584 --
585 -- Prerequisites:
586 -- None.
587 --
588 -- Post Success:
589 -- The transaction tables are updated.
590 --
591 -- Post Failure:
592 -- An exception is raised.
593 --
594 -- Access Status:
595 -- Internal Development Use Only.
596 --
597 -- {End Of Comments}
598 --
599 procedure delete_ppm
600 (p_transaction_step_id in varchar2
601 ,p_return_status out nocopy varchar2
602 ,p_msg_count out nocopy number
603 ,p_msg_data out nocopy varchar2
604 );
605 --------------------------------< process_api >----------------------------
606 --
607 -- {Start Of Comments}
608 --
609 -- Description:
610 -- Reads transaction tables and makes the Personal Payment Methods API
611 -- call.
612 --
613 -- Prerequisites:
614 -- The HR and Payments self-service tables must be set up correctly.
615 --
616 -- Post Success:
617 -- The API call is successfully made.
618 --
619 -- Post Failure:
620 -- An exception is raised.
621 --
622 -- Access Status:
623 -- Internal Development Use Only.
624 --
625 -- {End Of Comments}
626 --
627 procedure process_api
628 (p_transaction_step_id in number
629 ,p_validate in boolean default false
630 );
631 ------------------------< delete_pss_transactions >----------------------
632 --
633 -- {Start Of Comments}
634 --
635 -- Description:
636 -- Deletes all Payments self-service transaction steps whose transaction_id
637 -- is stored in the workflow attribute C_PSS_TXID_WF_ATTRIBUTE.
638 --
639 -- Prerequisites:
640 -- The workflow attribute, C_PSS_TXID_WF_ATTRIBUTE, must contain
641 -- the value of a valid transaction_id.
642 --
643 -- Post Success:
644 -- The transaction steps are deleted.
645 --
646 -- Post Failure:
647 -- An exception is raised.
648 --
649 -- Access Status:
650 -- Internal Development Use Only.
651 --
652 -- {End Of Comments}
653 --
654 procedure delete_ppm_transactions
655 (item_type in varchar2
656 ,item_key in varchar2
657 ,actid in number
658 ,funmode in varchar2
659 ,result out nocopy varchar2
660 );
661 -------------------------< resequence_priorities >-----------------------
662 --
663 -- {Start Of Comments}
664 --
665 -- Description:
666 -- 17-OCT-2001 This function call has been obsoleted now. Its
667 -- functionality has been moved to a more appropriate place within the
668 -- API processing. It is retained to avoid changing the workflow
669 -- definition.
670 --
671 -- This is effectively a stub function.
672 --
673 -- Prerequisites:
674 -- None.
675 --
676 -- Post Success:
677 -- Always returns success.
678 --
679 -- Post Failure:
680 --
681 -- Access Status:
682 -- Internal Development Use Only.
683 --
684 -- {End Of Comments}
685 --
686 procedure resequence_priorities
687 (item_type in varchar2
688 ,item_key in varchar2
689 ,actid in number
690 ,funmode in varchar2
691 ,result out nocopy varchar2
692 );
693
694 -------------------------< get_ppm_country >-----------------------
695 --
696 -- {Start Of Comments}
697 --
698 -- Description:
699 -- 11-12-2006 This function gets the Country associated with the PPM
700 --
701 --
702 -- Prerequisites:
703 -- None.
704 --
705 -- Post Success:
706 -- Always returns the Terirory code associated with the PPM
707 --
708 -- Post Failure:
709 --
710 -- Access Status:
711 -- Internal Development Use Only.
712 --
713 -- {End Of Comments}
714 --
715 function get_ppm_country
716 (p_org_payment_method_id IN number,
717 p_business_group_id IN number,
718 p_return_desc IN VARCHAR2 default 'N'
719
720 )return varchar2;
721
722
723 -------------------------< get_bank_flexcode >-----------------------
724 --
725 -- {Start Of Comments}
726 --
727 -- Description:
728 -- 11-12-2006 This function gets the Bank Flex Structure Code
729 -- for country with the Payment Type Country if it is Non Generic
730 -- Payment Types and BG County for Generic Payment Types.
731 --
732 --
733 -- Prerequisites:
734 -- None.
735 --
736 -- Post Success:
737 -- Always returns the required Bank Flex Structure Code.
738 --
739 -- Post Failure:
740 --
741 -- Access Status:
742 -- Internal Development Use Only.
743 --
744 -- {End Of Comments}
745 --
746 function get_bank_flexcode
747 (p_org_payment_method_id IN number,
748 p_business_group_id IN number
749 )return varchar2;
750
751 -------------------------< get_org_method_name >-----------------------
752 --
753 -- {Start Of Comments}
754 --
755 -- Description:
756 -- 11-12-2006 This function gets the ORG Payment Method Name
757 --
758 --
759 -- Prerequisites:
760 -- None.
761 --
762 -- Post Success:
763 -- Always returns Organization Payment Method Name.
764 --
765 -- Post Failure:
766 --
767 -- Access Status:
768 -- Internal Development Use Only.
769 --
770 -- {End Of Comments}
771 --
772 function get_org_method_name
773 (p_org_payment_method_id IN number,
774 p_business_group_id IN number
775 )return varchar2;
776
777 function is_foreign_transaction(
778 p_opm_id in number, p_effective_date DATE) return varchar;
779 function get_payment_type_name(p_opm_id number,
780 p_effective_date date) RETURN varchar2;
781 procedure store_session(p_effective_date DATE);
782
783 -------------------------------< check_future_payments >-------------------------
784 -- Description :
785 -- 09-11-2011 This function returns 'Y' if future payments exist
786 --
787 function check_future_payments (p_assignment_id number ,p_effective_date_str varchar2,p_run_type_id varchar2 ) return char ;
788
789 end pay_ppmv4_ss;