SAP ABAP Class CL_HRPAYBR_BRANCH (Class for branch)

Hierarchy

☛ SAP_HRCBR (Software Component) Sub component SAP_HRCBR of SAP_HR
   ⤷ PY-BR (Application Component) Brazil
     ⤷ PC37 (Package) HR settlement: Brazil

Properties

Class	CL_HRPAYBR_BRANCH
Short Description	Class for branch
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	PC37	HR settlement: Brazil
Created	20120210	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)
2	PBRGO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_HRPAYBR_BRANCH has no interface implemented.

Friends

Class CL_HRPAYBR_BRANCH has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MS_ADDRESS	Instance attribute	Protected	☐	Type reference (TYPE)	ADDR1_VAL		Return structure for address	20120604
2	MT_BRANCH	Static Attribute	Protected	☐	Type reference (TYPE)	PBRGO_T_BRANCH		Table with branches already read	20120604
3	MV_BEGDA	Instance attribute	Protected	☐	Type reference (TYPE)	BEGDA		Valid from date	20120604
4	MV_BRANCH	Instance attribute	Protected	☐	Type reference (TYPE)	J_1BBRANC_		Business place	20120604
5	MV_BTRTL	Instance attribute	Protected	☐	Type reference (TYPE)	BTRTL		Personnel subarea	20120604
6	MV_CEI	Instance attribute	Protected	☐	Type reference (TYPE)	PBR_CEI		SRS Specific Register of Social Insurance Body	20120604
7	MV_CNAE	Instance attribute	Protected	☐	Type reference (TYPE)	PBR_ECONI		Economic activity	20120604
8	MV_CNPJ	Instance attribute	Protected	☐	Type reference (TYPE)	J_1BCGC		Code CGC	20120604
9	MV_CNPJ_OBRA	Instance attribute	Protected	☐	Type reference (TYPE)	PBR_NUM_CNPJ		Registration number in the CNPJ	20120604
10	MV_COD_OBRA	Instance attribute	Protected	☐	Type reference (TYPE)	PBR_OBRA		Construction site code	20120604
11	MV_COMPANY_CODE	Instance attribute	Protected	☐	Type reference (TYPE)	BUKRS		Company code	20120604
12	MV_EMAIL	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR0241		Character 241	20120604
13	MV_ENDDA	Instance attribute	Protected	☐	Type reference (TYPE)	ENDDA		Valid to date	20120604
14	MV_GUIA_CAGED	Instance attribute	Protected	☐	Type reference (TYPE)	PBR_GCAGE		GREU guide	20120604
15	MV_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	NAME1		Name	20120604
16	MV_NAME_OBRA	Instance attribute	Protected	☐	Type reference (TYPE)	PBR_CNAME		Name of construction site	20120604
17	MV_PROT	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Generates log?	20120604
18	MV_READ_BRANCH_CNAE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Cache control	20120604
19	MV_READ_BRANCH_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Cache control	20120604
20	MV_WERKS	Instance attribute	Protected	☐	Type reference (TYPE)	PERSA		Personnel area	20120604

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	CONSTRUCTOR	20120604
2	GET_ADDRESS_CITY	Instance method	Public	Method	Returns the branch city - address	20120604
3	GET_ADDRESS_DISTRICT	Instance method	Public	Method	Returns the branch district - address	20120604
4	GET_ADDRESS_FLOOR	Instance method	Public	Method	Returns the branch building floor - address supplement	20120604
5	GET_ADDRESS_NUMBER	Instance method	Public	Method	Returns the branch number - address	20120604
6	GET_ADDRESS_ROOMNUMBER	Instance method	Public	Method	Returns address, apartment or room no. - address supplement	20120604
7	GET_ADDRESS_STATE	Instance method	Public	Method	Returns the branch state - address	20120604
8	GET_ADDRESS_STREET	Instance method	Public	Method	Returns the branch street - address	20120604
9	GET_ADDRESS_ZIP_CODE	Instance method	Public	Method	Returns the branch ZIP code - address	20120604
10	GET_BTRTL	Instance method	Public	Method	Returns personnel subarea	20120604
11	GET_CEI	Instance method	Public	Method	Returns the branch SRS	20120604
12	GET_CNAE	Instance method	Public	Method	Returns the branch CNAE	20120604
13	GET_CNPJ	Instance method	Public	Method	Returns the CGC branch	20120604
14	GET_CNPJ_OBRA	Instance method	Public	Method	Returns the site CNPJ	20120604
15	GET_EMAIL	Instance method	Public	Method	Returns the e-mail	20120604
16	GET_GUIA_CAGED	Instance method	Public	Method	Returns the branch GREU guide	20120604
17	GET_INSTANCE	Static method	Public	Method	Returns the branch instance	20120604
18	GET_NAME	Instance method	Public	Method	Returns the branch name	20120604
19	GET_NAME_OBRA	Instance method	Public	Method	Returns the construction site name	20120604
20	GET_WERKS	Instance method	Public	Method	Returns personnel area	20120604
21	READ_BRANCH_CNAE	Instance method	Protected	Method	Returns the branch CNAE code	20120604
22	READ_BRANCH_DATA	Instance method	Protected	Method	DB reading class attribute maintenance	20120604
23	READ_BRANCH_DETAIL	Instance method	Protected	Method	Returns the branch detailed information	20120604
24	READ_BRANCH_ID	Instance method	Protected	Method	Returns the branch identification fields	20120604

