SAP ABAP Class /SCMB/CL_DF_LOG (logging class for Docflow)

Hierarchy

☛ PI_BASIS (Software Component) Basis Plug-In
   ⤷ SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow
     ⤷ /SCMB/FLOW_BASIS (Package) Document Flow, Base

Properties

Class	/SCMB/CL_DF_LOG
Short Description	logging class for Docflow
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/SCMB/FLOW_BASIS	Document Flow, Base
Created	20070704	SAP
Last change	20090618	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 /SCMB/CL_DF_LOG has no interface implemented.

Friends

Class /SCMB/CL_DF_LOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_FALSE	Constant	Private	☐	Type reference (TYPE)	FLAG	' '	General Flag	20070905
2	GC_TRUE	Constant	Private	☐	Type reference (TYPE)	FLAG	'X'	General Flag	20070905
3	GO_LOG	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_LOG		Singleton reference to Docflow log	20070905
4	GV_PRGID	Static Attribute	Private	☐	Type reference (TYPE)	BALPROG	SY-REPID	Program ID of log	20081027
5	MS_LOG_HEAD	Instance attribute	Private	☐	Type reference (TYPE)	BAL_S_LOG		Log header data	20070905
6	MV_LOGHANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALLOGHNDL		Log handle	20070905

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MSG	Instance method	Public	Method	Includes message in the log	20070905
2	ADD_MSG_BAPI_TBL	Instance method	Public	Method	Includes messages in the log in table	20070905
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20070905
4	DISPLAY_LOG	Instance method	Public	Method	Displays Docflow Log	20070905
5	DISPLAY_MSG_BY_HANDLE	Instance method	Public	Method	Displays Docflow messages by handle	20070905
6	GET_INSTANCE	Static method	Public	Method	Provides singleton object of the logging class	20070905
7	REFRESH_LOG	Instance method	Public	Method	Initializes current log	20070905
8	SAVE_LOG_TO_DB	Instance method	Public	Method	Saves Log to Database	20070905
9	SET_PRGID	Static method	Public	Method	Sets the caller program/routine ID	20081027

Events

Class /SCMB/CL_DF_LOG has no event.

Types

Class /SCMB/CL_DF_LOG has no local type.

Method Signatures

Method ADD_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_MSG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALMSGHNDL		Message handle	20070905
2	Importing	IS_LOG_MSG	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG		Message Data	20070905

Method ADD_MSG on class /SCMB/CL_DF_LOG has no exception.

Method ADD_MSG_BAPI_TBL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MSG_BAPI	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table of messages	20070905

Method ADD_MSG_BAPI_TBL on class /SCMB/CL_DF_LOG has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class /SCMB/CL_DF_LOG has no parameter.
Method CONSTRUCTOR on class /SCMB/CL_DF_LOG has no exception.

Method DISPLAY_LOG Signature

Method DISPLAY_LOG on class /SCMB/CL_DF_LOG has no parameter.
Method DISPLAY_LOG on class /SCMB/CL_DF_LOG has no exception.

Method DISPLAY_MSG_BY_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MSG_HANDLE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSGH		Message Handle Table	20070905

Method DISPLAY_MSG_BY_HANDLE on class /SCMB/CL_DF_LOG has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_LOG	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_LOG		Returning reference to Docflow log	20070905

Method GET_INSTANCE on class /SCMB/CL_DF_LOG has no exception.

Method REFRESH_LOG Signature

Method REFRESH_LOG on class /SCMB/CL_DF_LOG has no parameter.
Method REFRESH_LOG on class /SCMB/CL_DF_LOG has no exception.

Method SAVE_LOG_TO_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	SY-MANDT	SY-MANDT	Client in which the new log is to be saved	20070905

Method SAVE_LOG_TO_DB on class /SCMB/CL_DF_LOG has no exception.

Method SET_PRGID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PRGID	Call by reference	☐	Type reference (TYPE)	BALPROG		Caller program/routine name	20081027

Method SET_PRGID on class /SCMB/CL_DF_LOG has no exception.

History

Last changed by/on	SAP	20090618
SAP Release Created in