SAP ABAP Class /AIN/CL_KBN_OLOG (Logging Base Class)

Hierarchy

☛ AIN (Software Component) AIN 710: Add-On Installation
   ⤷ AIE-AII-AP (Application Component) Application
     ⤷ /AIN/KANBAN (Package) Auto-ID Kanban Process

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/AIN/CL_KBN_KBNOLOG	Kanban Detection Logging	20060410

Properties

Class	/AIN/CL_KBN_OLOG
Short Description	Logging Base Class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/AIN/KANBAN	Auto-ID Kanban Process
Created	20060328	SAP
Last change	20141109	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /AIN/CL_KBN_OLOG has no forward declaration.

Interfaces

Class /AIN/CL_KBN_OLOG has no interface implemented.

Friends

Class /AIN/CL_KBN_OLOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	EX	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass of All Global Exceptions	20060328
2	GC_LOG_LEVEL_ALLOWED	Constant	Private	☐	Type reference (TYPE)	CHAR10	'SIWEA'	Permitted Log Level	20060328
3	GC_LOG_LEVEL_DEFAULT	Constant	Private	☐	Attribute reference (LIKE)	SY-MSGTY	'I'	Standard Log Level	20060328
4	GC_LOG_LEVEL_XMLLOG	Constant	Private	☐	Attribute reference (LIKE)	SY-MSGTY	'S'	Message Category	20060328
5	GC_XML_SIZE	Constant	Private	☐	Type reference (TYPE)	I	2000		20060328
6	LAST_BAPIRET2	Instance attribute	Public	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20060728
7	MT_BALSORT	Instance attribute	Private	☐	See coding				20060328
8	MT_BAPIRET2	Instance attribute	Protected	☐	Type reference (TYPE)	BAPIRETTAB		Return Parameters	20060328
9	MT_CONTEXT	Instance attribute	Protected	☐	Type reference (TYPE)	/AIN/KBN_BAL_S_CONT_TAB		Application Log: Context	20060328
10	MT_MSG_BUFFER	Instance attribute	Protected	☐	Type reference (TYPE)	/AIN/KBN_BAL_S_MSGEXC_TAB		Table Type for bal_s_msg	20060328
11	MV_BALLOGHNDL	Instance attribute	Protected	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20060328
12	MV_CONTEXT_USED	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLE		Boolean Variable	20060328
13	MV_COUNT	Instance attribute	Protected	☐	Type reference (TYPE)	I	0	Number of Log Calls	20060328
14	MV_DO_NOTHING	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLE_D	'X'	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20060811
15	MV_LOG_LEVEL	Instance attribute	Protected	☐	Attribute reference (LIKE)	SY-MSGTY	'S'	Minimum Log Level	20060328
16	MV_LOG_LEVEL_C	Instance attribute	Protected	☐	See coding				20060328
17	MV_LOG_LEVEL_CHECK	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLEAN	SPACE	Test Active on Log Level	20060328
18	MV_LOG_OBJECT	Instance attribute	Protected	☐	Type reference (TYPE)	BALOBJ_D		Application Log: Object Name (Application Abbreviation)	20060328
19	MV_LOG_SUBOBJECT	Instance attribute	Protected	☐	Type reference (TYPE)	BALSUBOBJ		Application Log: Subobject	20060328
20	MV_SAVE_IN_UPDATE_TASK	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLEAN	'X'	Save in Update Task	20060328
21	MV_TOBUFFER	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLEAN	SPACE	Log in Buffer	20060328
22	MV_XMLLOG_CALL_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	NUMC10	1	Numeric Character Field, Length 10	20060328
23	TEXT	Instance attribute	Public	☐	Type reference (TYPE)	BAPI_MSG		Message Text	20060328

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ELEMENT_TO_MSG_BUFFER	Instance method	Private	Method		20060328
2	ADD_LAST_MESSAGE_TO_TABLE	Instance method	Public	Method		20060816
3	ADD_TO_BAPIRET2	Instance method	Private	Method		20060328
4	CONSTRUCTOR	Instance method	Public	Constructor		20060328
5	CUT_MSG_BUFFER	Instance method	Public	Method		20060328
6	END	Instance method	Public	Method		20060328
7	GET_BAPIRET2	Instance method	Public	Method		20060328
8	GET_CURRENT_BALSORT	Instance method	Protected	Method		20060328
9	GET_CURRENT_CONTEXT	Instance method	Protected	Method		20060328
10	GET_HANDLE	Instance method	Protected	Method		20060328
11	GET_LOG_HANDLE	Instance method	Public	Method		20060328
12	GET_LONG_TEXT	Static method	Public	Method		20060421
13	IS_ABOVE_LOG_LEVEL	Instance method	Protected	Method		20060328
14	IS_A_ENABLED	Instance method	Public	Method		20060328
15	IS_CONTEXT_USED	Instance method	Protected	Method		20060328
16	IS_E_ENABLED	Instance method	Public	Method		20060328
17	IS_I_ENABLED	Instance method	Public	Method		20060328
18	IS_S_ENABLED	Instance method	Public	Method		20060328
19	IS_W_ENABLED	Instance method	Public	Method		20060328
20	LOG	Instance method	Public	Method		20060328
21	LOG_BAPIRET2	Instance method	Protected	Method		20060328
22	LOG_BUFFER	Instance method	Private	Method		20060328
23	LOG_EX	Instance method	Protected	Method		20060328
24	LOG_EXCEPTION	Instance method	Private	Method		20060328
25	LOG_MESSAGE	Instance method	Private	Method		20060328
26	LOG_MSG	Instance method	Protected	Method		20060328
27	PASTE_MSG_BUFFER	Instance method	Public	Method		20060328
28	POKE_CONTEXT	Instance method	Public	Method		20060328
29	POPUP_BAPIRET2	Static method	Public	Method		20060328
30	POP_CONTEXT	Instance method	Public	Method		20060328
31	PUSH_CONTEXT	Instance method	Public	Method		20060328
32	SET_LOGGING_TO_BUFFER	Instance method	Public	Method		20060328
33	SET_LOG_LEVEL	Instance method	Public	Method		20060328

