SAP ABAP Class CL_SALV_CSQ_LOG (Logger)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-ALV-ABA (Application Component) Web Dynpro ALV for ABAP
     ⤷ SALV_CSQ (Package) Tools

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_CSQ_APPLICATION_LOG	OBSOLETE: Root log, message log	20080824
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_CSQ_LOG	Log object	20080815
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_CSQ_LOG_PROVIDER	Log provider	20080815
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_CSQ_SESSION_INFO	Trace activation status, root message pool	20090309
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_CSQ_SESSION_LOG	Root log, message log	20090309

Properties

Class	CL_SALV_CSQ_LOG
Short Description	Logger
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SALV_CSQ	Tools
Created	20080813	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)
2	CL_SALV_CSQ_PARAMS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_SALV_CSZ_API	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SALV_CSQ_APPLICATION_LOG	☐	☐	OBSOLETE: Root log, message log	20080824
2	IF_SALV_CSQ_LOG	☐	☐	Log object	20080815
3	IF_SALV_CSQ_LOG_PROVIDER	☐	☐	Log provider	20080815
4	IF_SALV_CSQ_SESSION_INFO	☐	☐	Trace activation status, root message pool	20090309
5	IF_SALV_CSQ_SESSION_LOG	☐	☐	Root log, message log	20090309

Friends

Class CL_SALV_CSQ_LOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLASS	Instance attribute	Protected	☐	Type reference (TYPE)	SALV_CSQT_TOOL			20090309
2	COMPONENT	Instance attribute	Protected	☐	Type reference (TYPE)	SALV_CSQT_COMPONENT		Software component (granularity for separate tracing)	20080815
3	C_AREA_CSQ_BREAK_POINTS	Constant	Public	☐	Type reference (TYPE)	SALV_CSQ_PARAM_AREA	CL_SALV_CSQ_PARAMS=>C_AREA_CSQ_BREAK_POINTS		20090515
4	FALSE	Constant	Protected	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE		20080816
5	HAS_OWN_MESSAGE_POOL	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20090309
6	INSTANCE_HANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	SALV_CSQT_INSTANCE_HANDLE			20090309
7	PT_CALL_STACK	Static Attribute	Protected	☐	See coding				20100108
8	PT_INSTANCE_HNDL_COUNTERS	Static Attribute	Protected	☐	Type reference (TYPE)	YT_INSTANCE_HNDL_COUNTERS			20101216
9	P_BREAK_POINT	Static Attribute	Protected	☐	See coding				20090309
10	P_IS_TRACE_DISABLED	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20090515
11	P_SESSION	Static Attribute	Protected	☐	See coding				20090309
12	P_TOP_LEVEL_HANDLE_COUNTER	Static Attribute	Protected	☐	Type reference (TYPE)	I			20101216
13	R_APPLICATION_DESCRIPTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_CSQ_APPL_RUNTIME_DESCR			20090309
14	R_MESSAGE_POOL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_CSQ_MESSAGE_POOL			20090309
15	TRUE	Constant	Protected	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE		20080816

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BREAK_POINT	Static method	Protected	Method		20100108
2	CONSTRUCTOR	Instance method	Public	Constructor		20080815
3	CREATE_LOGGER	Static method	Protected	Method		20090309
4	CREATE_RECORDABLE_OBJECT	Static method	Public	Method		20090306
5	DISABLE_TRACE_FOR_THIS_SESSION	Static method	Public	Method		20090515
6	GET_ACTIVE_TASK_INSTANCE_HNDL	Static method	Public	Method		20100108
7	GET_APPLICATION_LOG	Static method	Public	Method	OBSOLETE: use get_session_log()	20080824
8	GET_REPLAYED_TRACE_ID	Static method	Public	Method		20080903
9	GET_SESSION_LOG	Static method	Public	Method		20090309
10	GET_UNIGUE_INSTANCE_HANDLE	Static method	Protected	Method		20101216
11	IS_BREAK_POINT_REACHED	Static method	Protected	Method		20100108
12	PREPARE_BREAK_POINTS	Static method	Protected	Method		20100108
13	READ_TRACE_LEVEL	Static method	Public	Method		20080906
14	SET_REPLAYED_TRACE_ID	Static method	Public	Method		20080903
15	WRITE_EXCEPTION_TO_LOG	Instance method	Protected	Method	Log exc. & continue if cs_param: dump_at_exception is off	20090528
16	WRITE_TRACE_LEVEL	Static method	Public	Method		20080906

