SAP ABAP Class CL_BNK_UTIL_LOG (Utility class for logging)

Hierarchy

☛ SAP_FIN (Software Component) SAP_FIN
   ⤷ FIN-FSCM (Application Component) Financial Supply Chain Management
     ⤷ FIN_BNK_COM_UTIL (Package) Bank Communication: Utilities and tools

Properties

Class	CL_BNK_UTIL_LOG
Short Description	Utility class for logging
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	FIN_BNK_COM_UTIL	Bank Communication: Utilities and tools
Created	20060705	SAP
Last change	20100310	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BNK_UTIL_LOG has no forward declaration.

Interfaces

Class CL_BNK_UTIL_LOG has no interface implemented.

Friends

Class CL_BNK_UTIL_LOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	PRIV_BATCH	Instance attribute	Private	☐	Type reference (TYPE)	BNK_BATCH_IDENTIFIER			20060705
2	PRIV_BATCH_HEADER	Instance attribute	Private	☐	Type reference (TYPE)	BNK_STR_BATCH_HEADER		Structure for Batch Header	20060705
3	PRIV_BATCH_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	BNK_TAB_BATCH_ITEM		Table type for Batch Payment Item	20060705
4	PRIV_CX_EXCEPTION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CX_BNK_EXCEPTION		SUper class for exceptions	20060705
5	PRIV_EXTERNAL_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	BALNREXT		Application Log: External ID	20061025
6	PRIV_G_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	BNK_TYP_ACTIVE			20060705
7	PRIV_LOG_DISABLED	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Checkbox	20060705
8	PRIV_LOG_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20060705
9	PRIV_MSG_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	I			20060705
10	PRIV_SREF_UTIL_LOG	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_BNK_UTIL_LOG		Utility class for logging	20060705
11	PRIV_TAB_BUFFER_LOG_LAYER	Instance attribute	Private	☐	Type reference (TYPE)	BNK_TAB_LOG_LYR		Table type for log layer	20060705
12	PRIV_TAB_LOG_LAYER	Instance attribute	Private	☐	Type reference (TYPE)	BNK_TAB_LOG_LYR		Table type for log layer	20060705
13	PRIV_TAB_MESSAGES	Instance attribute	Private	☐	Type reference (TYPE)	BNK_TAB_LOG_MESSAGES		Log messages	20060705

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Instance method	Public	Method	Adds message to the log	20060707
2	CLOSE_LOG	Instance method	Public	Method	closes the log	20060706
3	DISABLE_LOG	Instance method	Public	Method	disable logging functionality	20060707
4	FIND_LOG	Instance method	Public	Method	finds the required log	20060705
5	GET_LOG_HANDLE	Instance method	Private	Method	Gets the log handle	20060705
6	GET_LOG_LAYER_INFO	Instance method	Private	Method	Gets the layer info	20060705
7	GET_MESSAGES	Instance method	Public	Method	Gets the messages	20060707
8	OPEN_LOG	Instance method	Public	Method	opens the log	20060705
9	RETURN_CODE_FILL	Static method	Public	Method	Fills the return code	20060801
10	SAVE_LOG	Instance method	Private	Method	Saves the log	20060706
11	S_INSTANCE	Static method	Public	Method	Static instance for the log class	20060705

Events

Class CL_BNK_UTIL_LOG has no event.

Types

Class CL_BNK_UTIL_LOG has no local type.

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DETAIL_LEVEL	Call by reference	☐	Type reference (TYPE)	BALLEVEL	' '	Application Log: Level of detail	20060707
2	Importing	I_MESSAGE	Call by reference	☐	Type reference (TYPE)	BNK_STR_LOG_MESSAGE		Structure for log message	20060707

#	Exception	Resumable	Description	Created on
1	CX_BNK_LOG	☐	Exception class for logs	20060707

Method CLOSE_LOG Signature

Method CLOSE_LOG on class CL_BNK_UTIL_LOG has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BNK_LOG	☐	Exception class for logs	20060706

Method DISABLE_LOG Signature

Method DISABLE_LOG on class CL_BNK_UTIL_LOG has no parameter.
Method DISABLE_LOG on class CL_BNK_UTIL_LOG has no exception.

Method FIND_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BAL_T_LOGH		Log Handles	20060705
2	Exporting	ET_MSG_HANDLE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSGH		Application Log: Message Handle Table	20060705
3	Exporting	E_LOG_FOUND	Call by reference	☐	Type reference (TYPE)	XFELD		'X': Log(s) Found	20060705
4	Importing	I_EXTERNAL_NUMBER	Call by reference	☑	Type reference (TYPE)	BALNREXT		External Identification	20060705
5	Importing	I_LAYER_NAME	Call by reference	☑	Type reference (TYPE)	BNK_COM_LOG_LAYER_NAME		Name of Layer	20060705
6	Importing	I_LAYER_TYPE	Call by reference	☑	Type reference (TYPE)	BNK_COM_LOG_LAYER_TYPE		Layer ID	20060705
7	Importing	I_LOG_DATE_HIGH	Call by reference	☑	Type reference (TYPE)	BALDATE		Creation Date of Log (To)	20060705
8	Importing	I_LOG_DATE_LOW	Call by reference	☑	Type reference (TYPE)	BALDATE		Creation Date of Log (From)	20060705
9	Importing	I_LOG_TIME_HIGH	Call by reference	☑	Type reference (TYPE)	BALTIME		Creation Time of Log (To)	20060705
10	Importing	I_LOG_TIME_LOW	Call by reference	☑	Type reference (TYPE)	BALTIME		Creation Time of Log (From)	20060705
11	Importing	I_TRANSACTION	Call by reference	☑	Type reference (TYPE)	BALTCODE		Transaction Code	20060705
12	Importing	I_USER	Call by reference	☑	Type reference (TYPE)	BALUSER		User	20060705

