SAP ABAP Class CL_BS_API_ADDRESS_MDG (API-class for addresses within MDG)

Hierarchy

☛ MDG_FND (Software Component) MDG Foundation
   ⤷ CA-MDG-APP-BP (Application Component) MDG Business Partner (Central Part)
     ⤷ MDG_BS_BP_MODEL (Package) MDG: Business Partner - Model

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BS_API_ADDRESS	API-class for addresses	20090820
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_INTERFACE	Tag Interface for BAdIs	20090904
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_EX_USMD_UI_EVENT2	Single Processing: BAdI for User Interface	20090904

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BS_API_ADDRESS_MDG_BP	API-class for BP-addresses	20090917

Properties

Class	CL_BS_API_ADDRESS_MDG
Short Description	API-class for addresses within MDG
Super Class	CL_BS_API_ADDRESS	API-class for addresses
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	MDG_BS_BP_MODEL	MDG: Business Partner - Model
Created	20090820	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	USMD0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20090904
2	IF_EX_USMD_UI_EVENT2	☐	☐	Single Processing: BAdI for User Interface	20090904

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BS_API_FACTORY_ADDRESS	☐	20091001	API-factory for address API-class

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ADDRESS_ENTITY	Instance attribute	Public	☑	Type reference (TYPE)	USMD_ENTITY	'ADDRESS'	Entity name of address basis	20090910
2	GC_ADDRESS_HOOK_ENTITY	Instance attribute	Public	☑	Type reference (TYPE)	USMD_ENTITY		Entity name of entity that relates to addresses	20090910
3	GC_ADDRESS_NUMBER	Instance attribute	Public	☑	Type reference (TYPE)	STRING	'ADDRNO'	Name of the field that contains the address number	20090909
4	GC_EVENT_ID_CHANGE_VERSION	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_ID	'USMD_CHANGE_VERSION'	ID of the FPM Event	20090917
5	GC_EVENT_ID_SUBMIT	Constant	Public	☐	Type reference (TYPE)	FPM_EVENT_ID	'USMD_SUBMIT'	ID of the FPM Event	20090925
6	GC_NUMBER_RANGE	Instance attribute	Public	☑	Type reference (TYPE)	INRI-NRRANGENR	'01'	Number range number	20090914
7	GC_NUMBER_RANGE_OBJECT	Instance attribute	Public	☑	Type reference (TYPE)	INRI-OBJECT	'MDG_ADDR'	Name of number range object	20090914
8	GS_CONTEXT	Instance attribute	Protected	☐	Type reference (TYPE)	USMD_S_UI_CONTEXT2			20090820
9	GT_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	USMD_TS_ENTITY_DATA			20090820
10	GT_KEY_FIELDS	Instance attribute	Protected	☐	Type reference (TYPE)	USMD_TS_VALUE			20090820
11	GV_EDIT_MODE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Indicator whether the edit mode is active	20091126
12	GV_EDIT_MODE_SET	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	' '	Indicator: Edit mode set from caller	20091126
13	GV_INIT_WITH_EMPTY_ADDRESS	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	' '	Indicates that an initial address defaults for new occupier	20091103
14	GV_MDG_FW_ADDRESS_NUMBERING	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	'X'	Indicator whether FW specific address numbering is needed	20091123
15	GV_MODEL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_USMD_MODEL_EXT		MDM Data Model for Access from Non-SAP-Standard Code	20090904
16	GV_READ_PRIMARY_PERSISTENCE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	' '		20090915
17	GV_SELECTED_ADDRESS_NUMBER	Instance attribute	Protected	☐	Type reference (TYPE)	AD_ADDRNUM		Address number of the line currently selected in address-lis	20090926

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACCUMULATE_DATA	Instance method	Protected	Method	Copies data to framework-memory	20090926
2	ACCUMULATE_DATA_FOR_ENTITY	Instance method	Protected	Method	Copies data to framework-memory for the given entity	20090926
3	ADD_COMMUNICATION_LINE	Instance method	Protected	Method	Adds an existing communication-line	20090916
4	CHANGE_COMMUNICATION_LINE	Instance method	Protected	Method	Changes an existing communication-line	20090916
5	CLEAN_UP_DATA_FOR_ENTITY	Instance method	Protected	Method	Cleans up data for the given entity (e.g. delete initial)	20091111
6	COMPLEMENT_ADDRESS_DATA	Instance method	Protected	Method	Complements the address data by the hook-entity	20090909
7	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090910
8	DELETE_COMMUNICATION_LINE	Instance method	Protected	Method	Deletes line(s) of comm.-data for a specific addrno.	20090916
9	DETERMINE_ADDRESS_NUMBER_FIELD	Instance method	Protected	Method	Determines the fieldname of the address-number field	20091008
10	FILL_BUFFER	Instance method	Protected	Method	Fill buffer of local memory	20120612
11	GET_ADDRESS_NUMBER_AT_INDEX	Instance method	Public	Method	Determines the address-number at the given line-index	20090909
12	GET_ENTITY_DATA	Instance method	Protected	Method	Returns a reference to the given entity's data	20090907
13	GET_LINE_INDEX_OF_ADDRESS	Instance method	Public	Method	Determines the line-index of the given address-number	20090909
14	GET_SELECTED_ADDRESS_NUMBER	Instance method	Public	Method	returns the currently selected address-number	20090926
15	GET_STD_FLAG_FIELD_FOR_ENTITY	Instance method	Public	Method	determine the field that contains the standard-flag	20090927
16	INIT_WITH_EMPTY_ADDRESS	Instance method	Public	Method	defines whether an empty address should be defaulted	20091103
17	IS_EDIT_MODE_ACTIVE	Instance method	Public	Method	Indicates whether edit-mode is currently active	20090902
18	ON_ADDRESS_SELECTION_CHANGED	Instance method	Protected	Event handling method	Reacts on changes in the address-list selection	20090926
19	PERMUTE_STANDARD_FLAG	Instance method	Protected	Method	Permutes standard-flag to the given communication-line	20091109
20	READ_COMMUNICATION_LINE	Instance method	Protected	Method	Reads a line of comm.-data for a specific addrno. and consn	20090911
21	READ_COMMUNICATION_TABLE	Instance method	Protected	Method	Reads a list of comm.-data for a specific address number	20090910
22	REFRESH_BUFFERS	Instance method	Public	Method	Resets all local data	20100122
23	SET_ADDRESS_HOOK_ENTITY	Instance method	Public	Method	Defines the current address-hook-entity (see constructor)	20090910
24	SET_EDIT_MODE	Instance method	Public	Method	Sets or unsets the edit mode	20091126