Events

Class /AIN/CL_KBN_OLOG has no event.

Types

Class /AIN/CL_KBN_OLOG has no local type.

Method Signatures

Method ADD_ELEMENT_TO_MSG_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BAL_S_EXC	Call by reference	☑	Type reference (TYPE)	BAL_S_EXC			20060328
2	Importing	BAL_S_MSG	Call by reference	☑	Type reference (TYPE)	BAL_S_MSG			20060328

Method ADD_ELEMENT_TO_MSG_BUFFER on class /AIN/CL_KBN_OLOG has no exception.

Method ADD_LAST_MESSAGE_TO_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BAPIRET2	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20060816

Method ADD_LAST_MESSAGE_TO_TABLE on class /AIN/CL_KBN_OLOG has no exception.

Method ADD_TO_BAPIRET2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAPIRET2	Call by reference	☑	Type reference (TYPE)	BAPIRET2			20060328
2	Importing	IS_MSG	Call by reference	☑	Type reference (TYPE)	BAL_S_MSG			20060328
3	Importing	IV_BALMNR	Call by reference	☑	Type reference (TYPE)	BALMNR			20060328
4	Returning	RS_BAPIRET2	Value transfer	☐	Type reference (TYPE)	BAPIRET2			20060328

Method ADD_TO_BAPIRET2 on class /AIN/CL_KBN_OLOG has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DO_NOTHING	Call by reference	☐	Type reference (TYPE)	BOOLE_D	SPACE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20060811
2	Importing	IV_LOG_LEVEL	Call by reference	☑	Attribute reference (LIKE)	SY-MSGTY	'I'		20060328
3	Importing	IV_LOG_LEVEL_CHECK	Call by reference	☑	Type reference (TYPE)	BOOLE_D	'X'		20060328
4	Importing	IV_LOG_OBJECT	Call by reference	☑	Type reference (TYPE)	BALOBJ_D	SPACE		20060328
5	Importing	IV_LOG_SUBOBJECT	Call by reference	☑	Type reference (TYPE)	BALSUBOBJ	SPACE		20060328
6	Importing	IV_SAVE_IN_UPDATE_TASK	Call by reference	☑	Type reference (TYPE)	BOOLE_D	'X'		20060328

