SAP ABAP Class CL_HR_PAYROLL_AREA (Payroll Area)
Hierarchy
☛ SAP_HRRXX (Software Component) Sub component SAP_HRRXX of SAP_HR
   ⤷ PY-XX (Application Component) Payroll: General Parts
     ⤷ PCAL (Package) SAP HR Payroll Application Development
Properties
Class CL_HR_PAYROLL_AREA  
Short Description Payroll Area    
Super Class    
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status T  Test Program 
Category 0   
Package PCAL   SAP HR Payroll Application Development 
Created 20010627   SAP 
Last change 20080505   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_HR_PAYROLL_AREA has no forward declaration.
Interfaces
Class CL_HR_PAYROLL_AREA has no interface implemented.
Friends
Class CL_HR_PAYROLL_AREA has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ABKRS Instance attribute Public Type reference (TYPE) ABKRS Payroll Area 20010709
2 ADRUN Instance attribute Private Type reference (TYPE) ADRUN HR: Special Payroll Run 20010709
3 ALL_PAY_AREAS Static Attribute Public Type reference (TYPE) HRPAY99_PAY_AREA_T Payroll Area 20010627
4 ALL_PAY_AREAS_LOADED Static Attribute Public Type reference (TYPE) RP_XFELD 'X': All Payroll Areas are Loaded 20010709
5 AREAS Static Attribute Private Type reference (TYPE) AREAS_TABLE Directory of payroll areas which have instances 20010702
6 CALCR Instance attribute Public Type reference (TYPE) CALCR Run Payroll for Payroll Area 20010709
7 DATMO Instance attribute Public Type reference (TYPE) DATMO Date Modifier 20010709
8 HIGH_DATE Constant Public Type reference (TYPE) D '99991231' Lowest Valid Date 20010703
9 LOW_DATE Constant Public Type reference (TYPE) D '18000101' Highest Valid Date 20010703
10 MAX_RRDAT Static Attribute Private Type reference (TYPE) D Maximum retroactive accounting date from all payroll areas 20030317
11 MAX_RRDAT_FORCED_RRDAT Static Attribute Private Type reference (TYPE) D Forced retroactive accounting date for MAX_RRDAT 20030317
12 NO Constant Private Type reference (TYPE) RP_XFELD ' ' Checkbox 20020813
13 PABRJ Instance attribute Public Type reference (TYPE) PABRJ Current Year 20010709
14 PABRP Instance attribute Public Type reference (TYPE) PABRP Current Period 20010709
15 PAY_PERIOD_BUFFER Instance attribute Private Type reference (TYPE) T549Q Payroll Periods 20010709
16 PCR_EXISTS Instance attribute Public Type reference (TYPE) RP_XFELD 'X': Control Record Exists 20040115
17 PERMO Instance attribute Public Type reference (TYPE) PERMO Period Parameters 20010709
18 PRI_ZEINH Instance attribute Private Type reference (TYPE) PFREQ Private Time Unit 20111014
19 SRTFD Instance attribute Private Type reference (TYPE) VWSRT Sort Field for Control Record 20010709
20 STATE Instance attribute Public Type reference (TYPE) VWSTA Status of Control Record 20010709
21 UABRJ Instance attribute Private Type reference (TYPE) UABRJ Earliest possible year for which retr.acc. can be performed 20010709
22 UABRP Instance attribute Private Type reference (TYPE) UABRP Earliest retroactive accounting period 20010709
23 YES Constant Private Type reference (TYPE) RP_XFELD 'X' Checkbox 20020813
24 ZEINH Instance attribute Public Type reference (TYPE) PFREQ Payroll Time Units 20010709
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20010702
2 DEQUEUE_PA03 Instance method Public Method Unlock Control Record (See Note 542256) 20020813
3 DEQUEUE_PA03_ALL Static method Public Method Unlock All Control Records (See Note 542256) 20020813
4 DETERMINE_EARLIEST_BEGDA_ENDDA Instance method Public Method Determines strt/ end date of 1st retr.accnting period ABKRS 20010717
5 DETERMINE_EARLIEST_RETRO_DATE Instance method Public Method Earliest retroactive accounting date of payroll control rec. 20010719
6 DETERMINE_LAST_DAY_OF_CALC Instance method Public Method Determines the last day of the payroll run of the pyrll area 20010719
7 DETERMINE_MAX_RRDAT Static method Public Method Determines the latest possible retroactive accounting date 20010702
8 DETERMINE_PERIODE_BEGDA_ENDDA Instance method Public Method Determines strt/end date for period of payroll area keydate 20010920
9 ENQUEUE_PA03 Instance method Public Method Lock Control Record (See Note 542256) 20020813
10 GET_EARLIEST_RETRO_PERIOD Instance method Public Method Determines Earliest PY Per. for Which RA Can Be Run 20070430
11 GET_ENDDA_OF_CURRENT_PERIOD Instance method Public Method Determines End Date of Current Period Acc. to Control Record 20130325
12 GET_FIRST_PERIODE_IN_FRAME Instance method Public Method Determines the first period in a time window 20011002
13 GET_INFO_OF_ACTUAL_PERIODE Instance method Public Method Information on a Period 20010911
14 GET_INSTANCE Static method Public Method Delivers the Instance for a Payroll Area 20010702
15 GET_NEXT_PERIOD Instance method Public Method Next Period 20010709
16 GET_PA03_LOCK Static method Public Method Actual Payroll Area Locked 20020813
17 GET_PA03_LOCK_MODE Static method Private Method Returns Lock Mode 20030131
18 GET_PAYDT_OF_PERIOD Instance method Public Method Determine the Payment Date for a Given Period 20010730
19 GET_PERIODE_WITH_DATE Instance method Public Method Determine period for a key date 20010711
20 GET_PERIOD_INFO Instance method Public Method Information on a Period 20010709
21 GET_ZEINH Instance method Public Method Determines the Time Unit of the Payroll Area 20010709
22 IS_PAY_AREA_RELEVANT Instance method Public Method Checks whether the payroll area is relevant for payroll 20010717
23 LOAD_ALL_PAY_AREAS Static method Public Method Load All Payroll Areas and Control Records in the Buffer 20010627
24 RESET_PA03_LOCK Static method Private Method Delete Locked Indicator 20020813
25 SET_PA03_LOCK Static method Private Method Set Locked Indicator 20020813
26 SET_ZEINH Instance method Private Method Set Time Unit Attribute 20111014
Events
Class CL_HR_PAYROLL_AREA has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 AREAS_TABLE Private See coding Instance Directory 20010702 AREAS_TABLE type hashed table of AREA_WA with unique key area
2 AREA_WA Private See coding Instance Directory Header 20010702 begin of AREA_WA, area type t549a-abkrs, instance type ref to cl_hr_payroll_area, pa03_locked type rp_xfeld, lock_mode type DD26E-ENQMODE, end of area_wa
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_AREA Call by reference Type reference (TYPE) T549A-ABKRS Abrechnungskreis 20010702
# Exception Resumable Description Created on
1 AREA_DOES_NOT_EXIST Abrechnungskreis existiert nicht 20010709

