SAP ABAP Class CL_CLB_BAL (BAL helper class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-STW (Application Component) Social Media ABAP Integration Library
     ⤷ S_CLB_COMMON (Package) Common Objects and Services of the Collaboration Platform

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CLB_LOG	Collaboration: Log functions	20120830

Properties

Class	CL_CLB_BAL
Short Description	BAL helper class
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_CLB_COMMON	Common Objects and Services of the Collaboration Platform
Created	20120807	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CLB_BAL has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CLB_LOG	☐	☐	Collaboration: Log functions	20120830

Friends

Class CL_CLB_BAL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BALPROBCLASS	Constant	Public	☐	See coding				20120808
2	BAL_OBJECT	Constant	Public	☐	Type reference (TYPE)	BALOBJ_D	'SAIL'		20120808
3	BAL_SUBOBJECTS	Constant	Public	☐	See coding				20120808
4	GC_LOG_MODE	Constant	Public	☐	See coding				20120830
5	GT_INSTANCES	Static Attribute	Protected	☐	See coding				20130211
6	GV_DEBUG_MODE	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130211
7	GV_EOT_HANDLER_SET	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Boolean Variable (X=True, -=False, Space=Unknown)	20120903
8	GV_IS_ACTIVE	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	'-'		20120830
9	GV_STRING	Static Attribute	Public	☐	Type reference (TYPE)	STRING		Used for message... INTO	20120808
10	GV_TRACE_MODE	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130211
11	MC_PARID	Constant	Protected	☐	See coding		'CLB_LOG'		20120830
12	MS_INSTANCE	Instance attribute	Protected	☐	Type reference (TYPE)	TY_LOG_INSTANCE			20120831

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE	Static method	Public	Method	Activates the log in the user's parameters	20120830
2	ADD_BAPIRET2	Instance method	Protected	Method	Add BAPI messages	20120830
3	ADD_EXCEPTION	Instance method	Protected	Method	Add an exception to the log	20120807
4	ADD_MESSAGE	Instance method	Protected	Method	Add a message to the log	20120807
5	ADD_TEXT	Instance method	Protected	Method	Add free text to the log	20120807
6	CHECK_SETTINGS	Static method	Public	Method	Checks if the log is active	20120830
7	CLOSE	Static method	Protected	Method	Close the log	20120903
8	CONSTRUCTOR	Instance method	Protected	Constructor	CONSTRUCTOR	20120831
9	DEACTIVATE	Static method	Public	Method	Dectivates the log in the user's parameters	20120830
10	HANDLE_EOT	Static method	Private	Event handling method	Handles the end of the transaction	20120903
11	ON_EOT	Static method	Protected	Method	On end of transaction	20120903
12	OPEN	Instance method	Protected	Method	Open the log	20120807
13	SAVE	Static method	Protected	Method	Save the log	20120830
14	S_CREATE	Static method	Public	Method	Create a new log	20120807

Events

Class CL_CLB_BAL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_LOG_INSTANCE	Protected	See coding			20120830	BEGIN OF ty_log_instance, balsubobj TYPE balsubobj, log_instance TYPE REF TO cl_clb_bal, balloghndl TYPE balloghndl, bal_s_log TYPE bal_s_log, counter TYPE i, END OF ty_log_instance

Method Signatures

Method ACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DEBUG_MODE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120830
2	Importing	IV_TRACE_MODE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120830

Method ACTIVATE on class CL_CLB_BAL has no exception.

Method ADD_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		Table with BAPI Return Information	20120830
2	Importing	IV_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	SPACE	Boolean Variable (X=True, -=False, Space=Unknown)	20120830

Method ADD_BAPIRET2 on class CL_CLB_BAL has no exception.

Method ADD_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'E'	Message Type	20120807
2	Importing	IV_PROBCLASS	Call by reference	☐	Type reference (TYPE)	BALPROBCL	'4'	Application log: Message problem class	20120807
3	Importing	IX_ROOT	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20120807

Method ADD_EXCEPTION on class CL_CLB_BAL has no exception.

Method ADD_MESSAGE 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		Application Log: Message Data	20120807
2	Importing	IV_AS_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'-'	Message Type	20120830
3	Importing	IV_PROBCLASS	Call by reference	☐	Type reference (TYPE)	BALPROBCL	'4'	Application log: Message problem class	20120830

Method ADD_MESSAGE on class CL_CLB_BAL has no exception.

Method ADD_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20120808
2	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20120808
3	Importing	IV_PROBCLASS	Call by reference	☐	Type reference (TYPE)	BALPROBCL	'4'	Application log: Message problem class	20120808

Method ADD_TEXT on class CL_CLB_BAL has no exception.

Method CHECK_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120830

Method CHECK_SETTINGS on class CL_CLB_BAL has no exception.

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_INSTANCE	Call by reference	☐	Type reference (TYPE)	TY_LOG_INSTANCE		Application Log: Log Handle	20120903

Method CLOSE on class CL_CLB_BAL has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CLB_BAL has no parameter.
Method CONSTRUCTOR on class CL_CLB_BAL has no exception.

Method DEACTIVATE Signature

Method DEACTIVATE on class CL_CLB_BAL has no parameter.
Method DEACTIVATE on class CL_CLB_BAL has no exception.

Method HANDLE_EOT Signature

Method HANDLE_EOT on class CL_CLB_BAL has no parameter.
Method HANDLE_EOT on class CL_CLB_BAL has no exception.

Method ON_EOT Signature

Method ON_EOT on class CL_CLB_BAL has no parameter.
Method ON_EOT on class CL_CLB_BAL has no exception.

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_INSTANCE	Call by reference	☐	Type reference (TYPE)	TY_LOG_INSTANCE			20120831

Method OPEN on class CL_CLB_BAL has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BALLOGHNDL	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20120903

Method SAVE on class CL_CLB_BAL has no exception.

Method S_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAL_HEADER	Call by reference	☑	Type reference (TYPE)	BAL_S_LOG		Application Log: Log header data	20120807
2	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	BALOBJ_D	BAL_OBJECT	Application Log: Log header data	20120807
3	Importing	IV_SUBOBJECT	Call by reference	☐	Type reference (TYPE)	BALSUBOBJ	BAL_SUBOBJECTS-GATEWAY_NOTIFICATION	Application Log: Subobject	20120807
4	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLB_LOG		Log class	20120808

Method S_CREATE on class CL_CLB_BAL has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740