Method CONSTRUCTOR on class /AIN/CL_KBN_OLOG has no exception.

Method CUT_MSG_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_MSG_BUFFER	Value transfer	☐	Type reference (TYPE)	/AIN/KBN_BAL_S_MSGEXC_TAB			20060328

Method CUT_MSG_BUFFER on class /AIN/CL_KBN_OLOG has no exception.

Method END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_BAPIRET2	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB			20060328

Method END on class /AIN/CL_KBN_OLOG has no exception.

Method GET_BAPIRET2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BAPIRET2	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB			20060328

Method GET_BAPIRET2 on class /AIN/CL_KBN_OLOG has no exception.

Method GET_CURRENT_BALSORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_BALSORT	Value transfer	☐	Type reference (TYPE)	BALSORT			20060328

Method GET_CURRENT_BALSORT on class /AIN/CL_KBN_OLOG has no exception.

Method GET_CURRENT_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_CONTEXT	Value transfer	☐	Type reference (TYPE)	BAL_S_CONT			20060328

Method GET_CURRENT_CONTEXT on class /AIN/CL_KBN_OLOG has no exception.

Method GET_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BALLOGHNDL	Value transfer	☐	Type reference (TYPE)	BALLOGHNDL			20060328

Method GET_HANDLE on class /AIN/CL_KBN_OLOG has no exception.

Method GET_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HANDLE	Value transfer	☐	Type reference (TYPE)	BALLOGHNDL			20060328

Method GET_LOG_HANDLE on class /AIN/CL_KBN_OLOG has no exception.

Method GET_LONG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USE_INTERNAL_FORMATTER	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20060428
2	Exporting	LONGTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20060421
3	Importing	MSGID	Call by reference	☑	Type reference (TYPE)	SYMSGID		Message Class	20060421
4	Importing	MSGNO	Call by reference	☑	Type reference (TYPE)	SYMSGNO		Message Number	20060421
5	Importing	MSGTY	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type	20060421
6	Importing	MSGV1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20060421
7	Importing	MSGV2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20060421
8	Importing	MSGV3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20060421
9	Importing	MSGV4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20060421
10	Exporting	SHORTTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20060428

Method GET_LONG_TEXT on class /AIN/CL_KBN_OLOG has no exception.

Method IS_ABOVE_LOG_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOG_LEVEL	Call by reference	☐	Type reference (TYPE)	CHAR1			20060328
2	Returning	RV_ABOVE	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20060328

Method IS_ABOVE_LOG_LEVEL on class /AIN/CL_KBN_OLOG has no exception.

Method IS_A_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20060328

Method IS_A_ENABLED on class /AIN/CL_KBN_OLOG has no exception.

Method IS_CONTEXT_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONTEXT_USED	Value transfer	☐	Type reference (TYPE)	BOOLE			20060328

Method IS_CONTEXT_USED on class /AIN/CL_KBN_OLOG has no exception.

Method IS_E_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20060328

Method IS_E_ENABLED on class /AIN/CL_KBN_OLOG has no exception.

Method IS_I_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20060328

Method IS_I_ENABLED on class /AIN/CL_KBN_OLOG has no exception.

Method IS_S_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20060328

Method IS_S_ENABLED on class /AIN/CL_KBN_OLOG has no exception.

Method IS_W_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	BOOLE_D			20060328

Method IS_W_ENABLED on class /AIN/CL_KBN_OLOG has no exception.

Method LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EX	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT			20060328
2	Importing	IS_MSG	Call by reference	☑	Type reference (TYPE)	BAL_S_MSG			20060328
3	Importing	IT_BAPIRET2	Call by reference	☑	Type reference (TYPE)	BAPIRETTAB			20060328
4	Importing	IV_EX_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY	'S'		20060328
5	Returning	RS_RETURN	Value transfer	☐	Type reference (TYPE)	BAPIRET2			20060328

Method LOG on class /AIN/CL_KBN_OLOG has no exception.

Method LOG_BAPIRET2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BAPIRET2	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB			20060328

