SAP ABAP Class CL_BS_API_ADDRESS (API-class for addresses)

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	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BS_TYPECASTED_MAP_ASSISTANT	Assistant definition for type-casted mapping	20100803

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BS_API_ADDRESS_MDG	API-class for addresses within MDG	20090820

Properties

Class	CL_BS_API_ADDRESS
Short Description	API-class for addresses
Super Class
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	20090819	SAP
Last change	20110908	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	T	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BS_TYPECASTED_MAP_ASSISTANT			Assistant definition for type-casted mapping	20100803

Friends

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

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Description	Created on
1	GO_OBJ_EX_ADDRESS_CHECK	Instance attribute	Private	Object reference (TYPE REF TO)	IF_EX_ADDRESS_CHECK	BAdI interface IF_EX_ADDRESS_CHECK	20091005
2	GO_OBJ_EX_ADDR_TXJCD_CHECK	Instance attribute	Private	Object reference (TYPE REF TO)	IF_EX_ADDR_TXJCD_CHECK	BAdI Interface IF_EX_ADDR_TXJCD_CHECK	20090917
3	GV_ACT_IMP_ADDRESS_CHECK	Instance attribute	Private	Type reference (TYPE)	ABAP_BOOL		20091005
4	GV_ACT_IMP_ADDR_TXJCD_CHECK	Instance attribute	Private	Type reference (TYPE)	ABAP_BOOL		20090917
5	GV_TXJCD_CHECKFUNCTION_EXISTS	Instance attribute	Private	Type reference (TYPE)	ABAP_BOOL		20090917
6	GV_XTXJCD_CHECKFUNCTION_CHECK	Instance attribute	Private	Type reference (TYPE)	ABAP_BOOL		20090917
7	MO_TYPECASTING	Instance attribute	Protected	Object reference (TYPE REF TO)	CL_BS_TYPECASTED_MAPPER	Provides services around type-based mapping	20100803

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADAPT_ADDRESS_FIELDS	Instance method	Protected	Method		20090916
2	ADD_ADDRESS	Instance method	Public	Method	Adds a new address	20090904
3	ADD_ADDRESS_VERSION	Instance method	Public	Method	Adds a new version to an address	20090922
4	ADD_CONTACT	Instance method	Public	Method	Adds new person-data	20090921
5	ADD_EMAIL_ADDRESS	Instance method	Public	Method	Adds a new e-mail address to a given address	20090910
6	ADD_FAX_NUMBER	Instance method	Public	Method	Adds a new fax number to a given address	20090910
7	ADD_PERSON	Instance method	Public	Method	Adds new person data	20090921
8	ADD_PHONE_NUMBER	Instance method	Public	Method	Adds a new phone number to a given address	20090910
9	ADD_URI	Instance method	Public	Method	Adds a new URI to a given address	20090910
10	CHANGE_ADDRESS	Instance method	Public	Method	Changes an existing address	20090907
11	CHANGE_EMAIL_ADDRESS	Instance method	Public	Method	Changes a new e-mail address for a given address and conso.	20090910
12	CHANGE_FAX_NUMBER	Instance method	Public	Method	Changes a new fax number for a given address and conso.	20090910
13	CHANGE_PHONE_NUMBER	Instance method	Public	Method	Changes a new phone number for a given address and conso.	20090910
14	CHANGE_URI	Instance method	Public	Method	Changes a new URI for a given address and conso.	20090910
15	CHECK_ADDR1_DATA	Instance method	Protected	Method		20090916
16	CHECK_ADDRESS	Instance method	Public	Method	Checks address by address type	20090916
17	CHECK_POSTAL_CODE	Instance method	Protected	Method		20090917
18	CHECK_TAXJURCODE	Instance method	Public	Method		20090917
19	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20091001
20	COUNTRY_TEXT	Instance method	Public	Method	determines the text of the given country key	20100301
21	DELETE_ADDRESS	Instance method	Public	Method	Deletes a specific address	20090908
22	DELETE_EMAIL_ADDRESS	Instance method	Public	Method	Deletes a new e-mail address for a given address and conso.	20090910
23	DELETE_FAX_NUMBER	Instance method	Public	Method	Deletes a new fax number for a given address and conso.	20090910
24	DELETE_PHONE_NUMBER	Instance method	Public	Method	Deletes a new phone number for a given address and conso.	20090910
25	DELETE_URI	Instance method	Public	Method	Deletes a new URI for a given address and conso.	20090910
26	ERROR_OCCURED	Instance method	Private	Method		20090917
27	EXCEPTION_MESSAGE_STORE	Instance method	Protected	Method		20090916
28	FORMAT_PHONE_NUMBER	Instance method	Public	Method	Returns a canonical format of the given phone-number	20091009
29	GET_ADDRESS_COUNT	Instance method	Public	Method	Gets amount of addresses currently available	20090908
30	GET_DESCRIPTION	Instance method	Public	Method	Determines formatted 1-line address description	20090902
31	GET_NEW_ADDRESS_NUMBER	Instance method	Protected	Method	Determines the next valid address number	20090922
32	GET_STANDARD_ADDRESS_NUMBER	Instance method	Public	Method	Determines the address number of the standard address	20090911
33	IS_ADDRESS_DATA_INITIAL	Instance method	Public	Method	Checks if the data of the given address is initial	20091124
34	IS_CHECK_ACTIVE_FOR_COUNTRY	Instance method	Public	Method	Calls BAdI implementation of ADDRESS_CHECK	20091008
35	IS_NEW_ADDRESS	Instance method	Public	Method	Determines whether the given address is a new one	20091120
36	IS_NEW_OCCUPATION	Instance method	Public	Method	Determines if addresses are bound to an occupier in creation	20091103
37	LANGUAGE_TEXT	Instance method	Public	Method	determines the text of the given language key	20100301
38	MAP_TYPE_BASED	Instance method	Public	Method	Maps data between structures based on the components' types	20090903
39	READ_ADDRESSES	Instance method	Public	Method	Reads address keys	20090820
40	READ_ADDRESS_DATA	Instance method	Public	Method	Reads address data for a specific address number	20090821
41	READ_EMAIL_ADDRESS	Instance method	Public	Method	Reads an e-mail address for a specific addrno and consno.	20090910
42	READ_EMAIL_ADDRESSES	Instance method	Public	Method	Reads e-mail addresses for a specific address number	20090821
43	READ_FAX_NUMBER	Instance method	Public	Method	Reads a fax number for a specific addrno. and conso.	20090910
44	READ_FAX_NUMBERS	Instance method	Public	Method	Reads fax numbers for a specific address number	20090821
45	READ_PHONE_NUMBER	Instance method	Public	Method	Reads a phone number for a specific addrno. and consno.	20090910
46	READ_PHONE_NUMBERS	Instance method	Public	Method	Reads phone numbers for a specific address number	20090821
47	READ_STANDARD_ADDRESS_DATA	Instance method	Public	Method	Reads standard address	20090911
48	READ_STANDARD_EMAIL_ADDRESS	Instance method	Public	Method	Reads an e-mail address for a specific addrno and consno.	20090927
49	READ_STANDARD_FAX_NUMBER	Instance method	Public	Method	Reads a fax number for a specific addrno. and conso.	20090927
50	READ_STANDARD_PHONE_NUMBER	Instance method	Public	Method	Reads a phone number for a specific addrno. and consno.	20090927
51	READ_STANDARD_URI	Instance method	Public	Method	Reads an URI for a specific addrno. and consno.	20090927
52	READ_URI	Instance method	Public	Method	Reads an URI for a specific addrno. and consno.	20090910
53	READ_URIS	Instance method	Public	Method	Reads URIs for a specific address number	20090821
54	REGION_TEXT	Instance method	Public	Method	determines the text of the given region key	20100301
55	TRANSPORTATION_ZONE_TEXT	Instance method	Public	Method	determines the text of the given transportation zone	20100301
56	TYPE_ALTERNATIVE	Instance method	Public	Method	returns if available an alternative for the given type	20090928