Events

Class CL_HRPAYBR_BRANCH has no event.

Types

Class CL_HRPAYBR_BRANCH has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BEGDA	Call by reference	☐	Type reference (TYPE)	BEGDA			20120604
2	Importing	IV_BTRTL	Call by reference	☐	Type reference (TYPE)	BTRTL			20120604
3	Importing	IV_ENDDA	Call by reference	☐	Type reference (TYPE)	ENDDA			20120604
4	Importing	IV_PROT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120604
5	Importing	IV_WERKS	Call by reference	☐	Type reference (TYPE)	PERSA			20120604

Method CONSTRUCTOR on class CL_HRPAYBR_BRANCH has no exception.

Method GET_ADDRESS_CITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_CITY	Value transfer	☐	Type reference (TYPE)	AD_CITY1		Local	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_DISTRICT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_DISTRICT	Value transfer	☐	Type reference (TYPE)	AD_CITY2		District	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_FLOOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_FLOOR	Value transfer	☐	Type reference (TYPE)	AD_FLOOR		Building floor	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_NUMBER	Value transfer	☐	Type reference (TYPE)	AD_HSNM1		No.	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_ROOMNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_ROOMNUMBER	Value transfer	☐	Type reference (TYPE)	AD_ROOMNUM		Address, apartment or room number	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_STATE	Value transfer	☐	Type reference (TYPE)	REGIO		Region (country, state, province, county)	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_STREET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_STREET	Value transfer	☐	Type reference (TYPE)	AD_STREET		Street	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_ADDRESS_ZIP_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADDR_ZIP_CODE	Value transfer	☐	Type reference (TYPE)	POST_CODE		Postal code	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_BTRTL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BTRTL	Value transfer	☐	Type reference (TYPE)	BTRTL		Personnel subarea	20120604

Method GET_BTRTL on class CL_HRPAYBR_BRANCH has no exception.

Method GET_CEI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CEI	Value transfer	☐	Type reference (TYPE)	PBR_CEI		SRS Specific Register of Social Insurance Body	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_CNAE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CNAE	Value transfer	☐	Type reference (TYPE)	PBR_ECONI		Economic activity	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604
2	CX_HRPAYBR_RECORD_NOT_FOUND	☐	Exception generated when a record is not found in a table	20120604

Method GET_CNPJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CNPJ	Value transfer	☐	Type reference (TYPE)	J_1BCGC		Code CGC	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604