Method DEQUEUE_PA03 Signature

Method DEQUEUE_PA03 on class CL_HR_PAYROLL_AREA has no parameter.
Method DEQUEUE_PA03 on class CL_HR_PAYROLL_AREA has no exception.

Method DEQUEUE_PA03_ALL Signature

Method DEQUEUE_PA03_ALL on class CL_HR_PAYROLL_AREA has no parameter.
Method DEQUEUE_PA03_ALL on class CL_HR_PAYROLL_AREA has no exception.

Method DETERMINE_EARLIEST_BEGDA_ENDDA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EXP_BEGDA Call by reference Type reference (TYPE) D Beginn der Periode 20010717
2 Exporting EXP_ENDDA Call by reference Type reference (TYPE) D Ende der Periode 20010717
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method DETERMINE_EARLIEST_RETRO_DATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET_EARLIEST_RETRO_DATE Value transfer Type reference (TYPE) D Frühestes Rückrechnungsdatum 20010719
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method DETERMINE_LAST_DAY_OF_CALC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET_LAST_DAY Value transfer Type reference (TYPE) D Letzter abgerechneter Tag 20010719
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method DETERMINE_MAX_RRDAT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_FORCED_RRDAT Call by reference Type reference (TYPE) D Zwangsrückrechnungsdatum 20010703
2 Returning RET_MAX_RRDAT Value transfer Type reference (TYPE) D Maximales Rückrechnungsdatum laut Verwaltungssätzen 20010703

