SAP ABAP Class CL_HRBEN_HEALTH_FSA (FSA)
Hierarchy
SAP_HRCUS (Software Component) Sub component SAP_HRCUS of SAP_HR
   PY-US-GR-BI (Application Component) Benefit Integration
     PC10_BEN (Package) Benefits Payroll Integration USA
Properties
Class CL_HRBEN_HEALTH_FSA  
Short Description FSA    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package PC10_BEN   Benefits Payroll Integration USA 
Created 20121015   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_HRBEN_HEALTH_FSA has no interface implemented.
Friends
Class CL_HRBEN_HEALTH_FSA has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GO_INSTANCE Static Attribute Protected Object reference (TYPE REF TO) CL_HRBEN_HEALTH_FSA FSA 20121121
2 MC_ENROLLMENT_DATE Instance attribute Protected Type reference (TYPE) DATUM '20130101' Date 20121121
3 MC_HCFSA_CONST_LIMIT Constant Protected Type reference (TYPE) PAYCO 'HFSA1' Payroll parameter for amounts 20121121
4 MC_HCFSA_OFF Constant Protected Type reference (TYPE) P_99SOPTVA 'OFF' Value for configuration option 20121121
5 MC_HCFSA_ON Constant Protected Type reference (TYPE) P_99SOPTVA 'ON' Value for configuration option 20121121
6 MC_MOLGA Constant Protected Type reference (TYPE) MOLGA '10' Country Grouping 20121121
7 MC_OPTION_HCFSA Constant Protected Type reference (TYPE) P_99SOPTIO 'HCFSA' Possible Confituration Options 20121121
8 MC_PLAN_CATEGORY Constant Protected Type reference (TYPE) BEN_CATEG 'D' Benefit Plan Category 20121121
9 MS_T5UBA Instance attribute Protected Type reference (TYPE) T5UBA Benefit plan 20121121
10 MS_WPBP Instance attribute Protected Type reference (TYPE) PC205 Payroll Results: Work Center/Basic Pay 20121121
11 MT_BENTAB Instance attribute Protected Type reference (TYPE) HRPAY99_BENTAB Benefits payroll results international 20121121
12 MT_EE_CONTRIB Instance attribute Protected Type reference (TYPE) TY_T_EE_CONTRIB 20121121
13 MT_FILTERED_BENTAB Instance attribute Protected Type reference (TYPE) HRPAY99_BENTAB Benefits 20121121
14 MT_IT Instance attribute Protected Type reference (TYPE) HRPAY99_RT Results Table 20121121
15 MT_PLANS_DATA Instance attribute Protected Type reference (TYPE) TY_T_5UBA_WT Benefit plan 20121121
16 MV_EE_CONTRIB Instance attribute Protected Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121
17 MV_EE_CONTRIB_FSA Instance attribute Protected Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121
18 MV_EE_CONTRIB_IN_PERIOD Instance attribute Protected Type reference (TYPE) BEN_CAMNT Payroll: Amount per unit 20121121
19 MV_KEY_DATE Instance attribute Protected Type reference (TYPE) DATUM Date 20121121
20 MV_PERNR Instance attribute Protected Type reference (TYPE) PERNR_D Personnel Number 20121121
21 MV_V0ZNR Instance attribute Protected Type reference (TYPE) V0ZNR Variable assignment number 20121121
22 MV_YTD_BENTAB Instance attribute Protected Type reference (TYPE) MAXBT HR Payroll: Amount 20121121
Methods
# Method Level Visibility Method type Description Created on
1 BUILD_EE_CONTRIB Instance method Protected Method Build the employee contribution according to IT table 20121121
2 CALCULATE_CONTRIB Instance method Protected Method Calculate the employee contribution 20121121
3 CALCULATE_EE_CONTRIB Instance method Protected Method Calculate the FSA employee contribution 20121121
4 CALCULATE_ER_CONTRIB Instance method Protected Method Calculate the FSA employer contribution 20121121
5 CHECK_FSA_LIMIT Instance method Public Method Check if the EE contribuiton does not exceed the limit 20121121
6 CHECK_PLAN_DETAILS Instance method Protected Method Check if the plan can be handled 20121121
7 CHECK_PLAN_INTO_BENTAB Instance method Protected Method Check if the corresponding plan is into BENTAB 20121121
8 CONSTRUCTOR Instance method Protected Constructor Constructor 20121121
9 DEFINE_LIMIT Instance method Protected Method Define the FSA limit 20121121
10 DESTROY Static method Public Method Destroy singleton instance of class CL_HRBEN_HEALTH_FSA 20121121
11 FILTER_BENTAB Instance method Protected Method Filter BENTAB with Health Plans 20121121
12 GET_BEGIN_DATE_OF_PLAN Instance method Protected Method Get the first date of the plan year 20121121
13 GET_INSTANCE Static method Public Method Get Instance of CL_HRBEN_HEALTH_FSA 20121121
14 GET_TOTAL_EE_CONTRIBUTION Instance method Protected Method Get current Year To Date amount 20121121
15 GET_YTD_FROM_BENTAB Instance method Protected Method Get Year To Date of all health plans from BENTAB 20121121
16 INITIALIZE Instance method Public Method Initialize FSA class with current plan data 20121121
17 IS_HEALTH_PLAN Instance method Protected Method Check if the benefit plan is a health plan 20121121
18 IS_SWITCH_ACTIVE Instance method Protected Method Verify if Health FSA functionality is active 20121121
19 PROCESS_EE_CONTRIB Instance method Public Method Trigger the FSA process for employee contribuiton 20121121
20 PROCESS_ER_CONTRIB Instance method Public Method Trigger the FSA process for employer contribuiton 20121121
21 READ_HCFSA_LIMIT Instance method Protected Method Read the limit value of the constant HFSA1 20121121
22 SET_CURRENT_EE_CONTRIB Instance method Protected Method Set the in period employee contribution 20121121
23 SET_EE_CONTRIB Instance method Protected Method Set the current employee contribution 20121121
24 SET_EE_CONTRIB_FSA Instance method Protected Method Set the employee contribution 20121121
25 SET_FILTERED_BENTAB Instance method Protected Method Set filtered BENTAB 20121121
26 SET_KEY_DATE Instance method Protected Method Set the key date 20121121
27 SET_T5UBA Instance method Protected Method Set T5UBA table 20121121
28 SET_YTD_AMOUNT Instance method Protected Method Set Year To Date amount from BENTAB 20121121
29 UPDATE_PLAN_CONTRIB Instance method Protected Method Set the employee contribution per plan 20121121
30 USER_OVERRIDE_LIMIT Instance method Protected Method User override to customizing 20121121
Events
Class CL_HRBEN_HEALTH_FSA has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_S_EE_CONTRIB Protected See coding 20121121 begin of ty_s_ee_contrib, barea type ben_area, bplan type ben_plan, lgart type lgart, ee_contrib type ben_camnt, end of ty_s_ee_contrib
2 TY_T_5UBA_WT Protected See coding 20121121 ty_t_5uba_wt TYPE STANDARD TABLE OF v_5uba_wt
3 TY_T_EE_CONTRIB Protected See coding 20121121 TY_T_EE_CONTRIB TYPE STANDARD TABLE OF ty_s_ee_contrib
Method Signatures