Events

Class CL_BS_API_ADDRESS has no event.

Types

Class CL_BS_API_ADDRESS has no local type.

Method Signatures

Method ADAPT_ADDRESS_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_ADRC_STRUC	Call by reference		Type reference (TYPE)	ADRC_STRUC		Include structure with ADRC attributes without name fields	20090916
2	Exporting	ET_RETURN	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20090916

Method ADAPT_ADDRESS_FIELDS on class CL_BS_API_ADDRESS has no exception.

Method ADD_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ADDRESS_NUMBER	Call by reference		Type reference (TYPE)	AD_ADDRNUM		Address number	20090904
2	Importing	IS_ADDRESS_DATA	Call by reference		Type reference (TYPE)	BSS_ADDRESS_DATA			20090904

Method ADD_ADDRESS on class CL_BS_API_ADDRESS has no exception.

Method ADD_ADDRESS_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ADDRESS_DATA	Call by reference		Type reference (TYPE)	BSS_ADDRESS_DATA			20090922

Method ADD_ADDRESS_VERSION on class CL_BS_API_ADDRESS has no exception.

Method ADD_CONTACT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IS_CONTACT_DATA	Call by reference	Type reference (TYPE)	BSS_ADDRESS_CONTACT_DATA	Contact-Address data as used in API-class	20090921
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090921
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090921