Method LOG_BAPIRET2 on class /AIN/CL_KBN_OLOG has no exception.

Method LOG_BUFFER Signature

Method LOG_BUFFER on class /AIN/CL_KBN_OLOG has no parameter.
Method LOG_BUFFER on class /AIN/CL_KBN_OLOG has no exception.

Method LOG_EX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EX	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT			20060328
2	Importing	IV_EX_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY	'S'		20060328
3	Returning	RS_BAPIRET2	Value transfer	☐	Type reference (TYPE)	BAPIRET2			20060328

Method LOG_EX on class /AIN/CL_KBN_OLOG has no exception.

Method LOG_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAL_S_EXC	Call by reference	☐	Type reference (TYPE)	BAL_S_EXC			20060328
2	Importing	IV_BALLOGHNDL	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL			20060328
3	Returning	RS_BAPIRET2	Value transfer	☐	Type reference (TYPE)	BAPIRET2			20060328

Method LOG_EXCEPTION on class /AIN/CL_KBN_OLOG has no exception.

Method LOG_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAPIRET2	Call by reference	☑	Type reference (TYPE)	BAPIRET2			20060328
2	Importing	IS_MSG	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG			20060328
3	Importing	IV_BALLOGHNDL	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL			20060328
4	Returning	RS_BAPIRET2	Value transfer	☐	Type reference (TYPE)	BAPIRET2			20060328

Method LOG_MESSAGE on class /AIN/CL_KBN_OLOG has no exception.

Method LOG_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MSG	Call by reference	☑	Type reference (TYPE)	BAL_S_MSG			20060328
2	Returning	RS_BAPIRET2	Value transfer	☐	Type reference (TYPE)	BAPIRET2			20060328

Method LOG_MSG on class /AIN/CL_KBN_OLOG has no exception.

Method PASTE_MSG_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MSG_BUFFER	Call by reference	☐	Type reference (TYPE)	/AIN/KBN_BAL_S_MSGEXC_TAB			20060328

Method PASTE_MSG_BUFFER on class /AIN/CL_KBN_OLOG has no exception.

Method POKE_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONTEXT_DATA	Call by reference	☑	Type reference (TYPE)	ANY			20060328
2	Importing	IV_BALSORT	Call by reference	☑	Type reference (TYPE)	BALSORT			20060328
3	Importing	IV_CONTEXT_VALUE	Call by reference	☑	Type reference (TYPE)	BALCVAL			20060328
4	Importing	IV_DDIC_TABNAME	Call by reference	☐	Type reference (TYPE)	BALTABNAME			20060328

Method POKE_CONTEXT on class /AIN/CL_KBN_OLOG has no exception.

Method POPUP_BAPIRET2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BAPIRET2	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB			20060328

Method POPUP_BAPIRET2 on class /AIN/CL_KBN_OLOG has no exception.

Method POP_CONTEXT Signature

Method POP_CONTEXT on class /AIN/CL_KBN_OLOG has no parameter.
Method POP_CONTEXT on class /AIN/CL_KBN_OLOG has no exception.

Method PUSH_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONTEXT_DATA	Call by reference	☑	Type reference (TYPE)	ANY			20060328
2	Importing	IV_BALSORT	Call by reference	☑	Type reference (TYPE)	BALSORT			20060328
3	Importing	IV_CONTEXT_VALUE	Call by reference	☑	Type reference (TYPE)	BALCVAL			20060328
4	Importing	IV_DDIC_TABNAME	Call by reference	☑	Type reference (TYPE)	BALTABNAME			20060328

Method PUSH_CONTEXT on class /AIN/CL_KBN_OLOG has no exception.

Method SET_LOGGING_TO_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TOBUFFER	Call by reference	☐	Type reference (TYPE)	BOOLEAN			20060328

Method SET_LOGGING_TO_BUFFER on class /AIN/CL_KBN_OLOG has no exception.

Method SET_LOG_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOG_LEVEL	Call by reference	☐	Attribute reference (LIKE)	SY-MSGTY			20060328

Method SET_LOG_LEVEL on class /AIN/CL_KBN_OLOG has no exception.

History

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