[Home] [Help]
PACKAGE: APPS.PAY_US_INV_DED_FORMULAS
Source
1 PACKAGE PAY_US_INV_DED_FORMULAS as
2 /* $Header: pyusgrfm.pkh 120.9.12010000.2 2008/09/23 03:50:30 sudedas ship $ */
3 /*
4 ******************************************************************
5 * *
6 * Copyright (C) 1993 Oracle Corporation. *
7 * All rights reserved. *
8 * *
9 * This material has been provided pursuant to an agreement *
10 * containing restrictions on its use. The material is also *
11 * protected by copyright law. No part of this material may *
12 * be copied or distributed, transmitted or transcribed, in *
13 * any form or by any means, electronic, mechanical, magnetic, *
14 * manual, or otherwise, or disclosed to third parties without *
15 * the express written permission of Oracle Corporation, *
16 * 500 Oracle Parkway, Redwood City, CA, 94065. *
17 * *
18 ******************************************************************
19
20 Name : pay_us_inv_ded_formulas
21
22 Description : This package is used by fast formulas of involuntary
23 deduction elements to calculate deduction amounts. Different
24 functions cater to different categories of involuntary
25 deduction.
26
27 Change List
28 -----------
29 Date Name Vers Bug No Description
30 ----------- ---------- ------ ------- -------------------------------
31 23-APR-2004 sdahiya 115.0 Created.
32 14-MAY-2004 sdahiya 115.1 2658290, - Added parameters to base_formula and
33 2992741 cal_formula_bo.
34 - Added global PL/SQL table arrears_tab.
35 - Global variables in replacement of
36 input values modified to be PL/SQL tables
37 instead of scalar variables.
38 01-JUN-2004 sdahiya 115.2 3549207 - Removed VOLDEDNS_AT_WRIT and VOL_DEDNS_ASG_GRE_LTD
39 parameters from BASE_FORMULA.
40 30-JUN-2004 kvsankar 115.3 Added a new global element GLB_NUM_ELEM
41 08-JUL-2004 kvsankar 115.4 3749162 Added a new procedure RESET_GLOBAL_VAR
42 09-DEC-2004 kvsankar 115.5 3650283 Added paramters to BASE_FORMULA
43 and CAL_FORMULA_BO for DCIA category.
44 03-JAN-2005 kvsankar 115.6 4079142.. Added the following global variables
45 for DCIA.
46 i. GLB_SUPPORT_DI
47 ii. GLB_OTHER_DI_FLAG
48 iii. GLB_DCIA_EXIST_FLAG
49 03-FEB-2005 kvsankar 115.7 Added a new function GET_CCPA_PROTECTION
50 which calculates the ccpa_protection
51 value.
52 18-FEB-2005 kvsankar 115.8 4154950 Modified the BASE_FORMULA declaration
53 to use _ASG dimension instead of _ASG_GRE
54 becuase of the the Bug fix made to the
55 'BALANCE_SETUP_FORMULA' for all categories.
56 The following are the parameters modified: -
57 i. ACCRUED_ASG_GRE_LTD
58 ii. ACCRUED_FEES_ASG_GRE_LTD
59 iii. ASG_GRE_MONTH
60 iv. ASG_GRE_PTD
61 03-MAR-2004 kvsankar 115.9 4104842 Added a new Global variable
62 GLB_TL_GROSS_EARNINGS.
63 24-AUG-2005 kvsankar 115.10 3528349 Modified the function GET_TABLE_VALUE
64 to include a new parameter.
65 16-DEC-2005 kvsankar 115.11 4748532 Added two new Global tables
66 Added a new parameter 'FEES_ASG_GRE_PTD'
67 to the BASE_FORMULA
68 20-DEC-2005 kvsankar 115.12 4748532 Added aa new Global table
69 actual_dedn_tab
70 06-JAN-2006 kvsankar 115.13 4858720 Added a new parameter 'EIC_ADVANCE_ASG_GRE_RUN'
71 to
72 * CAL_FORMULA_BO
73 * CAL_FORMULA_SS
74 * CAL_FORMULA_TL
75 17-Mar-2006 kvsankar 115.14 5095823 Added a new Global variable
76 GLB_TOTAL_WHLD_FEE_ASG_GRE_RUN
77 to sum up the Support Fees
78 07-APR-2006 kvsankar 115.15 4858720 Added a new parameter 'EIC_ADVANCE_ASG_GRE_RUN'
79 to BASE_FORMULA
80 12-APR-2006 kvsankar 115.16 5149450 Added a new global variable
81 'GLB_AMT_NOT_SPEC'
82 11-Jul-2006 sudedas 115.17 5295813 Added Global Table mod_dedn_tab.
83 06-Aug-2006 sudedas 115.18 4676867 Added new parameters VOL_DEDN_ROTH_ASG_GRE_RUN,
84 VOL_DEDN_SB_TX_ASG_GRE_RUN and
85 VOL_DEDN_SB_TX_JD_ASG_GRE_RUN to
86 BASE_FORMULA, CAL_FORMULA_SS, CAL_FORMULA_BO
87 19-Sep-2008 sudedas 115.19 6818016 Base_Formula and Cal_Formula_BO modified to pass
88 2 parameters NET_ASG_RUN and NET_ASG_PTD.
89 *****************************************************************************/
90
91 /****************************************************************************
92 Name : BASE_FORMULA
93 Description : This function calculates deduction amount and fees claimed by
94 each involuntary deduction element. It also initializes input
95 values of calculator element. these input values are later sent
96 as indirect inputs.
97 *****************************************************************************/
98
99 FUNCTION BASE_FORMULA(
100 P_CTX_DATE_EARNED date,
101 P_CTX_ELEMENT_ENTRY_ID number,
102 P_CTX_JURISDICTION_CODE varchar2,
103 P_CTX_ORIGINAL_ENTRY_ID number,
104 ADDITIONAL_ASG_GRE_LTD IN OUT NOCOPY number,
105 REPLACEMENT_ASG_GRE_LTD IN OUT NOCOPY number,
106 ACCRUED_ASG_LTD IN OUT NOCOPY number,
107 ACCRUED_FEES_ASG_LTD number,
108 FEES_ENTRY_PTD IN OUT NOCOPY number,
109 FEES_ENTRY_ITD IN OUT NOCOPY number,
110 FEES_ENTRY_MONTH IN OUT NOCOPY number,
111 ASG_MONTH number,
112 ASG_PTD number,
113 /*VOL_DEDNS_ASG_GRE_LTD number,*/
114 VOL_DED_ASG_GRE_LASTRUN number,
115 PRE_TAX_DED_ASG_GRE_LASTRUN number,
116 ASG_WORK_AT_HOME varchar2,
117 OVERRIDE_PER_ADR_REGION_2 varchar2,
118 OVERRIDE_PER_ADR_REGION_1 varchar2,
119 OVERRIDE_PER_ADR_CITY varchar2,
120 OVERRIDE_PER_ADR_POSTAL_CODE varchar2,
121 OVERRIDE_LOC_ADR_REGION_2 varchar2,
122 OVERRIDE_LOC_ADR_REGION_1 varchar2,
123 OVERRIDE_LOC_ADR_CITY varchar2,
124 OVERRIDE_LOC_ADR_POSTAL_CODE varchar2,
125 AMOUNT number,
126 JURISDICTION IN OUT NOCOPY varchar2,
127 DATE_SERVED IN OUT NOCOPY date,
128 DEDNS_AT_TIME_OF_WRIT number,
129 PAY_EARNED_END_DATE date,
130 EXEMPT_AMOUNT number,
131 ARREARS_DATE date,
132 NUM_DEPS number,
133 FIL_STAT varchar2,
134 ALLOWS number,
135 /*VOLDEDNS_AT_WRIT OUT NOCOPY number,*/
136 CALC_SUBPRIO OUT NOCOPY number,
137 REGULAR_EARNINGS_ASG_GRE_RUN number,
138 DI_SUBJ_TAX_JD_ASG_GRE_RUN number,
139 DI_SUBJ_TAX_ASG_GRE_RUN number,
140 TAX_DEDUCTIONS_ASG_GRE_RUN number,
141 PRE_TAX_DEDUCTIONS_ASG_GRE_RUN number,
142 PRE_TAX_SUBJ_TX_JD_ASG_GRE_RUN number,
143 PRE_TAX_SUBJ_TX_ASG_GRE_RUN number,
144 ARREARS_OVERRIDE number,
145 PERCENTAGE number,
146 MONTHLY_CAP_AMOUNT number,
147 PERIOD_CAP_AMOUNT number,
148 GARN_FEE_FEE_RULE varchar2,
149 GARN_FEE_FEE_AMOUNT number,
150 GARN_FEE_MAX_FEE_AMOUNT number,
151 ACCRUED_FEES number,
152 GARN_FEE_PCT_CURRENT number,
153 GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
154 TOTAL_OWED number,
155 GARN_TOTAL_FEES_ASG_GRE_RUN number,
156 GRN_DI_SUBJ_TX_ASG_GRE_RUN number,
157 GRN_DI_SUBJ_TX_JD_ASG_GRE_RUN number,
158 PR_TX_DED_SBJ_TX_ASG_GRE_RN number,
159 PR_TX_DED_SBJ_TX_JD_ASG_GRE_RN number,
160 GARN_EXEMPTION_CALC_RULE varchar2,
161 GARN_TOTAL_DEDNS_ASG_GRE_RUN number,
162 DCIA_DI_SUBJ_TX_ASG_GRE_RUN number default 0,
163 DCIA_DI_SUBJ_TX_JD_ASG_GRE_RUN number default 0,
164 PR_TX_DCIA_SB_TX_ASG_GRE_RN number default 0,
165 PR_TX_DCIA_SB_TX_JD_ASG_GRE_RN number default 0,
166 FEES_ASG_GRE_PTD number default -9999,
167 EIC_ADVANCE_ASG_GRE_RUN number default 0,
168 VOL_DEDN_ROTH_ASG_GRE_RUN number default 0,
169 VOL_DEDN_SB_TX_ASG_GRE_RUN number default 0,
170 VOL_DEDN_SB_TX_JD_ASG_GRE_RUN number default 0,
171 NET_ASG_RUN number default 0,
172 NET_ASG_PTD number default 0
173
174 ) RETURN number;
175
176 /****************************************************************************
177 Name : CAL_FORMULA_SS
178 Description : This function performs DI calculation for involuntary
179 deduction elements of type AY/CS/SS. This function also
180 distributes the deducted amount over different elements
181 according to the proration rule defined.
182 *****************************************************************************/
183
184 FUNCTION CAL_FORMULA_SS
185 (
186 P_CTX_BUSINESS_GROUP_ID number,
187 P_CTX_PAYROLL_ID number,
188 P_CTX_ELEMENT_TYPE_ID number,
189 P_CTX_ORIGINAL_ENTRY_ID number,
190 P_CTX_DATE_EARNED date,
191 P_CTX_JURISDICTION_CODE varchar2,
192 P_CTX_ELEMENT_ENTRY_ID number,
193 GARN_EXEMPTION_CALC_RULE varchar2,
194 GARN_EXMPT_DEP_CALC_RULE varchar2,
195 GARN_EXEMPTION_DI_PCT number,
196 GARN_EXMPT_DI_PCT_IN_ARR number,
197 GARN_EXMPT_DI_PCT_DEP number,
198 GARN_EXMPT_DI_PCT_DEP_IN_ARR number,
199 GARN_EXEMPTION_MIN_WAGE_FACTOR number,
200 GARN_EXEMPTION_AMOUNT_VALUE number,
201 GARN_EXMPT_DEP_AMT_VAL number,
202 GARN_EXMPT_ADDL_DEP_AMT_VAL number,
203 GARN_EXEMPTION_PRORATION_RULE varchar2,
204 GARN_FEE_FEE_RULE varchar2,
205 GARN_FEE_FEE_AMOUNT number,
206 GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
207 GARN_FEE_PCT_CURRENT number,
208 GARN_FEE_MAX_FEE_AMOUNT number,
209 PAY_EARNED_START_DATE date,
210 PAY_EARNED_END_DATE date,
211 SCL_ASG_US_WORK_SCHEDULE varchar2,
212 ASG_HOURS number,
213 ASG_FREQ varchar2,
214 REGULAR_EARNINGS_ASG_GRE_RUN number,
215 NET_ASG_GRE_RUN number,
216 DI_SUBJ_TAX_JD_ASG_GRE_RUN number,
217 PRE_TAX_DEDUCTIONS_ASG_GRE_RUN number,
218 DI_SUBJ_TAX_ASG_GRE_RUN number,
219 PRE_TAX_SUBJ_TX_ASG_GRE_RUN number,
220 PRE_TAX_SUBJ_TX_JD_ASG_GRE_RUN number,
221 TAX_DEDUCTIONS_ASG_GRE_RUN number,
222 GARN_TOTAL_FEES_ASG_GRE_RUN number,
223 JURISDICTION varchar2,
224 TOTAL_OWED number,
225 DATE_SERVED date,
226 ADDITIONAL_AMOUNT_BALANCE number,
227 REPLACEMENT_AMOUNT_BALANCE number,
228 PRIMARY_AMOUNT_BALANCE number,
229 ARREARS_AMOUNT_BALANCE number,
230 SUPPORT_OTHER_FAMILY varchar2,
231 ACCRUED_FEES number,
232 PTD_FEE_BALANCE number,
233 MONTH_FEE_BALANCE number,
234 TAX_LEVIES_ASG_GRE_RUN number,
235 TERMINATED_EMPLOYEE varchar2,
236 FINAL_PAY_PROCESSED varchar2,
237 CHILD_SUPP_COUNT_ASG_GRE_RUN number,
238 CHILD_SUPP_TOT_DED_ASG_GRE_RUN IN OUT NOCOPY number,
239 CHILD_SUPP_TOT_FEE_ASG_GRE_RUN number,
240 TOTAL_WITHHELD_FEE_ASG_GRE_RUN number,
241 TOTAL_WITHHELD_FEE_ASG_GRE_ITD number,
242 TOT_WHLD_SUPP_ASG_GRE_RUN number,
243 GARN_FEE_TAKE_FEE_ON_PRORATION varchar2,
244 ARREARS_AMT IN OUT NOCOPY number,
245 DIFF_DEDN_AMT IN OUT NOCOPY number,
246 DIFF_FEE_AMT IN OUT NOCOPY number,
247 NOT_TAKEN IN OUT NOCOPY number,
248 SF_ACCRUED_FEES IN OUT NOCOPY number,
249 STOP_ENTRY IN OUT NOCOPY varchar2,
250 TO_COUNT IN OUT NOCOPY number,
251 TO_TOTAL_OWED IN OUT NOCOPY number,
252 WH_DEDN_AMT IN OUT NOCOPY number,
253 WH_FEE_AMT IN OUT NOCOPY number,
254 FATAL_MESG IN OUT NOCOPY varchar2,
255 MESG IN OUT NOCOPY varchar2,
256 CALC_SUBPRIO OUT NOCOPY number,
257 TO_REPL OUT NOCOPY number,
258 TO_ADDL OUT NOCOPY number,
259 EIC_ADVANCE_ASG_GRE_RUN number default 0,
260 VOL_DEDN_ROTH_ASG_GRE_RUN number default 0,
261 VOL_DEDN_SB_TX_ASG_GRE_RUN number default 0,
262 VOL_DEDN_SB_TX_JD_ASG_GRE_RUN number default 0
263
264 ) RETURN number;
265
266 /****************************************************************************
267 Name : CAL_FORMULA_BO
268 Description : This function calculates amount to be withheld for BO, CD, G,
269 EL and ER categories.
270 *****************************************************************************/
271
272 FUNCTION CAL_FORMULA_BO
273 (
274 P_CTX_BUSINESS_GROUP_ID number,
275 P_CTX_PAYROLL_ID number,
276 P_CTX_ELEMENT_TYPE_ID number,
277 P_CTX_ORIGINAL_ENTRY_ID number,
278 P_CTX_DATE_EARNED date,
279 P_CTX_JURISDICTION_CODE varchar2,
280 P_CTX_ELEMENT_ENTRY_ID number,
281 GARN_EXEMPTION_CALC_RULE varchar2,
282 GRN_EXMPT_DEP_CALC_RULE varchar2,
283 GARN_EXEMPTION_DI_PCT number,
284 GARN_EXEMPTION_MIN_WAGE_FACTOR number,
285 GARN_EXEMPTION_AMOUNT_VALUE number,
286 GRN_EXMPT_DEP_AMT_VAL number,
287 GRN_EXMPT_ADDL_DEP_AMT_VAL number,
288 GARN_FEE_FEE_RULE varchar2,
289 GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
290 GARN_FEE_FEE_AMOUNT number,
291 GARN_FEE_TAKE_FEE_ON_PRORATION varchar2,
292 GARN_FEE_PCT_CURRENT number,
293 GARN_FEE_MAX_FEE_AMOUNT number,
294 PAY_EARNED_START_DATE date,
295 PAY_EARNED_END_DATE date,
296 SCL_ASG_US_WORK_SCHEDULE varchar2,
297 ASG_HOURS number,
298 STATE_MIN_WAGE number,
302 GARN_TOTAL_FEES_ASG_GRE_RUN number,
299 ASG_FREQ varchar2,
300 TERMINATED_EMPLOYEE varchar2,
301 FINAL_PAY_PROCESSED varchar2,
303 GARN_TOTAL_DEDNS_ASG_GRE_RUN number,
304 GRN_DI_SUBJ_TX_JD_ASG_GRE_RUN number,
305 GROSS_EARNINGS_ASG_GRE_MONTH number,
306 GROSS_EARNINGS_ASG_GRE_RUN number,
307 REGULAR_EARNINGS_ASG_GRE_RUN number,
308 NET_ASG_GRE_RUN number,
309 TAX_DEDUCTIONS_ASG_GRE_RUN number,
310 TAX_LEVIES_ASG_GRE_RUN number,
311 GRN_DI_SUBJ_TX_ASG_GRE_RUN number,
312 PRE_TAX_DEDUCTIONS_ASG_GRE_RUN number,
313 PR_TX_DED_SBJ_TX_JD_ASG_GRE_RN number,
314 PR_TX_DED_SBJ_TX_ASG_GRE_RN number,
315 TOT_WHLD_SUPP_ASG_GRE_RUN number,
316 TOTAL_WITHHELD_FEE_ASG_GRE_RUN number,
317 JURISDICTION varchar2,
318 TOTAL_OWED number,
319 DATE_SERVED date,
320 ADDITIONAL_AMOUNT_BALANCE number,
321 REPLACEMENT_AMOUNT_BALANCE number,
322 PRIMARY_AMOUNT_BALANCE number,
323 ACCRUED_FEES number,
324 PTD_FEE_BALANCE number,
325 MONTH_FEE_BALANCE number,
326 GARN_EXEMPTION_PRORATION_RULE varchar2,
327 CALCD_ARREARS OUT NOCOPY number,
328 CALCD_DEDN_AMT OUT NOCOPY number,
329 CALCD_FEE OUT NOCOPY number,
330 FATAL_MESG OUT NOCOPY varchar2,
331 GARN_FEE OUT NOCOPY number,
332 MESG OUT NOCOPY varchar2,
333 MESG1 OUT NOCOPY varchar2,
334 NOT_TAKEN OUT NOCOPY number,
335 SF_ACCRUED_FEES OUT NOCOPY number,
336 STOP_ENTRY OUT NOCOPY varchar2,
337 TO_ADDL OUT NOCOPY number,
338 TO_REPL OUT NOCOPY number,
339 TO_TOTAL_OWED OUT NOCOPY number,
340 calc_subprio OUT NOCOPY number,
341 DCIA_DI_SUBJ_TX_ASG_GRE_RUN number default 0,
342 DCIA_DI_SUBJ_TX_JD_ASG_GRE_RUN number default 0,
343 PR_TX_DCIA_SB_TX_ASG_GRE_RN number default 0,
344 PR_TX_DCIA_SB_TX_JD_ASG_GRE_RN number default 0,
345 EIC_ADVANCE_ASG_GRE_RUN number default 0,
346 VOL_DEDN_ROTH_ASG_GRE_RUN number default 0,
347 VOL_DEDN_SB_TX_ASG_GRE_RUN number default 0,
348 VOL_DEDN_SB_TX_JD_ASG_GRE_RUN number default 0,
349 NET_ASG_RUN number default 0,
350 NET_ASG_PTD number default 0
351
352 ) RETURN number;
353
354 /****************************************************************************
355 Name : CAL_FORMULA_TL
356 Description : This function calculates amount to be withheld for TL
357 category.
358 *****************************************************************************/
359 FUNCTION CAL_FORMULA_TL
360 (
361 P_CTX_BUSINESS_GROUP_ID number,
362 P_CTX_PAYROLL_ID number,
363 P_CTX_ELEMENT_TYPE_ID number,
364 P_CTX_ORIGINAL_ENTRY_ID number,
365 P_CTX_DATE_EARNED date,
366 P_CTX_JURISDICTION_CODE varchar2,
367 P_CTX_ELEMENT_ENTRY_ID number,
368 PAY_EARNED_START_DATE date,
369 PAY_EARNED_END_DATE date,
370 TOTAL_WITHHELD_FEE_ASG_GRE_RUN number,
371 TOT_WHLD_SUPP_ASG_GRE_RUN number,
372 SCL_ASG_US_WORK_SCHEDULE varchar2,
373 ASG_HOURS number,
374 ASG_FREQ varchar2,
375 TERMINATED_EMPLOYEE varchar2,
376 FINAL_PAY_PROCESSED varchar2,
377 GROSS_EARNINGS_ASG_GRE_RUN number,
378 TAX_DEDUCTIONS_ASG_GRE_RUN number,
379 NET_ASG_GRE_RUN number,
380 NET_ASG_RUN number,
381 TOTAL_OWED number,
382 DATE_SERVED date,
383 ADDITIONAL_AMOUNT_BALANCE number,
384 REPLACEMENT_AMOUNT_BALANCE number,
385 PRIMARY_AMOUNT_BALANCE number,
386 TAX_LEVIES_ASG_GRE_PTD number,
387 CALCD_DEDN_AMT OUT NOCOPY number,
388 NOT_TAKEN OUT NOCOPY number,
389 TO_ARREARS OUT NOCOPY number,
390 TO_TOTAL_OWED OUT NOCOPY number,
391 TO_ADDL OUT NOCOPY number,
392 TO_REPL OUT NOCOPY number,
393 FATAL_MESG OUT NOCOPY varchar2,
394 MESG OUT NOCOPY varchar2,
395 CALC_SUBPRIO OUT NOCOPY number,
396 STOP_ENTRY OUT NOCOPY varchar2,
397 EIC_ADVANCE_ASG_GRE_RUN number default 0
398 ) RETURN number;
399
400
401 /****************************************************************************
402 Name : ENTRY_SUBPRIORITY
403 Description : This function return sub-priority of specified
404 element_entry_id.
405 *****************************************************************************/
406
407 FUNCTION ENTRY_SUBPRIORITY RETURN number;
408
409
410 /****************************************************************************
411 Name : CONVERT_PERIOD_TYPE
412 Description : This function converts amount according to the time units
413 specified.
414 *****************************************************************************/
415
416 FUNCTION CONVERT_PERIOD_TYPE
417 (
418 SCL_ASG_US_WORK_SCHEDULE varchar2,
419 ASG_HOURS number,
420 FED_CRITERIA_PCT_PRD_DI_XMPT number,
421 P_FROM_FREQ varchar2,
422 P_TO_FREQ varchar2,
423 PAY_EARNED_START_DATE date,
424 PAY_EARNED_END_DATE date,
425 P_ASST_STD_FREQ varchar2
426 )
427 RETURN number;
428
429 /****************************************************************************
430 Name : FNC_FEE_CALCULATION
431 Description : This function calculates fees amount for different categories
432 of involuntary deductions.
433 *****************************************************************************/
434
435 FUNCTION FNC_FEE_CALCULATION
436 (
437 GARN_FEE_FEE_RULE varchar2,
438 GARN_FEE_FEE_AMOUNT number,
439 GARN_FEE_PCT_CURRENT number,
440 TOTAL_OWED number,
441 PRIMARY_AMOUNT_BALANCE number,
442 GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
443 GARN_FEE_MAX_FEE_AMOUNT number,
444 PTD_FEE_BALANCE number,
445 GARN_TOTAL_FEES_ASG_GRE_RUN number,
446 DEDN_AMT number,
447 MONTH_FEE_BALANCE number,
448 ACCRUED_FEES number
449 )
450 RETURN number;
451
452 /****************************************************************************
453 Name : GET_GARN_LIMIT_MAX_DURATION
454 Description : This function returns the maximum duration, in
455 number of days, for which a particular garnishment can be
456 taken in a particular state. The duration is obtained with
457 respect to the 'Date Served' of the garnishment.
458 *****************************************************************************/
459
460 FUNCTION GET_GARN_LIMIT_MAX_DURATION(PAY_EARNED_START_DATE DATE) RETURN number;
461
462 /****************************************************************************
463 Name : GET_GEOCODE
464 Description : This function returns the geocode corresponding to inputs
465 specified.
466 *****************************************************************************/
467
468
469 FUNCTION GET_GEOCODE
470 (
471 OVERRIDE_ADR_REGION_2 varchar2,
472 OVERRIDE_ADR_REGION_1 varchar2,
473 OVERRIDE_ADR_CITY varchar2,
474 OVERRIDE_ADR_POSTAL_CODE varchar2
475 ) RETURN varchar2;
476
477 /****************************************************************************
478 Name : GARN_CAT
479 Description : This function returns garnishment category of the specified
480 element_entry_id.
481 *****************************************************************************/
482
483 FUNCTION GARN_CAT RETURN varchar2;
484
485 /****************************************************************************
486 Name : GET_TABLE_VALUE
487 Description : This function returns the value stored by specified column in
488 the specified table.
489 *****************************************************************************/
490
491
492 FUNCTION GET_TABLE_VALUE
493 (
494 C_FED_LEVY_EXEMPTION_TABLE varchar2,
495 C_FED_LEVY_XMPT_TAB_COL varchar2,
496 FILING_STATUS varchar2,
497 FILING_STATUS_YEAR date
498 ) RETURN pay_user_column_instances_f.value%TYPE;
499
500 /****************************************************************************
501 Name : GET_CCPA_PROTECTION
502 Description : This function returns CCPA Protectiosn value which is then
503 serves as an upper limit of amount that can be deducted.
504 *****************************************************************************/
505
506
507 FUNCTION GET_CCPA_PROTECTION
508 (
509 TOTAL_DI number,
510 OTHERS_DI number,
511 SUPPORT_DI number,
512 CCPA_PROT_PERC number
513 ) RETURN number;
514
515
516 /****************************************************************************
517 Name : RESET_GLOBAL_VAR
518 Description : This procedure deletes all Global tables created and
519 resets the value of other Global variables.
520 *****************************************************************************/
521
522 PROCEDURE RESET_GLOBAL_VAR;
523
524
525 /*------------- CONTEXT DEFINITIONS -----------*/
526 CTX_BUSINESS_GROUP_ID number;
527 CTX_PAYROLL_ID number;
528 CTX_ELEMENT_TYPE_ID number;
529 CTX_ORIGINAL_ENTRY_ID number;
530 CTX_DATE_EARNED date;
531 CTX_JURISDICTION_CODE varchar2(20);
532 CTX_ELEMENT_ENTRY_ID number;
533 /*---------------------------------------------*/
534
535 l_package_name varchar2(50);
536
537 type dedn_tab_type is table of number index by binary_integer;
538 type varchar2_tab is table of varchar2(10) index by binary_integer;
539 type date_tab is table of date index by binary_integer;
540 type bool_tab_type is table of boolean index by binary_integer;
541
542 dedn_tab dedn_tab_type;
543 gar_dedn_tab dedn_tab_type;
544 fees_tab dedn_tab_type;
545 arrears_tab dedn_tab_type; /* Bug 2992741 */
546 actual_dedn_tab dedn_tab_type;
547 mod_dedn_tab dedn_tab_type ; /* Bug# 5295813 */
548
549 GLB_TOT_WHLD_SUPP_ASG_GRE_RUN number;
550 GLB_TOT_WHLD_ARR_ASG_GRE_RUN number;
551 GLB_ALLOW_MULT_DEDN boolean;
552 GLB_NUM_ELEM number;
553 GLB_SUPPORT_DI number;
554 GLB_OTHER_DI_FLAG boolean;
555 GLB_DCIA_EXIST_FLAG boolean;
556 GLB_TL_GROSS_EARNINGS number;
557 GLB_TOTAL_WHLD_FEE_ASG_GRE_RUN number;
558
559 /*------ GLOBAL VARIABLES AS REPLACEMENT OF CALCULATOR INPUT VALUES ----*/
560 GLB_FEES_ASG_GRE_PTD dedn_tab_type;
561 GLB_BASE_ASG_GRE_PTD dedn_tab_type;
562 GLB_AMT dedn_tab_type;
563 GLB_ARREARS_OVERRIDE dedn_tab_type;
564 GLB_ARREARS_DATE date_tab;
565 GLB_NUM_DEPS dedn_tab_type;
566 GLB_FIL_STAT varchar2_tab;
567 GLB_ALLOWS dedn_tab_type;
568 GLB_DEDN_OVERRIDE dedn_tab_type;
569 GLB_PCT dedn_tab_type;
570 GLB_MTD_BAL dedn_tab_type;
571 GLB_EXEMPT_AMT dedn_tab_type;
572 GLB_PTD_CAP_AMT dedn_tab_type;
573 GLB_PTD_BAL dedn_tab_type;
574 GLB_TO_ACCRUED_FEES dedn_tab_type;
575 GLB_MONTH_CAP_AMT dedn_tab_type;
576 GLB_AMT_NOT_SPEC bool_tab_type;
577 /*----------------------------------------------------------------------*/
578
579
580 END;
581