SAP ABAP Class /BOFU/CL_BAL_BUFFER_READONLY (Application Log: BOPF Buffer: Read Only access)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-BRC (Application Component) Reusable Components of Business Suite Foundation
     ⤷ /BOFU/BAL_BO (Package) Application Log BO: Read Access to Messages

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/BOBF/IF_FRW_BUFFER	Interface to the Data Layer	20090806

Properties

Class	/BOFU/CL_BAL_BUFFER_READONLY
Short Description	Application Log: BOPF Buffer: Read Only access
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	/BOFU/BAL_BO	Application Log BO: Read Access to Messages
Created	20090806	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/BOFU/IF_ADDR_CONSTANTS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/BOBF/IF_FRW_BUFFER	☐	☐	Interface to the Data Layer	20090806

Friends

Class /BOFU/CL_BAL_BUFFER_READONLY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_HDR_DATA_LOADED	Instance attribute	Protected	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
2	MT_MESSAGE_MAP	Instance attribute	Protected	☐	Type reference (TYPE)	TT_MESSAGE_KEY_MAP		Message Handle to Key Map	20090806
3	MV_MSG_KEY_TEMP	Instance attribute	Protected	☐	Type reference (TYPE)	/BOBF/CONF_KEY		Temporary Message Key (incremental)	20090806
4	SO_INSTANCE	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	/BOFU/CL_BAL_BUFFER_READONLY		Special Buffer Class for DO Address	20090806
5	SO_UUID	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SYSTEM_UUID		Class for Processing 16 Byte System UUIDs	20090806

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BAL_DB_SEARCH	Instance method	Protected	Method	Equivalent to function module BAL_DB_SEARCH	20090806
2	BAL_DB_SEARCH_2	Instance method	Protected	Method	Own Selection into BALHDR!! To solve perfomance issues	20090806
3	BAL_LOG_EXIST	Instance method	Protected	Method	Function BAL_LOG_EXIST	20090806
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090806
5	CONVAKEY_HDR_LOGNUMBER	Instance method	Protected	Method	Convert Alternate Key: HEADER->LOGNUMBER	20090806
6	CONVAKEY_HDR_LOG_HANDLE	Instance method	Protected	Method	Convert Alternate Key: HEADER->LOG_HANDLE	20090806
7	GET_HANDLE	Instance method	Protected	Method	Get Handle given key	20090806
8	GET_KEY	Instance method	Protected	Method	Get Key given Handle	20090806
9	NOTIFY_HEADER_CHANGE	Instance method	Protected	Method	Notify Header Change	20090806
10	NOTIFY_MESSAGE_DELETE	Instance method	Protected	Method	Notify Message Deletion	20090806
11	NOTIFY_MESSAGE_LOAD	Instance method	Protected	Method	Notify Message Load	20090806
12	QUERY_HEADER_SEL_BY_ELEMENTS	Instance method	Protected	Method	QUERY: HEADER->SELECT_BY_ELEMENTS	20090806
13	RBA_HEADER_MESSAGE	Instance method	Protected	Method	RetrieveByAssociation HEADER->HEADER-MESSAGE	20090806
14	RETRAKEY_HDR_LOGNUMBER	Instance method	Protected	Method	Retrieve Alternate Key: HEADER->LOGNUMBER	20090806
15	RETRAKEY_HDR_LOG_HANDLE	Instance method	Protected	Method	Retrieve Alternate Key: HEADER->LOG_HANDLE	20090806
16	RETR_HEADER	Instance method	Protected	Method	Retrieve Header	20090806
17	RETR_MESSAGE	Instance method	Protected	Method	Retrieve Message	20090806

Events

Class /BOFU/CL_BAL_BUFFER_READONLY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_MESSAGE_KEY_MAP	Protected	See coding		Message Handle to Key Map	20090806	BEGIN OF ts_message_key_map, key TYPE /bobf/conf_key, s_message_handle TYPE balmsghndl, END OF ts_message_key_map
2	TT_BALHDR_SIMPLE	Protected	See coding			20090806	tt_balhdr_simple type STANDARD TABLE OF balhdr with default key
3	TT_BALHDR_SORT_BY_HANDLE	Protected	See coding			20090806	tt_balhdr_sort_by_handle type sorted table of balhdr with non-unique key log_handle
4	TT_MESSAGE_KEY_MAP	Protected	See coding		Message Handle to Key Map	20090806	tt_message_key_map TYPE HASHED TABLE OF ts_message_key_map WITH UNIQUE KEY primary_key COMPONENTS key WITH NON-UNIQUE SORTED KEY message_handle COMPONENTS s_message_handle-log_handle s_message_handle-MSGNUMBER

