SAP ABAP Class CL_CPF_MESSAGES (CPF: Message handling)

Hierarchy

☛ PI_BASIS (Software Component) Basis Plug-In
   ⤷ CA-GTF-PR-CPF (Application Component) Configurable Parameters and Formulas
     ⤷ CPF_BASIS (Package) Configurable Parameters and Formulas (Basis)

Properties

Class	CL_CPF_MESSAGES
Short Description	CPF: Message handling
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status	K	Customer Production Program
Category	0
Package	CPF_BASIS	Configurable Parameters and Formulas (Basis)
Created	20120711	SAP
Last change	20131127	SAP
Shared Memory-enabled	☑
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_CPF_MESSAGES has no interface implemented.

Friends

Class CL_CPF_MESSAGES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_MSGTYE	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'E'	Message Type	20120711
2	GC_MSGTYI	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'I'	Message Type	20120711
3	GC_MSGTYS	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'S'	Message Type	20120711
4	GC_MSGTYW	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'W'	Message Type	20120711
5	MS_BAL_CONTROL	Instance attribute	Protected	☐	Type reference (TYPE)	TS_BAL_CONTROL		AL Control Structure	20120711
6	MS_CONTEXT	Instance attribute	Protected	☐	Type reference (TYPE)	CPFS_CONTEXT		CPF Context	20130320
7	MT_CPF_MESSAGES	Instance attribute	Protected	☐	Type reference (TYPE)	CPFT_MESSAGE		CPF Message: BAPIRET2 + CPF Context	20130320
8	MT_LOGHANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	BAL_T_LOGH		AL Log Handle Table	20120711
9	MT_MESSAGES	Instance attribute	Protected	☐	Type reference (TYPE)	TT_BAL_MSG		Message Table	20120711
10	MT_MESSAGES_SAVE	Instance attribute	Protected	☐	Type reference (TYPE)	TT_BAL_MSG		Message Table	20120711
11	MV_DETLEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	BALLEVEL		AL Level of detail	20120711
12	MV_LOGHANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	BALLOGHNDL		AL Log Handle	20120711
13	MV_LOGLEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	TE_LOGLEVEL	0	Log Level	20120711
14	MV_MESSAGES	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Number of Temporary Messages	20120711
15	MV_MSGLIMIT	Instance attribute	Protected	☐	Type reference (TYPE)	XFLAG		Maximum Message Count Reached	20120711
16	MV_SAVED	Instance attribute	Protected	☐	Type reference (TYPE)	XFLAG		Temporary Messages Saved	20120711
17	SR_INSTANCE	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CPF_MESSAGES		Class Instance	20120711
18	SV_LOGLEVEL	Static Attribute	Protected	☐	Type reference (TYPE)	TE_LOGLEVEL	0	Message Handling Loglevel	20120711

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Instance method	Protected	Method	Add message only if it is a new one	20130320
2	COMPOSE_MESSAGE	Static method	Public	Method	Compose message based on sy-variables	20120711
3	CONSTRUCTOR	Instance method	Protected	Constructor	CONSTRUCTOR	20120711
4	CONVERT_CPF_MESSAGE_2_LOG	Static method	Public	Method	Convert messages from CPF messages 2 appl. log structure	20130320
5	CONVERT_FDT_2_CPF_MESSAGE	Static method	Public	Method	Convert messages from application log 2 BAPIRET structure	20130320
6	CONVERT_SYMSG_2_CPF_MESSAGE	Static method	Public	Method	Convert messages from application log 2 BAPIRET structure	20130320
7	CREATE_BAL	Instance method	Protected	Method	Creates BAL Log Object	20120711
8	DETLEVEL_DEC	Instance method	Public	Method	Decrease detail level for log	20120711
9	DETLEVEL_GET	Instance method	Public	Method	Get current detail level for log	20120711
10	DETLEVEL_INC	Instance method	Public	Method	Increase detail level for log	20120711
11	DETLEVEL_SET	Instance method	Public	Method	Set current detail level for log	20120711
12	GET_INSTANCE	Static method	Public	Method	Get Class Instance	20120711
13	GET_LOGHANDLE	Instance method	Public	Method	Get current log handle (EXTERNAL DISPLAY & STORAGE HANDLING)	20120711
14	GET_LOGSTAT	Instance method	Public	Method	Retrieve statistics for written application log	20120711
15	GET_MESSAGECOUNT	Instance method	Public	Method	Get count of current temporary messages	20120711
16	GET_MESSAGES	Instance method	Public	Method	Get temporary, saved and/or all messages	20120711
17	GET_MESSAGES_BY_CX	Static method	Public	Method	Get messages from original exception	20130320
18	LOG_CLEAR	Instance method	Public	Method	Clear log data that was not saved permanently	20120711
19	LOG_DELETE	Instance method	Public	Method	Delete log data that was not saved permanently	20120711
20	LOG_DISPLAY	Instance method	Public	Method	Display log (default ALV w hierarchy)	20120711
21	LOG_SAVE	Instance method	Public	Method	Save log to database	20120711
22	LOG_WRITE_MESSAGES	Instance method	Protected	Method	Write temporary messages to log	20120711
23	LOG_WRITE_MESSAGES_APPL	Instance method	Public	Method	Write temporary messages to log for external application	20120711
24	REFRESH	Instance method	Public	Method	Refresh the messages	20130320
25	SET_LOGHANDLE	Instance method	Public	Method	Set current log handle (EXTERNAL DISPLAY & STORAGE HANDLING)	20120711
26	SET_LOGLEVEL	Instance method	Public	Method	Set current logging level (for automated filtering)	20120711
27	SET_MESSAGE	Instance method	Public	Method	OBSOLET	20130415
28	SET_MESSAGES	Instance method	Public	Method	add messages to temporary message buffer	20120711
29	SET_SAVEMODE	Instance method	Public	Method	Change Instance to be saved	20120711