Method ADD_CONTACT on class CL_BS_API_ADDRESS has no exception.

Method ADD_EMAIL_ADDRESS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
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_EMAIL_ADDRESS	Call by reference	Type reference (TYPE)	BAPIADSMTP	BAPI Structure for E-Mail Addresses (Bus. Address Services)	20090916
4	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
5	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method ADD_EMAIL_ADDRESS on class CL_BS_API_ADDRESS has no exception.

Method ADD_FAX_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
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_FAX_NUMBER	Call by reference	Type reference (TYPE)	BAPIADFAX	BAPI Structure for Fax Numbers (Business Address Services)	20090916
4	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
5	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method ADD_FAX_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method ADD_PERSON Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090921
2	Importing	IS_PERSON_DATA	Call by reference	Type reference (TYPE)	BSS_ADDRESS_PERSON_DATA	Person-Address data as used in API-class	20090921
3	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090921

Method ADD_PERSON on class CL_BS_API_ADDRESS has no exception.

Method ADD_PHONE_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
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_PHONE_NUMBER	Call by reference	Type reference (TYPE)	BAPIADTEL	Telephone Number Data Transfer Structure (BAS)	20090910
4	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
5	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method ADD_PHONE_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method ADD_URI Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
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_URI	Call by reference	Type reference (TYPE)	BAPIADURI	BAPI Structure for URI Addresses (Business Address Services)	20090916
4	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
5	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method ADD_URI on class CL_BS_API_ADDRESS has no exception.

Method CHANGE_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ADDRESS_DATA	Call by reference		Type reference (TYPE)	BSS_ADDRESS_DATA			20090917
2	Importing	IV_ADDRESS_NUMBER	Call by reference		Type reference (TYPE)	AD_ADDRNUM		Address number	20090907

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090922