Events

Class CL_SALV_CSQ_LOG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	BOOLEAN	Protected	Type reference (TYPE)	ABAP_BOOL		20080816
2	YS_BREAK_POINT_RULE	Protected	See coding			20100108	begin of ys_break_point_rule, condition type string, occurence_count type i, occurence_to_break_at type i, end of ys_break_point_rule
3	YS_INSTANCE_HNDL_COUNTER	Protected	See coding			20101216	begin of ys_instance_hndl_counter, activation_group type y_activation_group, class_shortened_name type y_class_shortened_name, instance_handle type y_instance_handle, instance_counter type i, end of ys_instance_hndl_counter
4	YS_TRACE_RECORD	Protected	See coding			20100108	begin of ys_trace_record, number type i, log type if_salv_csq=>ys_log_data, end of ys_trace_record
5	YT_BREAK_POINT_RULE	Protected	See coding			20100108	yt_break_point_rule type table of ys_break_point_rule with default key
6	YT_INSTANCE_HNDL_COUNTERS	Protected	See coding			20101216	yt_instance_hndl_counters type sorted table of ys_instance_hndl_counter with unique key activation_group class_shortened_name instance_handle
7	YT_TRACE_RECORD	Protected	See coding			20100108	yt_trace_record type table of ys_trace_record with default key
8	Y_ACTIVATION_GROUP	Protected	Type reference (TYPE)	IF_SALV_CSQ_LOG=>Y_COMPONENT		20101216
9	Y_CLASS_SHORTENED_NAME	Protected	Type reference (TYPE)	IF_SALV_CSQ_LOG=>Y_CLASS		20101216
10	Y_INSTANCE_HANDLE	Protected	Type reference (TYPE)	SALV_CSQT_INSTANCE_HANDLE		20101216

Method Signatures

Method BREAK_POINT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	S_LOG_RECORD	Call by reference	☐	Type reference (TYPE)	IF_SALV_CSQ=>YS_LOG_DATA			20100108

Method BREAK_POINT on class CL_SALV_CSQ_LOG has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLASS	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_TOOL			20090309
2	Importing	COMPONENT	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_COMPONENT			20080815
3	Importing	INSTANCE_HANDLE	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_INSTANCE_HANDLE			20090309
4	Importing	R_APPLICATION_DESCRIPTOR	Value transfer	☑	Object reference (TYPE REF TO)	IF_SALV_CSQ_APPL_RUNTIME_DESCR			20090309
5	Importing	R_PARENT_MESSAGE_POOL	Value transfer	☑	Object reference (TYPE REF TO)	IF_SALV_CSQ_MESSAGE_POOL			20090309

Method CONSTRUCTOR on class CL_SALV_CSQ_LOG has no exception.

Method CREATE_LOGGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLASS	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_TOOL			20090309
2	Importing	COMPONENT	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_COMPONENT			20090309
3	Importing	INSTANCE_HANDLE	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_INSTANCE_HANDLE			20090309
4	Returning	LOG	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_CSQ_LOG		Logger	20090309
5	Importing	R_APPLICATION_DESCRIPTOR	Value transfer	☑	Object reference (TYPE REF TO)	IF_SALV_CSQ_APPL_RUNTIME_DESCR			20090309
6	Importing	R_PARENT_MESSAGE_POOL	Value transfer	☑	Object reference (TYPE REF TO)	IF_SALV_CSQ_MESSAGE_POOL			20090309

Method CREATE_LOGGER on class CL_SALV_CSQ_LOG has no exception.

Method CREATE_RECORDABLE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA	Call by reference	☐	Type reference (TYPE)	ANY			20090306
2	Importing	DATA_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20090306
3	Returning	R_RECORDABLE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_CSQ_RECORDABLE			20090306

Method CREATE_RECORDABLE_OBJECT on class CL_SALV_CSQ_LOG has no exception.

Method DISABLE_TRACE_FOR_THIS_SESSION Signature

Method DISABLE_TRACE_FOR_THIS_SESSION on class CL_SALV_CSQ_LOG has no parameter.
Method DISABLE_TRACE_FOR_THIS_SESSION on class CL_SALV_CSQ_LOG has no exception.

