SAP ABAP Class CL_CRM_BM_BROADCAST_SUP (Application class for broadcast messaging)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-BRO (Application Component) Broadcast Messaging
     ⤷ CRM_BROADCAST_APP (Package) Application Layer of Broadcast Messaging in IC Scenario

Properties

Class	CL_CRM_BM_BROADCAST_SUP
Short Description	Application class for broadcast messaging
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CRM_BROADCAST_APP	Application Layer of Broadcast Messaging in IC Scenario
Created	20040227	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)

Interfaces

Class CL_CRM_BM_BROADCAST_SUP has no interface implemented.

Friends

Class CL_CRM_BM_BROADCAST_SUP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DISTTABLE	Instance attribute	Private	☐	Type reference (TYPE)	CRMGS_CIC_BR_DLISTS_TAB		CRM Broadcast messaging distribution list table	20040228
2	GT_SCHEMA	Instance attribute	Public	☐	Type reference (TYPE)	CRMT_IC_BM_SCHEMA_TAB		CRM Broadcast Messaging schema table	20091006
3	ORGUNIT	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Organizational unit	20040313
4	PROFILE	Instance attribute	Public	☑	Type reference (TYPE)	STRING		BM Profile	20040313
5	PURGE_DAYS	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Number of before deleting messages	20040313
6	SEND_LOG	Instance attribute	Public	☑	Type reference (TYPE)	CRMT_BM_SEND_LOG_TAB		CRM IC Broadcast Messaging , Send Log table	20040316

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_USER	Instance method	Public	Method	Adds new user to a distribution list	20040305
2	BUILD_XML_CONTENT	Instance method	Public	Method	Creates XML content to be transfered to clients	20040318
3	BUILD_XML_MESSAGE	Instance method	Public	Method	Creates XML message to be transfered to clients	20040227
4	COPY_DISTRIBUTION_LIST	Instance method	Public	Method	Copies distribution list	20040306
5	CREATE_DISTRIBUTION_LIST	Instance method	Public	Method	Creates distribution list	20040227
6	DELETE_DISTRIBUTION_LIST	Instance method	Public	Method	Deletes distribution list	20040227
7	DELETE_USER	Instance method	Public	Method	Deletes selected user from a distribution list	20040305
8	FORMAT_DATE	Instance method	Private	Method	Formats date	20040320
9	GET_DEFAULT_PROFILE	Instance method	Public	Method	Returns the default profile for the specified user	20050125
10	GET_DL_MEMBERS	Instance method	Public	Method	Gets distribution's list members	20040228
11	GET_ORG_UNIT_DESCRIPTION	Instance method	Public	Method	Get the description of an given org. unit. id.	20050126
12	GET_ORG_UNIT_MEMBERS	Instance method	Public	Method	Gets org's unit members	20040228
13	GET_PROFILE_LIST	Instance method	Public	Method		20050125
14	GET_SCHEMA_DETAIL	Instance method	Public	Method	Get Text Schema ID	20091006
15	GET_SEND_LOG	Instance method	Public	Method	Gets send log	20040312
16	GET_TEXT_SCHEMA	Instance method	Public	Method	Get Text Schema ID	20090925
17	GET_USER_DL	Instance method	Public	Method	Gets user's distribution list	20040228
18	PURGE	Instance method	Public	Method	Purge expired messages	20040317
19	SEND_MESSAGE	Instance method	Public	Method	Sends message	20040303
20	SET_DEFAULT_PROFILE	Instance method	Public	Method	Set a given profile as the default for the current user	20050128
21	SET_PROFILE	Instance method	Public	Method	Sets broadcast messaging profile.	20040313

Events

Class CL_CRM_BM_BROADCAST_SUP has no event.

Types

Class CL_CRM_BM_BROADCAST_SUP has no local type.

Method Signatures

Method ADD_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOLDER_ID	Value transfer	☑	Type reference (TYPE)	STRING			20040305
2	Importing	LIST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040305
3	Importing	NO_USERID	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Used in case the user does not user the value help	20061215
4	Returning	RV_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070130
5	Importing	USER_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040305

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040305

Method BUILD_XML_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPIRATION_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040318
2	Importing	FORMAT_SCHEMA	Value transfer	☑	Type reference (TYPE)	STRING			20091006
3	Importing	ID_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040319
4	Importing	PRIORITY_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040318
5	Importing	STATUS_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040318
6	Importing	TEXT_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040318
7	Returning	XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20040318

Method BUILD_XML_CONTENT on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method BUILD_XML_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DL_MEMBERS	Value transfer	☑	Type reference (TYPE)	CRMT_BM_KEY_VALUE_TAB		CRM Broadcast Messaging: Tabelle	20040304
2	Importing	EXPIRATION_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040303
3	Importing	ID_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040303
4	Importing	PRIORITY_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040303
5	Importing	STATUS_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040303
6	Importing	TEXT_VALUE	Value transfer	☑	Type reference (TYPE)	STRING			20040302
7	Returning	XML	Value transfer	☐	Type reference (TYPE)	STRING			20040227

Method BUILD_XML_MESSAGE on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method COPY_DISTRIBUTION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOLDER_ID	Value transfer	☑	Type reference (TYPE)	STRING			20040306
2	Importing	SOURCE_LIST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040306
3	Importing	TARGET_LIST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040306

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040306

Method CREATE_DISTRIBUTION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOLDER_ID	Value transfer	☑	Type reference (TYPE)	STRING			20040305
2	Importing	LIST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040305

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040305