Events

Class CL_BS_API_ADDRESS_MDG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ADDR1_DATA_T	Protected	See coding			20090903	addr1_data_t TYPE STANDARD TABLE OF addr1_data

Method Signatures

Method ACCUMULATE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DATA	Call by reference	☐	Type reference (TYPE)	USMD_TS_ENTITY_DATA		UI Data	20090926

Method ACCUMULATE_DATA on class CL_BS_API_ADDRESS_MDG has no exception.

Method ACCUMULATE_DATA_FOR_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DATA	Call by reference	☐	Type reference (TYPE)	USMD_TS_ENTITY_DATA		UI Data	20090926
2	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY			20090926

Method ACCUMULATE_DATA_FOR_ENTITY on class CL_BS_API_ADDRESS_MDG has no exception.

Method ADD_COMMUNICATION_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONSNUMBER	Call by reference	☐	Type reference (TYPE)	AD_CONSNUM		Sequence number	20090916
2	Exporting	EV_IS_STANDARD_LINE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Indicator that given line is standard line now	20091109
3	Importing	IS_COMMUNICATION_LINE	Call by reference	☐	Type reference (TYPE)	ANY			20090916
4	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090916
5	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20090916
6	Importing	IV_PERSON_NUMBER	Call by reference	☑	Type reference (TYPE)	AD_PERSNUM		Person number	20090925

Method ADD_COMMUNICATION_LINE on class CL_BS_API_ADDRESS_MDG has no exception.

Method CHANGE_COMMUNICATION_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COMMUNICATION_LINE	Call by reference	☐	Type reference (TYPE)	ANY			20090916
2	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090916
3	Importing	IV_CONSNUMBER	Call by reference	☐	Type reference (TYPE)	AD_CONSNUM		Sequence number	20090916
4	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20090916
5	Importing	IV_PERSON_NUMBER	Call by reference	☑	Type reference (TYPE)	AD_PERSNUM		Person number	20090925

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20090922

Method CLEAN_UP_DATA_FOR_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DATA	Call by reference	☐	Type reference (TYPE)	USMD_TS_ENTITY_DATA		UI Data	20091111
2	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY			20091111

Method CLEAN_UP_DATA_FOR_ENTITY on class CL_BS_API_ADDRESS_MDG has no exception.

Method COMPLEMENT_ADDRESS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FROM_PRIMARY_PERSISTENCE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	X=omit staging, only read active version	20090914
2	Importing	IV_REFRESH_DATA	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	X=re-read data completely	20090914

Method COMPLEMENT_ADDRESS_DATA on class CL_BS_API_ADDRESS_MDG has no exception.

Method CONSTRUCTOR Signature

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

Method DELETE_COMMUNICATION_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090916
2	Importing	IV_CONSNUMBER	Call by reference	☐	Type reference (TYPE)	AD_CONSNUM		Sequence number	20090916
3	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY			20090916
4	Importing	IV_PERSON_NUMBER	Call by reference	☑	Type reference (TYPE)	AD_PERSNUM		Person number	20090925