Method CHANGE_EMAIL_ADDRESS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IS_EMAIL_ADDRESS	Call by reference	Type reference (TYPE)	BAPIADSMTP	BAPI Structure for E-Mail Addresses (Bus. Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
4	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 CHANGE_FAX_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IS_FAX_NUMBER	Call by reference	Type reference (TYPE)	BAPIADFAX	BAPI Structure for Fax Numbers (Business Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
4	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 CHANGE_PHONE_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IS_PHONE_NUMBER	Call by reference	Type reference (TYPE)	BAPIADTEL	Telephone Number Data Transfer Structure (BAS)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
4	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 CHANGE_URI Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IS_URI	Call by reference	Type reference (TYPE)	BAPIADURI	BAPI Structure for URI Addresses (Business Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
4	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 CHECK_ADDR1_DATA Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Changing	CS_ADDR1_DATA	Call by reference	Type reference (TYPE)	BSS_ADDRESS_DATA	Address data as used in the API class	20090917
2	Exporting	ET_RETURN	Call by reference	Type reference (TYPE)	BAPIRET2_T	Return parameter table	20090916
3	Importing	IV_SUPPRESS_TAXJUR_CHECK	Call by reference	Type reference (TYPE)	ABAP_BOOL		20091005

Method CHECK_ADDR1_DATA on class CL_BS_API_ADDRESS has no exception.

Method CHECK_ADDRESS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Changing	CS_ADDRESS_DATA_1	Call by reference	Type reference (TYPE)	BSS_ADDRESS_DATA	Address data (type 1) as used in the API class	20090917
2	Exporting	ET_RETURN	Call by reference	Type reference (TYPE)	BAPIRET2_T	Return parameter table	20090916
3	Importing	IV_ADDRESS_OBJECT_TYPE	Call by reference	Type reference (TYPE)	AD_ADRTYPE	Address type (1=Organization, 2=Person, 3=Contact person)	20090916
4	Importing	IV_SUPPRESS_TAXJUR_CHECK	Call by reference	Type reference (TYPE)	ABAP_BOOL		20091005

Method CHECK_ADDRESS on class CL_BS_API_ADDRESS has no exception.

Method CHECK_POSTAL_CODE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_RETURN	Call by reference	Type reference (TYPE)	BAPIRET2_T	Return parameter table	20090917
2	Importing	IS_POSTAL_ADDRESS	Call by reference	Type reference (TYPE)	ADRS_POST	Postal part of an address (for address formatting)	20090917
3	Importing	IV_COUNTRY	Call by reference	Type reference (TYPE)	LAND1	Country Key	20090917

Method CHECK_POSTAL_CODE on class CL_BS_API_ADDRESS has no exception.

Method CHECK_TAXJURCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_ADDRESS1_DATA	Call by reference		Type reference (TYPE)	BSS_ADDRESS_DATA		Address data as used in the API class	20090917
2	Exporting	ET_RETURN	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20090917

Method CHECK_TAXJURCODE on class CL_BS_API_ADDRESS has no exception.

Method CONSTRUCTOR Signature

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

Method COUNTRY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COUNTRY_KEY	Call by reference		Type reference (TYPE)	LAND1		Country Key	20100301
2	Returning	RV_COUNTRY_TEXT	Value transfer		Type reference (TYPE)	STRING			20100301

Method COUNTRY_TEXT on class CL_BS_API_ADDRESS has no exception.

Method DELETE_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	20090908

Method DELETE_ADDRESS on class CL_BS_API_ADDRESS has no exception.

Method DELETE_EMAIL_ADDRESS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
2	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method DELETE_EMAIL_ADDRESS on class CL_BS_API_ADDRESS has no exception.

Method DELETE_FAX_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
2	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method DELETE_FAX_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method DELETE_PHONE_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
2	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090916
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method DELETE_PHONE_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method DELETE_URI Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
2	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM		20090916
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090925

Method DELETE_URI on class CL_BS_API_ADDRESS has no exception.

Method ERROR_OCCURED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MESSAGES	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20090917
2	Returning	RV_ERROR_OCCURED	Value transfer		Type reference (TYPE)	ABAP_BOOL			20090917

Method ERROR_OCCURED on class CL_BS_API_ADDRESS has no exception.

Method EXCEPTION_MESSAGE_STORE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20090916
2	Importing	IV_FIELD	Call by reference		Type reference (TYPE)	BAPI_FLD		Field in parameter	20090916

Method EXCEPTION_MESSAGE_STORE on class CL_BS_API_ADDRESS has no exception.

Method FORMAT_PHONE_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_CANONICAL_FORMAT	Call by reference	Type reference (TYPE)	SP_TELNO	Canonical Format of Telephone number	20091009
2	Importing	IV_COUNTRY	Call by reference	Type reference (TYPE)	LAND1	Country Key	20091009
3	Importing	IV_EXTENSION	Call by reference	Type reference (TYPE)	ADR2-TEL_EXTENS	Telephone no.: Extension	20091009
4	Importing	IV_PHONE_NUMBER	Call by reference	Type reference (TYPE)	ADR2-TEL_NUMBER	Telephone no.: dialling code+number	20091009
5	Importing	IV_WILDCARDS	Call by reference	Type reference (TYPE)	SP_OPTION	SAPphone: Setting for handling incoming calls	20091009

Method FORMAT_PHONE_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method GET_ADDRESS_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WITH_VERSIONS	Call by reference		Type reference (TYPE)	ABAP_BOOL	' '	Indicator: Addresses counted inclusively all versions	20100208
2	Returning	RT_COUNT	Value transfer		Type reference (TYPE)	SYTABIX		Index of Internal Tables	20090908

Method GET_ADDRESS_COUNT on class CL_BS_API_ADDRESS has no exception.

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_DESCRIPTION	Value transfer	Type reference (TYPE)	AD_LINE_S		One-line short form of formatted address	20090902
2	Importing	IS_ADDRESS_DATA	Call by reference	Type reference (TYPE)	BSS_ADDRESS_DATA			20090907
3	Importing	IS_ADDRESS_DATA_GENIL	Call by reference	Type reference (TYPE)	BSS_ADIL_ROOT_ATTRIBUTES		Attributes Structure for ADDR GenIL Root Object	20100803
4	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM		Address number	20090902
5	Importing	IV_SHORT_FORM	Call by reference	Type reference (TYPE)	ABAP_BOOL	' '	'X' -> return the short form of the address description	20091120
6	Importing	IV_WITH_NAME	Call by reference	Type reference (TYPE)	ABAP_BOOL	' '	'X' -> descriptions contains name parts	20091022

Method GET_DESCRIPTION on class CL_BS_API_ADDRESS has no exception.

Method GET_NEW_ADDRESS_NUMBER Signature

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

Method GET_NEW_ADDRESS_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method GET_STANDARD_ADDRESS_NUMBER Signature

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

Method GET_STANDARD_ADDRESS_NUMBER on class CL_BS_API_ADDRESS has no exception.

Method IS_ADDRESS_DATA_INITIAL 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	20091124
2	Returning	RV_IS_ADDRESS_DATA_INITIAL	Value transfer		Type reference (TYPE)	ABAP_BOOL			20091124

Method IS_ADDRESS_DATA_INITIAL on class CL_BS_API_ADDRESS has no exception.

Method IS_CHECK_ACTIVE_FOR_COUNTRY Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_ACTIVE	Call by reference	Type reference (TYPE)	T_BOOLE		20091008
2	Exporting	EV_SUPPRESS_CHECK_BEFORE	Call by reference	Type reference (TYPE)	T_BOOLE		20091008
3	Importing	IV_COUNTRY	Call by reference	Type reference (TYPE)	LAND1	Country Key	20091008
4	Importing	IV_COUNTRY_ISO	Call by reference	Type reference (TYPE)	INTCA	Country ISO code	20091008

Method IS_CHECK_ACTIVE_FOR_COUNTRY on class CL_BS_API_ADDRESS has no exception.

Method IS_NEW_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	20091120
2	Returning	RV_IS_NEW_ADDRESS	Value transfer		Type reference (TYPE)	ABAP_BOOL			20091120

Method IS_NEW_ADDRESS on class CL_BS_API_ADDRESS has no exception.

Method IS_NEW_OCCUPATION Signature

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

Method IS_NEW_OCCUPATION on class CL_BS_API_ADDRESS has no exception.

Method LANGUAGE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE_KEY	Call by reference		Type reference (TYPE)	SPRAS			20100301
2	Returning	RV_LANGUAGE_TEXT	Value transfer		Type reference (TYPE)	STRING			20100301

Method LANGUAGE_TEXT on class CL_BS_API_ADDRESS has no exception.

Method MAP_TYPE_BASED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_TARGET_STRUCTURE	Call by reference		Type reference (TYPE)	ANY			20090903
2	Importing	IS_SOURCE_STRUCTURE	Call by reference		Type reference (TYPE)	ANY			20090903

Method MAP_TYPE_BASED on class CL_BS_API_ADDRESS has no exception.

Method READ_ADDRESSES Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ALL_VERSIONS	Call by reference	Type reference (TYPE)	ABAP_BOOL	' '	Read all address versions?	20090910
2	Importing	IV_NATION	Call by reference	Type reference (TYPE)	AD_NATION		International address version ID	20090910
3	Returning	RT_ADDRESSES	Value transfer	Type reference (TYPE)	BST_ADDRESS_DATA		List of addresses as used in API class	20090821

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090922

Method READ_ADDRESS_DATA Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_ADDRESS_DATA	Call by reference	Type reference (TYPE)	BSS_ADDRESS_DATA		20090821
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090821
3	Importing	IV_NATION	Call by reference	Type reference (TYPE)	AD_NATION	International address version ID	20090910

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090922

Method READ_EMAIL_ADDRESS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_EMAIL_ADDRESS	Call by reference	Type reference (TYPE)	BAPIADSMTP	BAPI Structure for E-Mail Addresses (Bus. Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
4	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_EMAIL_ADDRESSES Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_EMAIL_ADDRESSES	Call by reference	Type reference (TYPE)	BST_BAPIADSMTP	List of e-mail-adresses as used in API class	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	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_FAX_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_FAX_NUMBER	Call by reference	Type reference (TYPE)	BAPIADFAX	BAPI Structure for Fax Numbers (Business Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
4	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_FAX_NUMBERS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_FAX_NUMBERS	Call by reference	Type reference (TYPE)	BST_BAPIADFAX	List of fax numbers as used in API class	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	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_PHONE_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_PHONE_NUMBER	Call by reference	Type reference (TYPE)	BAPIADTEL	BAPI Structure for Telephone Numbers (Bus. Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
4	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_PHONE_NUMBERS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_PHONE_NUMBERS	Call by reference	Type reference (TYPE)	BST_BAPIADTEL	List of phone numbers as used in API class	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	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_STANDARD_ADDRESS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ADDRESS_DATA	Call by reference		Type reference (TYPE)	BSS_ADDRESS_DATA		Address data as used in the API class	20090911
2	Importing	IV_NATION	Call by reference		Type reference (TYPE)	AD_NATION		International address version ID	20090911

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090922

Method READ_STANDARD_EMAIL_ADDRESS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_EMAIL_ADDRESS	Call by reference	Type reference (TYPE)	BAPIADSMTP	BAPI Structure for E-Mail Addresses (Bus. Address Services)	20090927
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090927
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090927

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090927

Method READ_STANDARD_FAX_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_FAX_NUMBER	Call by reference	Type reference (TYPE)	BAPIADFAX	BAPI Structure for Fax Numbers (Business Address Services)	20090927
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090927
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090927

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090927

Method READ_STANDARD_PHONE_NUMBER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_PHONE_NUMBER	Call by reference	Type reference (TYPE)	BAPIADTEL	BAPI Structure for Telephone Numbers (Bus. Address Services)	20090927
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090927
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090927

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090927

Method READ_STANDARD_URI Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_URI	Call by reference	Type reference (TYPE)	BAPIADURI	BAPI Structure for URI Addresses (Business Address Services)	20090927
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090927
3	Importing	IV_PERSON_NUMBER	Call by reference	Type reference (TYPE)	AD_PERSNUM	Person number	20090927

#	Exception	Resumable	Description	Created on
1	NOT_FOUND			20090927

Method READ_URI Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_URI	Call by reference	Type reference (TYPE)	BAPIADURI	BAPI Structure for URI Addresses (Business Address Services)	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	Importing	IV_CONSNUMBER	Call by reference	Type reference (TYPE)	AD_CONSNUM	Sequence number	20090910
4	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_URIS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_URIS	Call by reference	Type reference (TYPE)	BST_BAPIADURI	List of URIs as used in API c lass	20090910
2	Importing	IV_ADDRESS_NUMBER	Call by reference	Type reference (TYPE)	AD_ADDRNUM	Address number	20090910
3	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 REGION_TEXT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_COUNTRY_KEY	Call by reference	Type reference (TYPE)	LAND1	Country Key	20100301
2	Importing	IV_REGION_KEY	Call by reference	Type reference (TYPE)	REGIO	Region (State, Province, County)	20100301
3	Returning	RV_REGION_TEXT	Value transfer	Type reference (TYPE)	STRING		20100301

Method REGION_TEXT on class CL_BS_API_ADDRESS has no exception.

Method TRANSPORTATION_ZONE_TEXT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_COUNTRY_KEY	Call by reference	Type reference (TYPE)	LAND1	Country Key	20100301
2	Importing	IV_TRANSPORTATION_ZONE	Call by reference	Type reference (TYPE)	LZONE	Transportation zone to or from which the goods are delivered	20100301
3	Returning	RV_TZONE_TEXT	Value transfer	Type reference (TYPE)	STRING		20100301

Method TRANSPORTATION_ZONE_TEXT on class CL_BS_API_ADDRESS has no exception.

Method TYPE_ALTERNATIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ABSOLUTE_NAME	Call by reference		Type reference (TYPE)	ABAP_ABSTYPENAME			20090928
2	Returning	RV_ABSOLUTE_NAME	Value transfer		Type reference (TYPE)	ABAP_ABSTYPENAME			20090928

Method TYPE_ALTERNATIVE on class CL_BS_API_ADDRESS has no exception.

History

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

Object Hierarchy

Using

Used by

Advertise Links