SAP ABAP Class IF_SIW_LOG (Logging Interface of SIW)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SIW_LOG	Logklasse	20061216

Properties

Class	IF_SIW_LOG
Short Description	Logging Interface of SIW
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package
Created	20061216	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class IF_SIW_LOG has no forward declaration.

Interfaces

Class IF_SIW_LOG has no interface implemented.

Friends

Class IF_SIW_LOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_MSG_TYPE_ABORT	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'A'		20101123
2	CON_MSG_TYPE_ERROR	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'E'		20101123
3	CON_MSG_TYPE_INFORMATION	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'I'		20101123
4	CON_MSG_TYPE_SUCCESS	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'S'		20101123
5	CON_MSG_TYPE_WARNING	Constant	Public	☐	Type reference (TYPE)	SYMSGTY	'W'		20101123
6	CON_NODE_TYPE_IMPLEMENTATION	Constant	Public	☐	Type reference (TYPE)	SIW_DTE_NODE_ID	'impl'		20110209
7	CON_NODE_TYPE_MAPPIG_ROOT	Constant	Public	☐	Type reference (TYPE)	SIW_DTE_NODE_ID	'mapping'		20110209
8	CON_NODE_TYPE_PROJECT	Constant	Public	☐	Type reference (TYPE)	SIW_DTE_NODE_ID	'project'		20110209
9	DUMMY	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20061216

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BAL_MSG	Instance method	Public	Method	Adds a BAL Message from the System Variables	20101221
2	ADD_EXCEPTION	Instance method	Public	Method	Adds a Message from Exception	20061219
3	ADD_MSG	Instance method	Public	Method	Adds a Message from System Variables	20061216
4	ADD_MSG_FROM_BAL	Instance method	Public	Method	Adds a Message from Application Log Handle	20090828
5	ADD_S_MSG	Instance method	Public	Method	Adds a Message from Application Log Message Data	20061216
6	ADD_T_MSG	Instance method	Public	Method	Adds Messages from a List of Application Log Messages	20100831
7	BAL_LOG_EXC_ADD	Instance method	Public	Method	Calls Function BAL_LOG_EXC_ADD with extra Parameters	20110218
8	CLEAR	Instance method	Public	Method	Removes the Messages from the LOG without Closing the Log	20101123
9	CLOSE	Instance method	Public	Method	Close a Dialogbox	20110329
10	DISPLAY	Instance method	Public	Method	Displays a Dialogbox with all Logged Messages	20101222
11	GET_ALL_MESSAGES	Instance method	Public	Method	Returns a List of Application Log Messages	20100831
12	HAS_MESSAGES	Instance method	Public	Method	Returns 'True' when the Log Contains Messages	20101123

Events

Class IF_SIW_LOG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TTY_MSG	Public	See coding			20100802	tty_msg type table of bal_s_msg with default key

Method Signatures

Method ADD_BAL_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Value transfer	☐	Type reference (TYPE)	SY-MSGID	SY-MSGID		20101221
2	Importing	MSGNO	Value transfer	☐	Type reference (TYPE)	SY-MSGNO	SY-MSGNO		20101221
3	Importing	MSGTY	Value transfer	☐	Type reference (TYPE)	SY-MSGTY	SY-MSGTY		20101221
4	Importing	MSGV1	Value transfer	☐	Type reference (TYPE)	SY-MSGV1	SY-MSGV1		20101221
5	Importing	MSGV2	Value transfer	☐	Type reference (TYPE)	SY-MSGV2	SY-MSGV2		20101221
6	Importing	MSGV3	Value transfer	☐	Type reference (TYPE)	SY-MSGV3	SY-MSGV3		20101221
7	Importing	MSGV4	Value transfer	☐	Type reference (TYPE)	SY-MSGV4	SY-MSGV4		20101221
8	Importing	NAVIGATION_CONTEXT	Value transfer	☑	Type reference (TYPE)	SIW_STR_NODE_SEARCH			20101221

#	Exception	Resumable	Description	Created on
1	CX_SIW_CALL_ERROR	☐		20101221

Method ADD_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20061219
2	Importing	I_FLG_PREVIOUS	Value transfer	☐	Type reference (TYPE)	XFELD	'X'	Identifies Whether Previous Exceptions Exists	20070314
3	Importing	I_NAVIGATION_CONTEXT	Value transfer	☑	Type reference (TYPE)	SIW_STR_NODE_SEARCH		Structure for node search pop	20110222

Method ADD_EXCEPTION on class IF_SIW_LOG has no exception.