Method Signatures

Method BAL_DB_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOG_HEADER_SIMPLE	Call by reference	☐	Type reference (TYPE)	TT_BALHDR_SIMPLE			20090806
2	Exporting	ET_LOG_HEADER_SORTED	Call by reference	☐	Type reference (TYPE)	TT_BALHDR_SORT_BY_HANDLE		Application Log: Log header data table	20090806
3	Exporting	ET_LOG_HEADER_STD	Call by reference	☐	Type reference (TYPE)	BALHDR_T		Application Log: Log header data table	20090806
4	Importing	IS_LOG_FILTER	Call by reference	☐	Type reference (TYPE)	BAL_S_LFIL		Application Log: Log filter criteria	20090806
5	Importing	I_CLIENT	Call by reference	☐	Type reference (TYPE)	SY-MANDT	SY-MANDT	Client ID of Current User	20090806

#	Exception	Resumable	Description	Created on
1	LOG_NOT_FOUND	☐	No log found	20090806
2	NO_FILTER_CRITERIA	☐	Filter criteria missing	20090806

Method BAL_DB_SEARCH_2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_LOG_FILTER	Call by reference	☐	Type reference (TYPE)	BAL_S_LFIL		Application Log: Log filter criteria	20090806
2	Exporting	ET_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	/BOFU/T_BALLOGHNDL		Application Log: Log header data table	20090806
3	Importing	IT_SORT_ORDER	Call by reference	☐	Type reference (TYPE)	ABAP_SORTORDER_TAB		Table for SORT itab BY (ABAP_SORTORDER_TAB)	20090806
4	Importing	IV_MAX_ENTRIES	Call by reference	☐	Type reference (TYPE)	I	0		20090806
5	Importing	I_CLIENT	Call by reference	☐	Type reference (TYPE)	SY-MANDT	SY-MANDT	Client ID of Current User	20090806

#	Exception	Resumable	Description	Created on
1	LOG_NOT_FOUND	☐	No log found	20090806
2	NO_FILTER_CRITERIA	☐	Filter criteria missing	20090806

Method BAL_LOG_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CHANGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
2	Importing	IV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20090806

#	Exception	Resumable	Description	Created on
1	LOG_NOT_FOUND	☐	Log Not Found	20090806

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /BOFU/CL_BAL_BUFFER_READONLY has no parameter.
Method CLASS_CONSTRUCTOR on class /BOFU/CL_BAL_BUFFER_READONLY has no exception.

Method CONVAKEY_HDR_LOGNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEYINDEX		Key table with explicit index	20090806
2	Importing	IO_CHANGE	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
3	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20090806
4	Importing	IV_INVALIDATE_CACHE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE		20090806
5	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE		State	20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	BOPF Exception Class	20090806

Method CONVAKEY_HDR_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEYINDEX		Key table with explicit index	20090806
2	Importing	IO_CHANGE	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
3	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20090806
4	Importing	IV_INVALIDATE_CACHE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE		20090806
5	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE		State	20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	BOPF Exception Class	20090806

Method GET_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_KEY		NodeID	20090806
2	Returning	RV_HANDLE	Value transfer	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20090806

Method GET_HANDLE on class /BOFU/CL_BAL_BUFFER_READONLY has no exception.

Method GET_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20090806
2	Returning	RV_KEY	Value transfer	☐	Type reference (TYPE)	/BOBF/CONF_KEY		NodeID	20090806

Method GET_KEY on class /BOFU/CL_BAL_BUFFER_READONLY has no exception.

Method NOTIFY_HEADER_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CHANGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE			20090806
2	Importing	IV_CHANGE_MODE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_CHANGE_MODE		Change category	20090806
3	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_KEY			20090806

Method NOTIFY_HEADER_CHANGE on class /BOFU/CL_BAL_BUFFER_READONLY has no exception.

Method NOTIFY_MESSAGE_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CHANGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
2	Importing	IS_MESSAGE_MAP	Call by reference	☐	Type reference (TYPE)	TS_MESSAGE_KEY_MAP		Message Handle to Key Map	20090806