Method GET_ACTIVE_TASK_INSTANCE_HNDL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INSTANCE_HANDLE	Value transfer	☐	Type reference (TYPE)	SALV_CSQT_INSTANCE_HANDLE			20100108

Method GET_ACTIVE_TASK_INSTANCE_HNDL on class CL_SALV_CSQ_LOG has no exception.

Method GET_APPLICATION_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LOG	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_CSQ_APPLICATION_LOG			20080824

Method GET_APPLICATION_LOG on class CL_SALV_CSQ_LOG has no exception.

Method GET_REPLAYED_TRACE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TRACE_ID	Value transfer	☐	Type reference (TYPE)	SALV_CSQT_TRACE_ID			20080903

Method GET_REPLAYED_TRACE_ID on class CL_SALV_CSQ_LOG has no exception.

Method GET_SESSION_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SESSION_LOG	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_CSQ_SESSION_LOG		Log object	20090309

Method GET_SESSION_LOG on class CL_SALV_CSQ_LOG has no exception.

Method GET_UNIGUE_INSTANCE_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVATION_GROUP	Call by reference	☑	Type reference (TYPE)	Y_ACTIVATION_GROUP			20101216
2	Importing	CLASS_SHORTENED_NAME	Call by reference	☐	Type reference (TYPE)	Y_CLASS_SHORTENED_NAME			20101216
3	Importing	INSTANCE_HANDLE	Call by reference	☐	Type reference (TYPE)	Y_INSTANCE_HANDLE			20101216
4	Returning	UNIQUE_INSTANCE_HANDLE	Value transfer	☐	Type reference (TYPE)	Y_INSTANCE_HANDLE			20101216

Method GET_UNIGUE_INSTANCE_HANDLE on class CL_SALV_CSQ_LOG has no exception.

Method IS_BREAK_POINT_REACHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REACHED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100108
2	Importing	S_LOG_RECORD	Call by reference	☐	Type reference (TYPE)	IF_SALV_CSQ=>YS_LOG_DATA			20100108

Method IS_BREAK_POINT_REACHED on class CL_SALV_CSQ_LOG has no exception.

Method PREPARE_BREAK_POINTS Signature

Method PREPARE_BREAK_POINTS on class CL_SALV_CSQ_LOG has no parameter.
Method PREPARE_BREAK_POINTS on class CL_SALV_CSQ_LOG has no exception.

Method READ_TRACE_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EXPIRY_DATE	Value transfer	☐	Type reference (TYPE)	D			20100218
2	Exporting	EXPIRY_TIME	Value transfer	☐	Type reference (TYPE)	T			20100218
3	Exporting	IS_TRACE_ACTIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080906
4	Exporting	TRACE_LEVEL	Value transfer	☐	Type reference (TYPE)	SALV_CSQT_TRACE_LEVEL_CATEGORY		Trace Level Category (Exceptions, Messages, Log entries)	20080906
5	Importing	USER	Value transfer	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20080906

Method READ_TRACE_LEVEL on class CL_SALV_CSQ_LOG has no exception.

Method SET_REPLAYED_TRACE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TRACE_ID	Value transfer	☐	Type reference (TYPE)	SALV_CSQT_TRACE_ID		Trace ID	20080903

Method SET_REPLAYED_TRACE_ID on class CL_SALV_CSQ_LOG has no exception.

Method WRITE_EXCEPTION_TO_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXCEPTION	Value transfer	☐	Object reference (TYPE REF TO)	CX_ROOT			20090528
2	Returning	LOG_RECORD_SEQNO	Value transfer	☐	Type reference (TYPE)	SALV_CSQ_SEQNO			20090528
3	Importing	TASK	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_TASK			20090528

Method WRITE_EXCEPTION_TO_LOG on class CL_SALV_CSQ_LOG has no exception.

Method WRITE_TRACE_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPIRY_DATE	Value transfer	☑	Type reference (TYPE)	D			20100218
2	Importing	EXPIRY_TIME	Value transfer	☑	Type reference (TYPE)	T			20100218
3	Importing	TRACE_LEVEL	Value transfer	☑	Type reference (TYPE)	SALV_CSQT_TRACE_LEVEL_CATEGORY		Trace Level Category (Exceptions, Messages, Log entries)	20080906
4	Importing	USER	Value transfer	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20080906

Method WRITE_TRACE_LEVEL on class CL_SALV_CSQ_LOG has no exception.

History

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