Method ADD_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Value transfer	☐	Type reference (TYPE)	SY-MSGID	SY-MSGID	Message Class	20061216
2	Importing	MSGNO	Value transfer	☐	Type reference (TYPE)	SY-MSGNO	SY-MSGNO	Message Number	20061216
3	Importing	MSGTY	Value transfer	☐	Type reference (TYPE)	SY-MSGTY	SY-MSGTY	Message Type	20061216
4	Importing	MSGV1	Value transfer	☐	Type reference (TYPE)	SY-MSGV1	SY-MSGV1	Message Variable	20061216
5	Importing	MSGV2	Value transfer	☐	Type reference (TYPE)	SY-MSGV2	SY-MSGV2	Message Variable	20061216
6	Importing	MSGV3	Value transfer	☐	Type reference (TYPE)	SY-MSGV3	SY-MSGV3	Message Variable	20061216
7	Importing	MSGV4	Value transfer	☐	Type reference (TYPE)	SY-MSGV4	SY-MSGV4	Message Variable	20061216
8	Importing	NAVIGATION_CONTEXT	Value transfer	☑	Type reference (TYPE)	SIW_STR_NODE_SEARCH		Structure for node search pop	20110214

#	Exception	Resumable	Description	Created on
1	CX_SIW_CALL_ERROR	☐		20101123

Method ADD_MSG_FROM_BAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_BAL_MSG_HANDLE	Call by reference	☐	Type reference (TYPE)	BAL_T_MSGH		Application Log: Message Handle Table	20090828

Method ADD_MSG_FROM_BAL on class IF_SIW_LOG has no exception.

Method ADD_S_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STR_MSG	Value transfer	☐	Type reference (TYPE)	BAL_S_MSG		Application Log: Message Data	20061216

Method ADD_S_MSG on class IF_SIW_LOG has no exception.

Method ADD_T_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_MSG	Call by reference	☐	Type reference (TYPE)	TTY_MSG		Application Log: List of Message Data	20100831

Method ADD_T_MSG on class IF_SIW_LOG has no exception.

Method BAL_LOG_EXC_ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG_WAS_DISPLAYED	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110218
2	Exporting	E_MSG_WAS_LOGGED	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110218
3	Exporting	E_S_MSG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALMSGHNDL		Application Log: Message handle	20110218
4	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20110218
5	Importing	I_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20110218
6	Importing	I_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20110218
7	Importing	I_PROBCLASS	Call by reference	☑	Type reference (TYPE)	BALPROBCL		Application log: Message problem class	20110218
8	Importing	I_S_CONTEXT	Call by reference	☑	Type reference (TYPE)	BAL_S_CONT		Application Log: Context	20110218

#	Exception	Resumable	Description	Created on
1	LOG_IS_FULL	☐	Message number 999999 reached. Log is full	20110218
2	LOG_NOT_FOUND	☐	Log not found	20110218
3	MSG_INCONSISTENT	☐	Message inconsistent	20110218

Method CLEAR Signature

Method CLEAR on class IF_SIW_LOG has no parameter.
Method CLEAR on class IF_SIW_LOG has no exception.

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENT_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SIW_LOG_DIALOG_HANDLER		When you Want to react on Dialog Events	20110329
2	Importing	I_FLG_AMODAL	Value transfer	☐	Type reference (TYPE)	C	'X'	If set the Dialog is Displayed in another Mode	20110329
3	Importing	I_FLG_CLOSE	Value transfer	☐	Type reference (TYPE)	C	'X'	If set the BAL LOG is Closed	20110329
4	Importing	I_FLG_POPUP	Value transfer	☐	Type reference (TYPE)	C	'X'	If set the Log is Displayed in a Popup	20110329

Method CLOSE on class IF_SIW_LOG has no exception.

Method DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENT_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SIW_LOG_DIALOG_HANDLER		When you Want to react on Dialog Events	20101222
2	Importing	I_FLG_AMODAL	Value transfer	☐	Type reference (TYPE)	C	'X'	If set the Dialog is Displayed in another Mode	20101222
3	Importing	I_FLG_CLOSE	Value transfer	☐	Type reference (TYPE)	C	'X'	If set the BAL LOG is Closed	20101222
4	Importing	I_FLG_POPUP	Value transfer	☐	Type reference (TYPE)	C	'X'	If set the Log is Displayed in a Popup	20101222

Method DISPLAY on class IF_SIW_LOG has no exception.

Method GET_ALL_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TAB_MSG	Value transfer	☐	Type reference (TYPE)	TTY_MSG		Application Log: List of Message Data	20100831

Method GET_ALL_MESSAGES on class IF_SIW_LOG has no exception.

Method HAS_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FLG_HAS_MESSAGES	Value transfer	☐	Type reference (TYPE)	XFELD			20101123

Method HAS_MESSAGES on class IF_SIW_LOG has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in