Events

Class CL_CPF_MESSAGES has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TE_LOGLEVEL	Public	Type reference (TYPE)	CPF_NUMC1	Logging Level	20120711
2	TS_BAL_CONTROL	Public	See coding		Application Log Control Structure	20120711	BEGIN OF ts_bal_control, object TYPE balobj_d, subobject TYPE balsubobj, handle TYPE balloghndl, extnumber TYPE balnrext, title TYPE baltitle, repid TYPE repid, tcode TYPE sytcode, init_detlevel TYPE xfeld, no_save TYPE xfeld, END OF ts_bal_control
3	TS_BAL_MSG	Public	Type reference (TYPE)	BAL_S_MSG	Application Log Message	20120711
4	TT_BAL_MSG	Public	See coding		Application Log Messages	20120711	tt_bal_msg TYPE TABLE OF ts_bal_msg

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG		Application Log: Message Data	20130320

Method ADD_MESSAGE on class CL_CPF_MESSAGES has no exception.

Method COMPOSE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_MESSAGE	Call by reference	☐	Type reference (TYPE)	TS_BAL_MSG		Application Log Message Structure	20120711
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	TT_BAL_MSG		Application Log Message Table	20120711
3	Importing	IV_OVERRIDE_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type	20120711

Method COMPOSE_MESSAGE on class CL_CPF_MESSAGES has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAL_CONTROL	Call by reference	☐	Type reference (TYPE)	TS_BAL_CONTROL		Application Log Control Structure	20120711

Method CONSTRUCTOR on class CL_CPF_MESSAGES has no exception.

Method CONVERT_CPF_MESSAGE_2_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BAL_MESSAGES	Call by reference	☐	Type reference (TYPE)	TT_BAL_MSG		Application Log Message Table	20130320
2	Importing	IT_CPF_MESSAGES	Call by reference	☐	Type reference (TYPE)	CPFT_MESSAGE		CPF Message: BAPIRET2 + CPF Context	20130320
3	Importing	IV_FILTER	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type	20130320

Method CONVERT_CPF_MESSAGE_2_LOG on class CL_CPF_MESSAGES has no exception.