Method BUILD_EE_CONTRIB Signature

Method BUILD_EE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no parameter.
Method BUILD_EE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method CALCULATE_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LIMIT Call by reference Type reference (TYPE) BEN_RMAXA HR Payroll: Amount 20121121
2 Importing IV_TOTAL_YTD_AMOUNT Call by reference Type reference (TYPE) MAXBT HR Payroll: Amount 20121121
3 Returning RV_EE_CONTRIB Value transfer Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121

Method CALCULATE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method CALCULATE_EE_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_EE_CONTRIB Value transfer Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121

Method CALCULATE_EE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method CALCULATE_ER_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_ERROR_TABLE Call by reference Type reference (TYPE) HRBEN00ERR Benefit structure for error table 20121121
2 Changing CV_SUBRC Call by reference Type reference (TYPE) SYSUBRC Return Value of ABAP Statements 20121121
3 Exporting EV_ER_CONTRIB_FSA Call by reference Type reference (TYPE) BEN_EECAMT Benefit Employee Pre-Tax Contribution Amount 20121121
4 Importing IS_APER Call by reference Type reference (TYPE) PC2APER structure of table APER in payroll 20121121
5 Importing IS_EE_BENEFIT_DATA Call by reference Type reference (TYPE) RPBENEEDAT Benefit reference structure for function modules 20121121
6 Importing IV_CALC_CURRENCY Call by reference Type reference (TYPE) WAERS Currency Key 20121121
7 Importing IV_ERCON Call by reference Type reference (TYPE) BEN_ERCON Employer's Benefits Contribution Variant 20121121
8 Importing IV_PARDT Call by reference Type reference (TYPE) BEN_PARTDT Benefit date of first participation in plan 20121121
9 Importing IV_PLAN_MODEL Call by reference Type reference (TYPE) MODE1 Payment Model 20121121
10 Importing IV_PLAN_ZEINH Call by reference Type reference (TYPE) PFREQ Payroll time units 20121121
11 Importing IV_SALRY Call by reference Type reference (TYPE) MAXBT Amount 20121121
12 Importing IV_SW_PROT Call by reference Type reference (TYPE) C 20121121