Method NOTIFY_MESSAGE_DELETE on class /BOFU/CL_BAL_BUFFER_READONLY has no exception.

Method NOTIFY_MESSAGE_LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CHANGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
2	Importing	IS_MESSAGE_HANDLE	Call by reference	☐	Type reference (TYPE)	BALMSGHNDL		Application Log: Message handle	20090806
3	Returning	RV_KEY	Value transfer	☐	Type reference (TYPE)	/BOBF/CONF_KEY		NodeID	20090806

Method NOTIFY_MESSAGE_LOAD on class /BOFU/CL_BAL_BUFFER_READONLY has no exception.

Method QUERY_HEADER_SEL_BY_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_QUERY_INFO	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_QUERY_INFO		Query Information	20090806
2	Exporting	ET_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY			20090806
3	Importing	IS_QUERY_OPTIONS	Call by reference	☑	Type reference (TYPE)	/BOBF/S_FRW_QUERY_OPTIONS			20090806
4	Importing	IT_FILTER_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/T_FRW_KEY			20090806
5	Importing	IT_SELECTION_PARAMETERS	Call by reference	☑	Type reference (TYPE)	/BOBF/T_FRW_QUERY_SELPARAM			20090806
6	Importing	IV_BAL_DB_SEARCH_VER	Value transfer	☐	Type reference (TYPE)	I	2		20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	Exception class	20090806

Method RBA_HEADER_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
2	Exporting	ET_KEY_LINK	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK			20090806
3	Exporting	ET_TARGET_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
4	Importing	IO_CHANGE	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface for Change Class	20090806
5	Importing	IS_PARAMETERS	Call by reference	☑	Object reference (TYPE REF TO)	DATA			20090806
6	Importing	IT_FILTERED_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	/BOBF/T_FRW_NAME		List of Names (e.g. Fieldnames)	20090806
7	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
8	Importing	IV_BUFFER_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Search only in buffer and do not load data	20090806
9	Importing	IV_FILL_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20090806
10	Importing	IV_NOTIFY_KEYLOAD	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Notify loaded keys only (when loading data)	20090806
11	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE		Status	20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	Exception class	20090806

Method RETRAKEY_HDR_LOGNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY			20090806
2	Exporting	ET_KEY	Call by reference	☐	Type reference (TYPE)	/BOFU/T_BALOGNR		Application Log: Log Handle Table	20090806
3	Importing	IO_CHANGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
4	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY			20090806
5	Importing	IV_BUFFER_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090806
6	Importing	IV_INVALIDATE_CACHE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE		20090806
7	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE			20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐		20090806

Method RETRAKEY_HDR_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY			20090806
2	Exporting	ET_KEY	Call by reference	☐	Type reference (TYPE)	/BOFU/T_BALLOGHNDL		Application Log: Log Handle Table	20090806
3	Importing	IO_CHANGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Interface of Change Object	20090806
4	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY			20090806
5	Importing	IV_BUFFER_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090806
6	Importing	IV_INVALIDATE_CACHE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE		20090806
7	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE			20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐		20090806

Method RETR_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20090806
2	Exporting	ET_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
3	Exporting	ET_NODE_CAT	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_NODE_CAT		Node Category Assignment	20090806
4	Importing	IO_CHANGE	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Only bound if IV_BUFFER_ONLY = false	20090806
5	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
6	Importing	IV_BUFFER_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Search only in buffer and do not load data	20090806
7	Importing	IV_FILL_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Fill data	20090806
8	Importing	IV_NOTIFY_KEYLOAD	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Notify loaded keys only (when loading data)	20090806
9	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE		Status	20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	Exception class	20090806

Method RETR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Application Log Message	20090806
2	Exporting	ET_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
3	Exporting	ET_NODE_CAT	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_NODE_CAT		Node Category Assignment	20090806
4	Importing	IO_CHANGE	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_CHANGE		Only bound if IV_BUFFER_ONLY = false	20090806
5	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20090806
6	Importing	IV_BUFFER_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Search only in buffer and do not load data	20090806
7	Importing	IV_FILL_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Fill data	20090806
8	Importing	IV_FILL_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090806
9	Importing	IV_NOTIFY_KEYLOAD	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Notify loaded keys only (when loading data)	20090806
10	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_STATE		Status	20090806

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐	Exception class	20090806

History

Last changed by/on	SAP	20110908
SAP Release Created in	702