Method CONVERT_FDT_2_CPF_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CPF_MESSAGES	Call by reference	☐	Type reference (TYPE)	CPFT_MESSAGE		CPF Message: BAPIRET2 + CPF Context	20130320
2	Importing	IS_CONTEXT	Call by reference	☑	Type reference (TYPE)	CPFS_CONTEXT		CPF Context	20130320
3	Importing	IT_FDT_MESSAGES	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>T_MESSAGE		FDT Messages	20130320
4	Importing	IV_FILTER	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type	20130320

Method CONVERT_FDT_2_CPF_MESSAGE on class CL_CPF_MESSAGES has no exception.

Method CONVERT_SYMSG_2_CPF_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CPF_MESSAGES	Call by reference	☐	Type reference (TYPE)	CPFT_MESSAGE		CPF Message: BAPIRET2 + CPF Context	20130320
2	Importing	IS_CONTEXT	Call by reference	☑	Type reference (TYPE)	CPFS_CONTEXT		CPF Context	20130320
3	Importing	IV_MSG_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		Message text	20130320

Method CONVERT_SYMSG_2_CPF_MESSAGE on class CL_CPF_MESSAGES has no exception.

Method CREATE_BAL Signature

Method CREATE_BAL on class CL_CPF_MESSAGES has no parameter.
Method CREATE_BAL on class CL_CPF_MESSAGES has no exception.

Method DETLEVEL_DEC Signature

Method DETLEVEL_DEC on class CL_CPF_MESSAGES has no parameter.
Method DETLEVEL_DEC on class CL_CPF_MESSAGES has no exception.

Method DETLEVEL_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DETLEVEL	Call by reference	☐	Type reference (TYPE)	BALLEVEL		Application Log: Level of detail	20120711

Method DETLEVEL_GET on class CL_CPF_MESSAGES has no exception.

Method DETLEVEL_INC Signature

Method DETLEVEL_INC on class CL_CPF_MESSAGES has no parameter.
Method DETLEVEL_INC on class CL_CPF_MESSAGES has no exception.

Method DETLEVEL_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DETLEVEL	Call by reference	☐	Type reference (TYPE)	BALLEVEL		Application Log: Level of detail	20120711

Method DETLEVEL_SET on class CL_CPF_MESSAGES has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DETLEVEL_INI	Call by reference	☐	Type reference (TYPE)	XFELD	SPACE	Checkbox	20120717
2	Importing	IV_EXTNUMBER	Call by reference	☑	Type reference (TYPE)	BALNREXT		Application Log: External ID	20120717
3	Importing	IV_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20120717
4	Importing	IV_NO_SAVE	Call by reference	☐	Type reference (TYPE)	XFELD	SPACE	Checkbox	20120717
5	Importing	IV_OBJECT	Call by reference	☑	Type reference (TYPE)	BALOBJ_D		Application log: Object name (Application code)	20120717
6	Importing	IV_REPID	Call by reference	☑	Type reference (TYPE)	REPID		ABAP Program Name	20120717
7	Importing	IV_SUBOBJECT	Call by reference	☑	Type reference (TYPE)	BALSUBOBJ		Application Log: Subobject	20120717
8	Importing	IV_TCODE	Call by reference	☑	Type reference (TYPE)	SYTCODE		Current Transaction Code	20120717
9	Importing	IV_TITLE	Call by reference	☑	Type reference (TYPE)	BALTITLE		Application Log: Screen title	20120717
10	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CPF_MESSAGES		CPF Message Handling Class	20120711

Method GET_INSTANCE on class CL_CPF_MESSAGES has no exception.

Method GET_LOGHANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOGHANDLE	Call by reference	☐	Type reference (TYPE)	BAL_T_LOGH		Application Log: Log Handle Table	20120711
2	Exporting	EV_LOGHANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20120711

Method GET_LOGHANDLE on class CL_CPF_MESSAGES has no exception.

Method GET_LOGSTAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_STAT	Call by reference	☐	Type reference (TYPE)	BAL_S_SCNT		Application Log: Statistics: Message Type Counter	20120711

Method GET_LOGSTAT on class CL_CPF_MESSAGES has no exception.

Method GET_MESSAGECOUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_MESSAGES	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20120711

Method GET_MESSAGECOUNT on class CL_CPF_MESSAGES has no exception.