Method CALCULATE_ER_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method CHECK_FSA_LIMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BAREA Call by reference Type reference (TYPE) BEN_AREA Benefit area 20121121
2 Importing IV_BPLAN Call by reference Type reference (TYPE) BEN_PLAN Benefit plan 20121121
3 Importing IV_CURRENCY Call by reference Type reference (TYPE) BEN_CURR Benefit Currency Key 20121121
4 Importing IV_EE_CONTRIB Call by reference Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121
5 Importing IV_KEY_DATE Call by reference Type reference (TYPE) DATUM Date 20121121
# Exception Resumable Description Created on
1 CX_HRBEN_HEALTH_FSA 20121121

Method CHECK_PLAN_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_BENTAB Call by reference Type reference (TYPE) PC27S Date 20121121

Method CHECK_PLAN_DETAILS on class CL_HRBEN_HEALTH_FSA has no exception.

Method CHECK_PLAN_INTO_BENTAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_BENTAB Call by reference Type reference (TYPE) PC27S Date 20121121

Method CHECK_PLAN_INTO_BENTAB on class CL_HRBEN_HEALTH_FSA has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_HRBEN_HEALTH_FSA has no parameter.
Method CONSTRUCTOR on class CL_HRBEN_HEALTH_FSA has no exception.

Method DEFINE_LIMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_LIMIT Value transfer Type reference (TYPE) BEN_RMAXA HR Payroll: Amount 20121121

Method DEFINE_LIMIT on class CL_HRBEN_HEALTH_FSA has no exception.

Method DESTROY Signature

Method DESTROY on class CL_HRBEN_HEALTH_FSA has no parameter.
Method DESTROY on class CL_HRBEN_HEALTH_FSA has no exception.

Method FILTER_BENTAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FILTERED_BENTAB Value transfer Type reference (TYPE) HRPAY99_BENTAB Benefits 20121121

Method FILTER_BENTAB on class CL_HRBEN_HEALTH_FSA has no exception.

Method GET_BEGIN_DATE_OF_PLAN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BAREA Call by reference Type reference (TYPE) BEN_AREA Benefit area 20121121
2 Importing IV_BPLAN Call by reference Type reference (TYPE) BEN_PLAN Benefit plan 20121121
3 Importing IV_KEY_DATE Call by reference Type reference (TYPE) DATUM Date 20121121
4 Returning RV_BEGIN_DATE Value transfer Type reference (TYPE) DATUM Date 20121121

Method GET_BEGIN_DATE_OF_PLAN on class CL_HRBEN_HEALTH_FSA has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_INSTANCE Value transfer Object reference (TYPE REF TO) CL_HRBEN_HEALTH_FSA FSA 20121121

Method GET_INSTANCE on class CL_HRBEN_HEALTH_FSA has no exception.

Method GET_TOTAL_EE_CONTRIBUTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TOTAL_YTD_AMOUNT Value transfer Type reference (TYPE) MAXBT HR Payroll: Amount 20121121

Method GET_TOTAL_EE_CONTRIBUTION on class CL_HRBEN_HEALTH_FSA has no exception.

Method GET_YTD_FROM_BENTAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_YTD_AMOUNT Value transfer Type reference (TYPE) MAXBT HR Payroll: Amount 20121121

Method GET_YTD_FROM_BENTAB on class CL_HRBEN_HEALTH_FSA has no exception.

Method INITIALIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_T5UBA Call by reference Type reference (TYPE) T5UBA Benefit plan 20121121
2 Importing IS_WPBP Call by reference Type reference (TYPE) PC205 Payroll Results: Work Center/Basic Pay 20121121
3 Importing IT_BENTAB Call by reference Type reference (TYPE) HRPAY99_BENTAB Benefits 20121121
4 Importing IT_IT Call by reference Type reference (TYPE) HRPAY99_RT Results Table 20121121
5 Importing IV_KEY_DATE Call by reference Type reference (TYPE) DATUM Date 20121121
6 Importing IV_PERNR Call by reference Type reference (TYPE) PERNR_D Personnel Number 20121121
7 Importing IV_V0ZNR Call by reference Type reference (TYPE) V0ZNR Variable assignment number 20121121

Method INITIALIZE on class CL_HRBEN_HEALTH_FSA has no exception.

Method IS_HEALTH_PLAN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BAREA Call by reference Type reference (TYPE) BEN_AREA Benefit area 20121121
2 Importing IV_BPLAN Call by reference Type reference (TYPE) BEN_PLAN Benefit plan 20121121
3 Returning RV_HEALTH_PLAN Value transfer Type reference (TYPE) ABAP_BOOL 20121121