Method DELETE_COMMUNICATION_LINE on class CL_BS_API_ADDRESS_MDG has no exception.

Method DETERMINE_ADDRESS_NUMBER_FIELD Signature

Method DETERMINE_ADDRESS_NUMBER_FIELD on class CL_BS_API_ADDRESS_MDG has no parameter.
Method DETERMINE_ADDRESS_NUMBER_FIELD on class CL_BS_API_ADDRESS_MDG has no exception.

Method FILL_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	USMD_TS_ENTITY_DATA		UI Data	20120612

Method FILL_BUFFER on class CL_BS_API_ADDRESS_MDG has no exception.

Method GET_ADDRESS_NUMBER_AT_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX			20090909
2	Returning	RV_ADDRESS_NUMBER	Value transfer	☐	Type reference (TYPE)	AD_ADDRNUM			20090909

Method GET_ADDRESS_NUMBER_AT_INDEX on class CL_BS_API_ADDRESS_MDG has no exception.

Method GET_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20090907
2	Importing	IV_CREATE_IF_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	Shall the entity-entry be created if it doesn't exist?	20091009
3	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20090907

Method GET_ENTITY_DATA on class CL_BS_API_ADDRESS_MDG has no exception.

Method GET_LINE_INDEX_OF_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090909
2	Returning	RV_INDEX	Value transfer	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20090909

Method GET_LINE_INDEX_OF_ADDRESS on class CL_BS_API_ADDRESS_MDG has no exception.

Method GET_SELECTED_ADDRESS_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ADDRESS_NUMBER	Value transfer	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090926

Method GET_SELECTED_ADDRESS_NUMBER on class CL_BS_API_ADDRESS_MDG has no exception.

Method GET_STD_FLAG_FIELD_FOR_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20090927
2	Returning	RV_FIELDNAME	Value transfer	☐	Type reference (TYPE)	STRING		name of the field that contains the standard flag	20090927

Method GET_STD_FLAG_FIELD_FOR_ENTITY on class CL_BS_API_ADDRESS_MDG has no exception.

Method INIT_WITH_EMPTY_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INIT_WITH_EMPTY_ADDRESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20091103

Method INIT_WITH_EMPTY_ADDRESS on class CL_BS_API_ADDRESS_MDG has no exception.

Method IS_EDIT_MODE_ACTIVE Signature

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

Method IS_EDIT_MODE_ACTIVE on class CL_BS_API_ADDRESS_MDG has no exception.

Method ON_ADDRESS_SELECTION_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EV_CURRENT_ADDRESS_NUMBER	Call by reference	☐	Attribute reference (LIKE)				20090926
2	Importing	EV_PREVIOUS_ADDRESS_NUMBER	Call by reference	☐	Attribute reference (LIKE)				20090926

Method ON_ADDRESS_SELECTION_CHANGED on class CL_BS_API_ADDRESS_MDG has no exception.

Method PERMUTE_STANDARD_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_STANDARD_LINE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Indicator that given line is now standard line	20091109
2	Importing	IS_COMMUNICATION_LINE	Call by reference	☐	Type reference (TYPE)	ANY			20091109
3	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20091109
4	Importing	IV_CONSNUMBER	Call by reference	☑	Type reference (TYPE)	AD_CONSNUM		Sequence number	20091109
5	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20091109
6	Importing	IV_PERSON_NUMBER	Call by reference	☑	Type reference (TYPE)	AD_PERSNUM		Person number	20091109

Method PERMUTE_STANDARD_FLAG on class CL_BS_API_ADDRESS_MDG has no exception.

Method READ_COMMUNICATION_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_COMMUNICATION_LINE	Call by reference	☐	Type reference (TYPE)	ANY		Line of communication data	20090911
2	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090911
3	Importing	IV_CONSNUMBER	Call by reference	☑	Type reference (TYPE)	AD_CONSNUM		Sequence number	20090911
4	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY			20090911
5	Importing	IV_PERSON_NUMBER	Call by reference	☑	Type reference (TYPE)	AD_PERSNUM		Person number	20090925

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20090922

Method READ_COMMUNICATION_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMUNICATION_TABLE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		List of communication data	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Address number	20090927
3	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY			20090910
4	Importing	IV_PERSON_NUMBER	Call by reference	☐	Type reference (TYPE)	AD_PERSNUM		Person number	20090927

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20090922

Method REFRESH_BUFFERS Signature

Method REFRESH_BUFFERS on class CL_BS_API_ADDRESS_MDG has no parameter.
Method REFRESH_BUFFERS on class CL_BS_API_ADDRESS_MDG has no exception.

Method SET_ADDRESS_HOOK_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESS_HOOK_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20090910

Method SET_ADDRESS_HOOK_ENTITY on class CL_BS_API_ADDRESS_MDG has no exception.

Method SET_EDIT_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20091126

Method SET_EDIT_MODE on class CL_BS_API_ADDRESS_MDG has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	702