Method GET_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	TT_BAL_MSG		Application Log Message Table	20120711
2	Exporting	ET_MESSAGES_SAVE	Call by reference	☐	Type reference (TYPE)	TT_BAL_MSG		Application Log Message Table	20120711
3	Exporting	ET_MESSAGES_TOTAL	Call by reference	☐	Type reference (TYPE)	TT_BAL_MSG		Application Log Message Table	20120711

Method GET_MESSAGES on class CL_CPF_MESSAGES has no exception.

Method GET_MESSAGES_BY_CX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CPF_MESSAGE	Value transfer	☐	Type reference (TYPE)	CPFT_MESSAGE		CPF Message: BAPIRET2 + CPF Context	20130320
2	Importing	IO_CX	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20130320

Method GET_MESSAGES_BY_CX on class CL_CPF_MESSAGES has no exception.

Method LOG_CLEAR Signature

Method LOG_CLEAR on class CL_CPF_MESSAGES has no parameter.
Method LOG_CLEAR on class CL_CPF_MESSAGES has no exception.

Method LOG_DELETE Signature

Method LOG_DELETE on class CL_CPF_MESSAGES has no parameter.
Method LOG_DELETE on class CL_CPF_MESSAGES has no exception.

Method LOG_DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_STRUC	Call by reference	☐	Type reference (TYPE)	ANY	'CPFS_CONTEXT'	Context Stucture of Log	20130320
2	Importing	IV_HIERARCHY	Call by reference	☐	Type reference (TYPE)	XFELD	''	Checkbox	20120711
3	Importing	IV_TITLE	Call by reference	☑	Type reference (TYPE)	BALTITLE		Application Log: Screen title	20120711

Method LOG_DISPLAY on class CL_CPF_MESSAGES has no exception.

Method LOG_SAVE Signature

Method LOG_SAVE on class CL_CPF_MESSAGES has no parameter.
Method LOG_SAVE on class CL_CPF_MESSAGES has no exception.

Method LOG_WRITE_MESSAGES Signature

Method LOG_WRITE_MESSAGES on class CL_CPF_MESSAGES has no parameter.
Method LOG_WRITE_MESSAGES on class CL_CPF_MESSAGES has no exception.

Method LOG_WRITE_MESSAGES_APPL Signature

Method LOG_WRITE_MESSAGES_APPL on class CL_CPF_MESSAGES has no parameter.
Method LOG_WRITE_MESSAGES_APPL on class CL_CPF_MESSAGES has no exception.

Method REFRESH Signature

Method REFRESH on class CL_CPF_MESSAGES has no parameter.
Method REFRESH on class CL_CPF_MESSAGES has no exception.

Method SET_LOGHANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LOGHANDLE	Call by reference	☐	Type reference (TYPE)	BAL_T_LOGH		Application Log: Log Handle Table	20120711
2	Importing	IV_LOGHANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle Table	20120711

Method SET_LOGHANDLE on class CL_CPF_MESSAGES has no exception.

Method SET_LOGLEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGLEVEL	Call by reference	☐	Type reference (TYPE)	TE_LOGLEVEL		Message Handling Loglevel	20120711

Method SET_LOGLEVEL on class CL_CPF_MESSAGES has no exception.

Method SET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MESSAGE	Call by reference	☑	Type reference (TYPE)	TS_BAL_MSG		Application Log Message	20130415
2	Importing	IV_LOGLEVEL	Call by reference	☑	Type reference (TYPE)	TE_LOGLEVEL		Logging Level	20130415
3	Importing	IV_OVERRIDE_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type	20130415
4	Importing	IV_PROBCLASS	Call by reference	☑	Type reference (TYPE)	BALPROBCL		Application log: Message problem class	20130415

Method SET_MESSAGE on class CL_CPF_MESSAGES has no exception.

Method SET_MESSAGES 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)	TT_BAL_MSG		Application Log Message Table	20120711

Method SET_MESSAGES on class CL_CPF_MESSAGES has no exception.

Method SET_SAVEMODE Signature

Method SET_SAVEMODE on class CL_CPF_MESSAGES has no parameter.
Method SET_SAVEMODE on class CL_CPF_MESSAGES has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in	740