Method IS_HEALTH_PLAN on class CL_HRBEN_HEALTH_FSA has no exception.

Method IS_SWITCH_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_IS_SWITCH_ACTIVE Value transfer Type reference (TYPE) ABAP_BOOL 20121121

Method IS_SWITCH_ACTIVE on class CL_HRBEN_HEALTH_FSA has no exception.

Method PROCESS_EE_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_IT Call by reference Type reference (TYPE) HRPAY99_RT Results Table 20121121

Method PROCESS_EE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method PROCESS_ER_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_ERROR_TABLE Call by reference Type reference (TYPE) HRBEN00ERR Benefit structure for error table 20121121
2 Changing CV_SUBRC Call by reference Type reference (TYPE) SYSUBRC Return Value of ABAP Statements 20121121
3 Exporting EV_ER_CONTRIB_FSA Call by reference Type reference (TYPE) BEN_EECAMT Benefit employee contribution 20121121
4 Importing IS_APER Call by reference Type reference (TYPE) PC2APER structure of table APER in payroll 20121121
5 Importing IS_EE_BENEFIT_DATA Call by reference Type reference (TYPE) RPBENEEDAT Benefit reference structure for function modules 20121121
6 Importing IV_CALC_CURRENCY Call by reference Type reference (TYPE) WAERS Currency Key 20121121
7 Importing IV_ERCON Call by reference Type reference (TYPE) BEN_ERCON Employer's Benefits Contribution Variant 20121121
8 Importing IV_ER_CONTRIB Call by reference Type reference (TYPE) BEN_EECAMT Benefit Employee Pre-Tax Contribution Amount 20121121
9 Importing IV_PARDT Call by reference Type reference (TYPE) BEN_PARTDT Benefit date of first participation in plan 20121121
10 Importing IV_PLAN_MODEL Call by reference Type reference (TYPE) MODE1 Payment Model 20121121
11 Importing IV_PLAN_ZEINH Call by reference Type reference (TYPE) PFREQ Payroll time units 20121121
12 Importing IV_SALRY Call by reference Type reference (TYPE) MAXBT Amount 20121121
13 Importing IV_SW_PROT Call by reference Type reference (TYPE) C 20121121

Method PROCESS_ER_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method READ_HCFSA_LIMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_LIMIT Value transfer Type reference (TYPE) BEN_RMAXA HR Payroll: Amount 20121121

Method READ_HCFSA_LIMIT on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_CURRENT_EE_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EE_CONTRIB_IN_PERIOD Call by reference Type reference (TYPE) BETPE Payroll: Amount per unit 20121121

Method SET_CURRENT_EE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_EE_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EE_CONTRIB Call by reference Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121

Method SET_EE_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_EE_CONTRIB_FSA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EE_CONTRIB_FSA Call by reference Type reference (TYPE) BEN_CAMNT Benefit employee contribution 20121121

Method SET_EE_CONTRIB_FSA on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_FILTERED_BENTAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_FILTERED_BENTAB Call by reference Type reference (TYPE) HRPAY99_BENTAB Benefits 20121121

Method SET_FILTERED_BENTAB on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_KEY_DATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_KEY_DATE Call by reference Type reference (TYPE) DATUM Date 20121121

Method SET_KEY_DATE on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_T5UBA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_T5UBA Call by reference Type reference (TYPE) T5UBA Benefit plan 20121121

Method SET_T5UBA on class CL_HRBEN_HEALTH_FSA has no exception.

Method SET_YTD_AMOUNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_YTD_AMOUNT Call by reference Type reference (TYPE) MAXBT HR Payroll: Amount 20121121

Method SET_YTD_AMOUNT on class CL_HRBEN_HEALTH_FSA has no exception.

Method UPDATE_PLAN_CONTRIB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EE_CONTRIB Call by reference Type reference (TYPE) BEN_CAMNT HR Payroll: Amount 20121121

Method UPDATE_PLAN_CONTRIB on class CL_HRBEN_HEALTH_FSA has no exception.

Method USER_OVERRIDE_LIMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_LIMIT Call by reference Type reference (TYPE) BEN_RMAXA HR Payroll: Amount 20121121
2 Importing IV_BAREA Call by reference Type reference (TYPE) BEN_AREA Benefit area 20121121
3 Importing IV_BPLAN Call by reference Type reference (TYPE) BEN_PLAN Benefit plan 20121121
4 Importing IV_KEY_DATE Call by reference Type reference (TYPE) DATUM Date 20121121
5 Importing IV_PERNR Call by reference Type reference (TYPE) PERNR_D Personnel Number 20121121

Method USER_OVERRIDE_LIMIT on class CL_HRBEN_HEALTH_FSA has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in