SAP ABAP Class CL_CAM_REF_BCS (BCS: Address References)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-COM (Application Component) Communication Services: Mail, Fax, SMS, Telephony
     ⤷ SBCOMS (Package) Business Communication Service

Properties

Class	CL_CAM_REF_BCS
Short Description	BCS: Address References
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SBCOMS	Business Communication Service
Created	20071108	SAP
Last change	20080612	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CAM_REF_BCS has no forward declaration.

Interfaces

Class CL_CAM_REF_BCS has no interface implemented.

Friends

Class CL_CAM_REF_BCS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_OWNED_BY_DOC	Constant	Private	☐	Type reference (TYPE)	PERS_REF-OWNER	'D'	SOMG belongs to document	20071210
2	GC_OWNER_DELETED	Constant	Private	☐	Type reference (TYPE)	PERS_REF-OWNER	'X'	SOMG belongs to deleted document	20071210
3	GC_REL_DEL	Constant	Private	☐	Type reference (TYPE)	STRING	'DELE'		20071210
4	GC_REL_DEL_TEST	Constant	Private	☐	Type reference (TYPE)	STRING	'DELT'		20071210
5	GC_REL_DLI	Constant	Private	☐	Type reference (TYPE)	STRING	'DDLI'		20071210
6	GC_REL_DOCS	Constant	Private	☐	Type reference (TYPE)	STRING	'DOCS'		20071210
7	GO_ALV	Static Attribute	Public	☐	Object reference (TYPE REF TO)	CL_CAM_ALV_BCS		ALV Manager for CAM REF	20071210
8	MT_ADDR_MAP	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_ADDR_MAP		Buffer for New SO_KEYs	20071210
9	MT_ADRV	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_ADRV		Deletion Buffer	20071210
10	MT_ADRVP	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_ADRVP		Deletion Buffer	20071210
11	MT_BCST_CAM	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_BCST_CAM		Deletion Buffer	20071210
12	MT_DOCS	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_SOOD		Documents that use the address	20071210
13	MT_REF_LOG	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_LOG		ADRVP Records Found	20071210
14	MT_SOER	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_SOER		Deletion Buffer	20071210
15	MT_SOES	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_SOES		Deletion Buffer	20071210
16	MT_SOMG	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_SOMG		Deletion Buffer	20071210
17	MT_SOOD	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_SOOD		Deletion Buffer	20071210
18	MT_SOOS	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_SOOS		Deletion Buffer	20071210
19	MT_TAB_CNT	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_TABCNT		Table Deletion Counter	20071210
20	MT_TAB_LOG	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_MT_LOG		BCS records found without errors	20071210
21	MV_ADDRNUMBER	Instance attribute	Private	☐	Type reference (TYPE)	AD_ADDRNUM		Address Number	20071210
22	MV_NAME_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	ADRP-NAME_TEXT		Complete Personal Name	20071210
23	MV_PERSNUMBER	Instance attribute	Private	☐	Type reference (TYPE)	AD_PERSNUM		Person Number	20071210
24	MV_SO_KEY	Instance attribute	Private	☐	Type reference (TYPE)	ADCP-SO_KEY		SAP-Office key	20071210

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADDRESS_NAME	Static method	Public	Method	Get Visible Name	20071210
2	ADD_TAB_CNT	Instance method	Private	Method	Enter Deleted Entries in Deletion Counter	20071210
3	CHECK_DELETED	Instance method	Public	Method	Check for references of nonexistent objects	20071210
4	CREATE	Static method	Public	Method	Create Instance for Address	20071210
5	CREATE_BUPA_BCS	Static method	Public	Method	Create Instance of cl_bupa_bcs	20071210
6	CREATE_FROM_BUPA	Static method	Public	Method	Create Instance for BUPA	20071210
7	DELETE_BAS_REFS	Instance method	Private	Method	Delete References	20071210
8	DELETE_DOCS	Instance method	Public	Method	Set Send Requests to "to delete" and Release References	20071210
9	DETERMINE_DOCS	Instance method	Private	Method	Get SOOD Information from Entries	20071210
10	FIND_ADDRESS	Static method	Public	Method	Get Address from String (with Dialog)	20071210
11	FIND_REFERENCES	Instance method	Public	Method	Get BCS References	20071210
12	FIND_UNIQUE_TYPE12	Static method	Private	Method	Get Type 1, 2 Address from String (if Unique)	20071210
13	FREE_DELETED	Instance method	Public	Method	Delete References of Nonexistent Objects	20071210
14	GET_NEW_KEY	Instance method	Private	Method	Get New so_key (Direct Address) (create if necessary)	20071210
15	GET_NEW_KEY_SOO	Instance method	Private	Method	get_new_key Wrapper for SOOS and SOOD	20071210
16	READ_RECIPIENT_KEY	Static method	Public	Method	RECIPIENT String from SOMG Key	20071210
17	READ_TABLES	Instance method	Private	Method	Get BCS Where-Used List	20071210
18	REF_EXISTS	Instance method	Private	Method	Check Entries Against (Predetermined) ADRVP	20071210
19	RELEASE_FROM_DOCS	Instance method	Public	Method	Release BCS References	20071210
20	REMOVE_FROM_DLIS	Instance method	Public	Method	Remove Addresses from Distribution Lists and Forwards	20071210
21	RESET	Instance method	Public	Method	Initialize Tables	20071210
22	SADRFD_TO_STRING	Static method	Public	Method	Convert Fax Address	20071210
23	SEARCH_HELP	Static method	Public	Method	Search Using ADDRESS Search Help	20071210
24	STRING_TO_SADRFD	Static method	Public	Method	Convert Fax Address	20071210
25	UPDATE_TABLES	Instance method	Private	Method	DB Updates for BCS Tables	20071210
26	WRITE_LIST	Instance method	Private	Method	Write List	20071210