Method DELETE_DISTRIBUTION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOLDER_ID	Value transfer	☑	Type reference (TYPE)	STRING			20040305
2	Importing	LIST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040305

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040305

Method DELETE_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DL_DELETED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20040414
2	Exporting	EMPTY_ROW	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Return TRUE if it is an empty row	20080122
3	Importing	HOLDER_ID	Value transfer	☑	Type reference (TYPE)	STRING			20040305
4	Importing	LIST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040305
5	Importing	NEW_LIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Set this to true when creating a new list	20061214
6	Importing	ROW_ID	Call by reference	☑	Type reference (TYPE)	STRING			20040305
7	Importing	USER_ID	Value transfer	☑	Type reference (TYPE)	STRING			20040305

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040305

Method FORMAT_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATE_IN	Value transfer	☐	Type reference (TYPE)	TZNTSTMPS		UTC-Zeitstempel in Kurzform (JJJJMMTTssmmss)	20040320
2	Returning	DATE_OUT	Value transfer	☐	Type reference (TYPE)	STRING			20040320

Method FORMAT_DATE on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_DEFAULT_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PROFILE	Value transfer	☐	Type reference (TYPE)	STRING			20050125
2	Importing	USERNAME	Call by reference	☐	Type reference (TYPE)	UPNAM		Letzter Änderer	20050125

Method GET_DEFAULT_PROFILE on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_DL_MEMBERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Value transfer	☑	Type reference (TYPE)	STRING			20040228
2	Returning	TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_BM_KEY_VALUE_TAB		CRM Broadcast Messaging: Tabelle	20040228

Method GET_DL_MEMBERS on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_ORG_UNIT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ORG_UNIT_DESC	Value transfer	☐	Type reference (TYPE)	CRMT_CIC_ORGUNIT_DESC		Beschreibung der Organisationseinheit	20050126
2	Importing	ORG_UNIT_ID	Call by reference	☐	Type reference (TYPE)	CRMT_CIC_ORGID		Organisationseinheits-ID	20050126

Method GET_ORG_UNIT_DESCRIPTION on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_ORG_UNIT_MEMBERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Value transfer	☑	Type reference (TYPE)	STRING			20040228
2	Returning	TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_BM_KEY_VALUE_TAB		CRM Broadcast Messaging: Tabelle	20040228

Method GET_ORG_UNIT_MEMBERS on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_PROFILE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PROFILE_LIST	Value transfer	☐	Type reference (TYPE)	CRMT_IC_BM_PROF_LIST		Liste verfügbarer Profile	20050128

Method GET_PROFILE_LIST on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_SCHEMA_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FONT_COLOR	Call by reference	☐	Type reference (TYPE)	STRING			20091006
2	Exporting	EV_FONT_FORMAT	Call by reference	☐	Type reference (TYPE)	STRING			20091006
3	Importing	IV_FORMAT_SCHEMA	Value transfer	☐	Type reference (TYPE)	STRING			20091006

Method GET_SCHEMA_DETAIL on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_SEND_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SL_SHOW	Value transfer	☐	Type reference (TYPE)	STRING			20040312
2	Returning	TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_BM_SEND_LOG_TAB		CRM IC Broadcast Messaging: Tabelle für Sendeprotokoll	20040312

Method GET_SEND_LOG on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_TEXT_SCHEMA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_BM_KEY_VALUE_TAB		CRM Broadcast Messaging table	20090925

Method GET_TEXT_SCHEMA on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method GET_USER_DL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_BM_KEY_VALUE_TAB		CRM Broadcast Messaging: Tabelle	20040228
2	Importing	USERID	Value transfer	☑	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20040228

Method GET_USER_DL on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method PURGE Signature

Method PURGE on class CL_CRM_BM_BROADCAST_SUP has no parameter.
Method PURGE on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method SEND_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DL_MEMBERS	Value transfer	☑	Type reference (TYPE)	CRMT_BM_KEY_VALUE_TAB		CRM Broadcast Messaging: Tabelle	20040322
2	Importing	DURATION_H_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20040322
3	Importing	DURATION_M_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20040322
4	Exporting	ET_FAIL	Call by reference	☐	Type reference (TYPE)	CRMT_BM_MESSAGE_T		Tabelle für Nachricht	20040322
5	Exporting	ET_SUCCESS	Call by reference	☐	Type reference (TYPE)	CRMT_BM_MESSAGE_T		Tabelle für Nachricht	20040322
6	Importing	FORMAT_SCHEMA	Value transfer	☑	Type reference (TYPE)	STRING			20091006
7	Importing	PRIORITY_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20040322
8	Importing	SENDTO_LIST_NAME	Value transfer	☑	Type reference (TYPE)	STRING			20040322
9	Importing	TEXT_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20040322

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040324

Method SET_DEFAULT_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEFAULT_PROFILE	Call by reference	☐	Type reference (TYPE)	CRMT_CIC_BROADCAST_PROFILE		Profilname für Broadcasting-Komponente	20050128
2	Importing	USERNAME	Call by reference	☐	Type reference (TYPE)	UPNAM		Letzter Änderer	20050128

Method SET_DEFAULT_PROFILE on class CL_CRM_BM_BROADCAST_SUP has no exception.

Method SET_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROFILE	Value transfer	☐	Type reference (TYPE)	STRING			20040313

#	Exception	Resumable	Description	Created on
1	CX_CRM_BM_EXCEPTION	☐		20040313

History

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