Method FIND_LOG on class CL_BNK_UTIL_LOG has no exception.

Method GET_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20060705
2	Importing	I_EXTERNAL_NUMBER	Call by reference	☑	Type reference (TYPE)	BALNREXT		Application Log: External ID	20061003
3	Importing	I_LOG_LAYER_NAME	Call by reference	☐	Type reference (TYPE)	BNK_COM_LOG_LAYER_NAME		Log layer description	20060705
4	Importing	I_LOG_LAYER_TYPE	Call by reference	☐	Type reference (TYPE)	BNK_COM_LOG_LAYER_TYPE		Log layer type	20060705
5	Importing	I_SUBOBJECT	Call by reference	☐	Type reference (TYPE)	BALSUBOBJ		Application Log: Subobject	20060705

Method GET_LOG_HANDLE on class CL_BNK_UTIL_LOG has no exception.

Method GET_LOG_LAYER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LOG_LAYER	Call by reference	☐	Type reference (TYPE)	BNK_LOG_LYR		Log layer maintenance	20060705
2	Importing	I_LOG_LAYER_NAME	Call by reference	☐	Type reference (TYPE)	BNK_COM_LOG_LAYER_NAME		Log layer description	20060705
3	Importing	I_LOG_LAYER_TYPE	Call by reference	☐	Type reference (TYPE)	BNK_COM_LOG_LAYER_TYPE		Log layer type	20060705

Method GET_LOG_LAYER_INFO on class CL_BNK_UTIL_LOG has no exception.

Method GET_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOG_MESSAGES	Call by reference	☐	Type reference (TYPE)	BNK_TAB_LOG_MESSAGES		Log messages	20060707

Method GET_MESSAGES on class CL_BNK_UTIL_LOG has no exception.

Method OPEN_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BATCH_NO	Call by reference	☑	Type reference (TYPE)	BNK_COM_BTCH_NO		Batch Identification Number	20060705
2	Importing	I_EXTERNAL_NUMBER	Call by reference	☑	Type reference (TYPE)	BALNREXT		Application Log: External ID	20061003
3	Importing	I_ITEM_NO	Call by reference	☑	Type reference (TYPE)	BNK_COM_BTCH_CTR		Item Counter	20060705
4	Importing	I_LOG_LAYER_NAME	Call by reference	☐	Type reference (TYPE)	BNK_COM_LOG_LAYER_NAME		Log layer description	20060705
5	Importing	I_LOG_LAYER_TYPE	Call by reference	☐	Type reference (TYPE)	BNK_COM_LOG_LAYER_TYPE		Log layer type	20060705

Method OPEN_LOG on class CL_BNK_UTIL_LOG has no exception.

Method RETURN_CODE_FILL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TAB_RET	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20060801
2	Importing	I_MSGID	Call by reference	☐	Type reference (TYPE)	SY-MSGID		Message Class	20060801
3	Importing	I_MSGNO	Call by reference	☐	Type reference (TYPE)	SY-MSGNO		Message Number	20060801
4	Importing	I_MSGTY	Call by reference	☐	Type reference (TYPE)	SY-MSGTY		Message Type	20060801
5	Importing	I_MSGV1	Call by reference	☐	Type reference (TYPE)	SY-MSGV1		Message Variable	20060801
6	Importing	I_MSGV2	Call by reference	☐	Type reference (TYPE)	SY-MSGV2		Message Variable	20060801
7	Importing	I_MSGV3	Call by reference	☐	Type reference (TYPE)	SY-MSGV3		Message Variable	20060801
8	Importing	I_MSGV4	Call by reference	☐	Type reference (TYPE)	SY-MSGV4		Message Variable	20060801

Method RETURN_CODE_FILL on class CL_BNK_UTIL_LOG has no exception.

Method SAVE_LOG Signature

Method SAVE_LOG on class CL_BNK_UTIL_LOG has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BNK_LOG	☐	Exception class for logs	20060706

Method S_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SREF_BNK_UTIL_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_BNK_UTIL_LOG		Utility class for logging	20060705

Method S_INSTANCE on class CL_BNK_UTIL_LOG has no exception.

History

Last changed by/on	SAP	20100310
SAP Release Created in	700