Events

Class CL_CAM_REF_BCS has no event.

Types

Class CL_CAM_REF_BCS has no local type.

Method Signatures

Method ADDRESS_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NAME_TEXT	Value transfer	☐	Type reference (TYPE)	CLIKE			20071210
2	Exporting	EV_SO_KEY	Value transfer	☐	Type reference (TYPE)	ADCP-SO_KEY			20071210
3	Importing	IV_ADDRNUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM			20071210
4	Importing	IV_EXTERN_ONLY	Call by reference	☐	Type reference (TYPE)	OS_BOOLEAN	'X'	Boolean	20071210
5	Importing	IV_PERSNUMBER	Call by reference	☐	Type reference (TYPE)	AD_PERSNUM			20071210

#	Exception	Resumable	Description	Created on
1	CX_ADDRESS_BCS	☐		20071210

Method ADD_TAB_CNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CNT	Call by reference	☑	Type reference (TYPE)	I			20071210
2	Importing	IV_TAB	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210

Method ADD_TAB_CNT on class CL_CAM_REF_BCS has no exception.

Method CHECK_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NOTHING_TO_DO	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20071210

Method CHECK_DELETED on class CL_CAM_REF_BCS has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRNUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM			20071210
2	Importing	IV_PERSNUMBER	Call by reference	☐	Type reference (TYPE)	AD_PERSNUM			20071210
3	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CAM_REF_BCS			20071210

Method CREATE on class CL_CAM_REF_BCS has no exception.

Method CREATE_BUPA_BCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARTNER	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210
2	Returning	RO_BUPA	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20071210

#	Exception	Resumable	Description	Created on
1	CX_BCS	☐		20071210

Method CREATE_FROM_BUPA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARTNER	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CAM_REF_BCS			20071210

#	Exception	Resumable	Description	Created on
1	CX_BCS	☐		20071210

Method DELETE_BAS_REFS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODE	Call by reference	☑	Type reference (TYPE)	CLIKE		Boolean	20071210
2	Returning	RV_NOTHING_TO_DO	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20071210

Method DELETE_BAS_REFS on class CL_CAM_REF_BCS has no exception.

Method DELETE_DOCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_RC	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Rückgabewert von ABAP-Anweisungen	20071210

#	Exception	Resumable	Description	Created on
1	CX_BCS	☐	BCS: Allgemeine Ausnahmen	20071210

Method DETERMINE_DOCS Signature

Method DETERMINE_DOCS on class CL_CAM_REF_BCS has no parameter.
Method DETERMINE_DOCS on class CL_CAM_REF_BCS has no exception.

Method FIND_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ADDRNUMBER	Value transfer	☐	Type reference (TYPE)	AD_ADDRNUM			20071210
2	Exporting	EV_NAME_TEXT	Value transfer	☐	Type reference (TYPE)	AD_NAMTEXT			20071210
3	Exporting	EV_PERSNUMBER	Value transfer	☐	Type reference (TYPE)	AD_PERSNUM			20071210
4	Importing	IV_ADDRTYPE	Call by reference	☑	Type reference (TYPE)	CLIKE			20071210
5	Importing	IV_EXTERN_ONLY	Call by reference	☐	Type reference (TYPE)	OS_BOOLEAN	'X'	Boolean	20071210
6	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210

#	Exception	Resumable	Description	Created on
1	CX_ADDRESS_BCS	☐	BCS: Ausnahmen bei Adressen	20071210

Method FIND_REFERENCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FULL_LOG	Call by reference	☑	Type reference (TYPE)	OS_BOOLEAN			20071210

#	Exception	Resumable	Description	Created on
1	CX_ADDRESS_BCS	☐		20071210

Method FIND_UNIQUE_TYPE12 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ADDRNUMBER	Value transfer	☐	Type reference (TYPE)	AD_ADDRNUM			20071210
2	Exporting	EV_NAME_TEXT	Value transfer	☐	Type reference (TYPE)	AD_NAMTEXT			20071210
3	Exporting	EV_PERSNUMBER	Value transfer	☐	Type reference (TYPE)	AD_PERSNUM			20071210
4	Importing	IV_ADDRTYPE	Call by reference	☑	Type reference (TYPE)	CLIKE			20071210
5	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210