Method DETERMINE_MAX_RRDAT on class CL_HR_PAYROLL_AREA has no exception.

Method DETERMINE_PERIODE_BEGDA_ENDDA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EXP_BEGDA Call by reference Type reference (TYPE) D Beginn der Periode 20010920
2 Exporting EXP_ENDDA Call by reference Type reference (TYPE) D Ende der Periode 20010920
3 Importing IMP_DATE Call by reference Type reference (TYPE) D Stichtag 20010920
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method ENQUEUE_PA03 Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_MODE Call by reference Type reference (TYPE) DD26E-ENQMODE 'S' Sperrmodus 20030131
# Exception Resumable Description Created on
1 ERROR_OCCURED Fehler beim Sperren 20020813

Method GET_EARLIEST_RETRO_PERIOD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET_EARLIEST_RETRO_PERIOD Value transfer Type reference (TYPE) PC2PAPER Unterstruktur für Tabelle APER Personalabrechnung 20070430

Method GET_EARLIEST_RETRO_PERIOD on class CL_HR_PAYROLL_AREA has no exception.

Method GET_ENDDA_OF_CURRENT_PERIOD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET_ENDDA Value transfer Type reference (TYPE) D Endda der aktuellen Periode 20130325
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20130325

Method GET_FIRST_PERIODE_IN_FRAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_BEGDA Call by reference Type reference (TYPE) D Begindatum des Intervalls 20011002
2 Importing IMP_BEG_YEAR Call by reference Type reference (TYPE) PABRJ Startjahr des Intervalls 20011002
3 Importing IMP_ENDDA Call by reference Type reference (TYPE) D Endedatum des Intervalls 20011002
4 Importing IMP_END_YEAR Call by reference Type reference (TYPE) PABRJ Endejahr des Intervalls 20011002
5 Returning RET_PERIODE Value transfer Type reference (TYPE) PC2PAPER Unterstruktur für Tabelle APER Personalabrechnung 20011002
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method GET_INFO_OF_ACTUAL_PERIODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EXP_BEGDA Call by reference Type reference (TYPE) D Beginn der Periode 20010911
2 Exporting EXP_ENDDA Call by reference Type reference (TYPE) D Ende der Periode 20010911
3 Exporting EXP_VABRJ Call by reference Type reference (TYPE) VABRJ Vorheriges Abrechnungsjahr 20010911
4 Exporting EXP_VABRP Call by reference Type reference (TYPE) VABRP Vorherige Abrechnungsperiode 20010911
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011007

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_AREA Call by reference Type reference (TYPE) T549A-ABKRS Abrechnungskreis 20010702
2 Returning RET_AREA Value transfer Object reference (TYPE REF TO) CL_HR_PAYROLL_AREA Abrcehnungskreis 20010702
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011005

Method GET_NEXT_PERIOD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EXP_BEGDA Call by reference Type reference (TYPE) D Beginn der Periode 20011002
2 Exporting EXP_ENDDA Call by reference Type reference (TYPE) D Ende der Periode 20011002
3 Exporting EXP_PABRJ Call by reference Type reference (TYPE) PABRJ Abrechnungsjahr 20010911
4 Exporting EXP_PABRP Call by reference Type reference (TYPE) PABRP Abrechnungsperiode 20010911
5 Importing IMP_PABRJ Call by reference Type reference (TYPE) PABRJ Abrechnungsjahr 20010911
6 Importing IMP_PABRP Call by reference Type reference (TYPE) PABRP Abrechnungsperiode 20010911
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011007