Method GET_CNPJ_OBRA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CNPJ_OBRA	Value transfer	☐	Type reference (TYPE)	PBR_NUM_CNPJ		Registration number in the CNPJ	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_EMAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EMAIL	Value transfer	☐	Type reference (TYPE)	CHAR0241		Character 241	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_GUIA_CAGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_GUIA_CAGED	Value transfer	☐	Type reference (TYPE)	PBR_GCAGE		GREU guide	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BEGDA	Call by reference	☐	Type reference (TYPE)	BEGDA		Valid from date	20120604
2	Importing	IV_BTRTL	Call by reference	☐	Type reference (TYPE)	BTRTL		Personnel subarea	20120604
3	Importing	IV_ENDDA	Call by reference	☐	Type reference (TYPE)	ENDDA		Valid to date	20120604
4	Importing	IV_PROT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120604
5	Importing	IV_WERKS	Call by reference	☐	Type reference (TYPE)	PERSA		Personnel area	20120604
6	Returning	RO_BRANCH	Value transfer	☐	Object reference (TYPE REF TO)	CL_HRPAYBR_BRANCH		Class for branch	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	NAME1		Name	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_NAME_OBRA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NAME_OBRA	Value transfer	☐	Type reference (TYPE)	PBR_CNAME		Name of construction site	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐		20120604

Method GET_WERKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_WERKS	Value transfer	☐	Type reference (TYPE)	PERSA		Personnel area	20120604

Method GET_WERKS on class CL_HRPAYBR_BRANCH has no exception.

Method READ_BRANCH_CNAE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CNAE	Call by reference	☐	Type reference (TYPE)	PBR_ECONI		Economic activity	20120604
2	Importing	IV_BRANCH	Call by reference	☐	Type reference (TYPE)	J_1BBRANC_		Business place	20120604
3	Importing	IV_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Company code	20120604
4	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Type field DATS	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604
2	CX_HRPAYBR_RECORD_NOT_FOUND	☐	Exception generated when a record is not found in a table	20120604

Method READ_BRANCH_DATA Signature

Method READ_BRANCH_DATA on class CL_HRPAYBR_BRANCH has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604

Method READ_BRANCH_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_COMP_ADDR	Call by reference	☐	Type reference (TYPE)	ADDR1_VAL		Return structure for address	20120604
2	Exporting	EV_CEI	Call by reference	☐	Type reference (TYPE)	PBR_CEI		SRS Specific Register of Social Insurance Body	20120604
3	Exporting	EV_CNPJ	Call by reference	☐	Type reference (TYPE)	J_1BCGC		Code CGC	20120604
4	Exporting	EV_CNPJ_OBRA	Call by reference	☐	Type reference (TYPE)	PBR_NUM_CNPJ		Registration number in the CNPJ	20120604
5	Exporting	EV_COMP_NAME	Call by reference	☐	Type reference (TYPE)	NAME1		Name	20120604
6	Exporting	EV_EMAIL	Call by reference	☐	Type reference (TYPE)	CHAR0241		Character 241	20120604
7	Exporting	EV_GCAGE	Call by reference	☐	Type reference (TYPE)	PBR_GCAGE		GREU guide	20120604
8	Exporting	EV_NAME_OBRA	Call by reference	☐	Type reference (TYPE)	PBR_CNAME		Name of construction site	20120604
9	Importing	IV_BRANCH	Call by reference	☐	Type reference (TYPE)	J_1BBRANC_		Business place	20120604
10	Importing	IV_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Company code	20120604
11	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Type field DATS	20120604
12	Importing	IV_OBRA	Call by reference	☐	Type reference (TYPE)	PBR_OBRA		Construction site code	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604

Method READ_BRANCH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_BRANCH	Call by reference	☐	Type reference (TYPE)	J_1BBRANC_		Business place	20120604
2	Exporting	EV_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Company code	20120604
3	Exporting	EV_OBRA	Call by reference	☐	Type reference (TYPE)	PBR_OBRA		Construction site code	20120604
4	Importing	IV_BEGDA	Call by reference	☐	Type reference (TYPE)	BEGDA	'19000101'	Valid from date	20120604
5	Importing	IV_BTRTL	Call by reference	☐	Type reference (TYPE)	BTRTL		Personnel subarea	20120604
6	Importing	IV_ENDDA	Call by reference	☐	Type reference (TYPE)	ENDDA	'99991231'	Valid to date	20120604
7	Importing	IV_PROT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120604
8	Importing	IV_WERKS	Call by reference	☐	Type reference (TYPE)	PERSA		Personnel area	20120604

#	Exception	Resumable	Description	Created on
1	CX_HRPAYBR_BRANCH	☐	Exception class for branch	20120604

History

Last changed by/on	SAP	20130531
SAP Release Created in