Method FIND_UNIQUE_TYPE12 on class CL_CAM_REF_BCS has no exception.

Method FREE_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NOTHING_TO_DO	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20071210

Method FREE_DELETED on class CL_CAM_REF_BCS has no exception.

Method GET_NEW_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LFDNR	Call by reference	☐	Type reference (TYPE)	SO_LFD_NR			20071210
2	Exporting	EV_SO_KEY	Call by reference	☐	Type reference (TYPE)	ADCP-SO_KEY			20071210
3	Importing	IS_PERS_REF	Call by reference	☐	Type reference (TYPE)	PERS_REF			20071210
4	Importing	IV_ADRTP	Call by reference	☐	Type reference (TYPE)	C			20071210
5	Importing	IV_DUMMY	Call by reference	☑	Type reference (TYPE)	OS_BOOLEAN		Boolean	20071210
6	Importing	IV_LFDNR	Value transfer	☐	Type reference (TYPE)	SO_LFD_NR			20071210

#	Exception	Resumable	Description	Created on
1	CX_ADDRESS_BCS	☐		20071210

Method GET_NEW_KEY_SOO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_SNDNAM	Call by reference	☐	Type reference (TYPE)	SOOS-SNDNAM			20071210
2	Changing	CV_SNDNO	Call by reference	☐	Type reference (TYPE)	SOOS-SNDNO			20071210
3	Changing	CV_SNDYR	Call by reference	☐	Type reference (TYPE)	SOOS-SNDYR			20071210
4	Importing	IV_SNDART	Call by reference	☐	Type reference (TYPE)	SOOS-SNDART			20071210

#	Exception	Resumable	Description	Created on
1	CX_ADDRESS_BCS	☐		20071210

Method READ_RECIPIENT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RECIPIENT_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20071210
2	Importing	IV_SOMG_KEY	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210

Method READ_RECIPIENT_KEY on class CL_CAM_REF_BCS has no exception.

Method READ_TABLES Signature

Method READ_TABLES on class CL_CAM_REF_BCS has no parameter.
Method READ_TABLES on class CL_CAM_REF_BCS has no exception.

Method REF_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_REF	Call by reference	☐	Type reference (TYPE)	PERS_REF			20071210
2	Returning	RV_EXISTS	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN			20071210

Method REF_EXISTS on class CL_CAM_REF_BCS has no exception.

Method RELEASE_FROM_DOCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NOTHING_TO_DO	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20071210

Method RELEASE_FROM_DOCS on class CL_CAM_REF_BCS has no exception.

Method REMOVE_FROM_DLIS Signature

Method REMOVE_FROM_DLIS on class CL_CAM_REF_BCS has no parameter.
Method REMOVE_FROM_DLIS on class CL_CAM_REF_BCS has no exception.

Method RESET Signature

Method RESET on class CL_CAM_REF_BCS has no parameter.
Method RESET on class CL_CAM_REF_BCS has no exception.

Method SADRFD_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SADRFD	Call by reference	☐	Type reference (TYPE)	SADRFD		Datenteil einer Telefaxadresse	20071210
2	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20071210

Method SADRFD_TO_STRING on class CL_CAM_REF_BCS has no exception.

Method SEARCH_HELP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ADDRNUMBER	Value transfer	☐	Type reference (TYPE)	AD_ADDRNUM			20071210
2	Exporting	EV_NAME_TEXT	Value transfer	☐	Type reference (TYPE)	AD_NAMTEXT			20071210
3	Exporting	EV_PERSNUMBER	Value transfer	☐	Type reference (TYPE)	AD_PERSNUM			20071210
4	Importing	IV_ADDRTYPE	Call by reference	☑	Type reference (TYPE)	CLIKE			20071210
5	Importing	IV_EXTERN_ONLY	Call by reference	☐	Type reference (TYPE)	OS_BOOLEAN	'X'	Boolean	20071210
6	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210

#	Exception	Resumable	Description	Created on
1	CX_ADDRESS_BCS	☐	BCS: Ausnahmen bei Adressen	20071210

Method STRING_TO_SADRFD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	CLIKE			20071210
2	Returning	RS_SADRFD	Value transfer	☐	Type reference (TYPE)	SADRFD		Datenteil einer Telefaxadresse	20071210

Method STRING_TO_SADRFD on class CL_CAM_REF_BCS has no exception.

Method UPDATE_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NOTHING_TO_DO	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20071210

Method UPDATE_TABLES on class CL_CAM_REF_BCS has no exception.

Method WRITE_LIST Signature

Method WRITE_LIST on class CL_CAM_REF_BCS has no parameter.
Method WRITE_LIST on class CL_CAM_REF_BCS has no exception.

History

Last changed by/on	SAP	20080612
SAP Release Created in