Method GET_PA03_LOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_ABKRS Call by reference Type reference (TYPE) ABKRS Abrechnungskreis 20020813
2 Returning RET_PA03_LOCKED Value transfer Type reference (TYPE) RP_XFELD Ankreuzfeld 20020813

Method GET_PA03_LOCK on class CL_HR_PAYROLL_AREA has no exception.

Method GET_PA03_LOCK_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_ABKRS Call by reference Type reference (TYPE) ABKRS Abrechnungskreis 20030131
2 Returning RET_MODE Value transfer Type reference (TYPE) DD26E-ENQMODE Sperrmodus 20030131

Method GET_PA03_LOCK_MODE on class CL_HR_PAYROLL_AREA has no exception.

Method GET_PAYDT_OF_PERIOD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_MOLGA Call by reference Type reference (TYPE) MOLGA Ländergruppierung 20010730
2 Importing IMP_PAPER Call by reference Type reference (TYPE) PC2PAPER Unterstruktur für Tabelle APER Personalabrechnung 20010730
3 Returning RET_PAYDT Value transfer Type reference (TYPE) D Zahldatum 20010730
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method GET_PERIODE_WITH_DATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_DATE Call by reference Type reference (TYPE) D Stichtag 20010711
2 Returning RET_PERIOD Value transfer Type reference (TYPE) PC2PAPER Unterstruktur für Tabelle APER Personalabrechnung 20010711
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011008

Method GET_PERIOD_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EXP_BEGDA Call by reference Type reference (TYPE) D Beginn der Periode 20010709
2 Exporting EXP_ENDDA Call by reference Type reference (TYPE) D Ende der Periode 20010709
3 Exporting EXP_VABRJ Call by reference Type reference (TYPE) VABRJ Vorheriges Abrechnungsjahr 20010709
4 Exporting EXP_VABRP Call by reference Type reference (TYPE) VABRP Vorherige Abrechnungsperiode 20010709
5 Importing IMP_PABRJ Call by reference Type reference (TYPE) PABRJ Abrechnungsjahr 20010709
6 Importing IMP_PABRP Call by reference Type reference (TYPE) PABRP Abrechnungsperiode 20010709
# Exception Resumable Description Created on
1 CX_HRPY_PAYROLL_AREA Ausnahmen zur CL_HR_PAYROLL_AREA 20011007

Method GET_ZEINH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET_ZEINH Value transfer Type reference (TYPE) PFREQ Abrechnungszeiteinheiten 20010709

Method GET_ZEINH on class CL_HR_PAYROLL_AREA has no exception.

Method IS_PAY_AREA_RELEVANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET_IS_RELEVANT Value transfer Type reference (TYPE) RP_XFELD Ankreuzfeld 20010717

Method IS_PAY_AREA_RELEVANT on class CL_HR_PAYROLL_AREA has no exception.

Method LOAD_ALL_PAY_AREAS Signature

Method LOAD_ALL_PAY_AREAS on class CL_HR_PAYROLL_AREA has no parameter.
Method LOAD_ALL_PAY_AREAS on class CL_HR_PAYROLL_AREA has no exception.

Method RESET_PA03_LOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_ABKRS Call by reference Type reference (TYPE) ABKRS Abrechnungskreis 20020813

Method RESET_PA03_LOCK on class CL_HR_PAYROLL_AREA has no exception.

Method SET_PA03_LOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_ABKRS Call by reference Type reference (TYPE) ABKRS Abrechnungskreis 20020813
2 Importing IMP_MODE Call by reference Type reference (TYPE) DD26E-ENQMODE Sperrmodus 20030131

Method SET_PA03_LOCK on class CL_HR_PAYROLL_AREA has no exception.

Method SET_ZEINH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IMP_PERMO Call by reference Type reference (TYPE) PERMO Periodenparameter 20111014
# Exception Resumable Description Created on
1 UNIT_DOES_NOT_EXIST Payroll time unit does not exist 20111014
History
Last changed by/on SAP  20080505 
SAP Release Created in