SAP ABAP Class CL_UC_OC_BUFFER (Storage and Administration of Shared Buffer)

Hierarchy

☛ SEM-BW (Software Component) SEM-BW: Strategic Enterprise Management
   ⤷ FIN-SEM-BCS (Application Component) Business Consolidation
     ⤷ UCF6 (Package) SEM-BCS: Consolidation of Investments

Properties

Class	CL_UC_OC_BUFFER
Short Description	Storage and Administration of Shared Buffer
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	UCF6	SEM-BCS: Consolidation of Investments
Created	20030801	SAP
Last change	20060208	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	T	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	UC00	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_UC_OC_BUFFER has no interface implemented.

Friends

Class CL_UC_OC_BUFFER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DF_NO_LOCK	Instance attribute	Private	☐	Type reference (TYPE)	UC_FLG		General Indicator, SAP Consolidation	20050811
2	DO_MODEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UC_MODEL		Model	20030804
3	DR_T_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Local Buffered Data of Instance	20030902
4	DS_REF	Instance attribute	Private	☐	Type reference (TYPE)	S_DIR		Key for Current Selection	20030815
5	DT_MSG	Instance attribute	Private	☐	Type reference (TYPE)	UC0_T_MESSAGE		Messages	20040205
6	D_ID	Instance attribute	Private	☐	Type reference (TYPE)	INDX_RELID		Area of Buffer Instance	20030801
7	GC_DIR	Constant	Private	☐	Type reference (TYPE)	GUID_22	'DIRECTORY'	Key of Directory	20030804
8	GC_ID_OC_SEND_RECV	Constant	Public	☐	Type reference (TYPE)	INDX_RELID	'SR'	Area in IMPORT/EXPORT Data Table	20030801
9	GC_INVALID	Constant	Public	☐	Type reference (TYPE)	I	'2'	Buffer Is Invalid	20030801
10	GC_LOCKED	Constant	Private	☐	Type reference (TYPE)	I	'3'	Buffer Is Locked	20030801
11	GC_LOCK_ALL	Constant	Private	☐	Type reference (TYPE)	GUID_22	'LOCK_ALL'	Lock the Entire Buffer	20030804
12	GC_TABNAME	Constant	Private	☐	Type reference (TYPE)	TABNAME	'UCM_S_OC_BUFFER'	Name of Buffer	20030801
13	GC_VALID	Constant	Public	☐	Type reference (TYPE)	I	'1'	Buffer Is Valid	20030801
14	GF_BUFFER_OFF	Static Attribute	Private	☐	Type reference (TYPE)	UC_FLG		Do not use a buffer	20031028
15	GF_USE_GLOBAL_DIR	Static Attribute	Private	☐	Type reference (TYPE)	UC_FLG		No global dir. needed	20031006
16	GT_GLOBAL_LOCK	Static Attribute	Private	☐	Type reference (TYPE)	T_LOCK_KEY		Global lock table to minimize lock server accesses	20030902
17	GT_INSTANCE	Static Attribute	Private	☐	Type reference (TYPE)	T_INSTANCE		Table of Active Instances	20030902
18	GT_LOCK	Static Attribute	Private	☐	Type reference (TYPE)	T_LOCK_KEY		Local lock table of roll area	20030804

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_BUFFER	Instance method	Private	Method	Check if data is buffered and current	20030801
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20031006
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030801
4	ENQUEUE	Instance method	Private	Method	Lock a Buffer Entry	20030801
5	GET_BUFFER	Instance method	Private	Method	Read Buffered Data	20030801
6	GET_BUFFERED_DIRECTORY	Static method	Public	Method	Parameters of All Entries Currenctly Stored	20050809
7	GET_DATA	Instance method	Public	Method	Read Data from Buffer	20030801
8	GET_DIRECTORY	Instance method	Private	Method	Read Directory of Buffer	20030801
9	GET_GLOBAL_AFD_STAMP	Instance method	Public	Method		20050802
10	GET_INSTANCE	Static method	Public	Method	Generate a New Instance	20030801
11	GET_INSTANCE_P	Static method	Private	Method	Generate a New Instance	20030902
12	INVALIDATE	Instance method	Public	Method	(Partial) Deletion of Buffer	20030801
13	IS_BUFFERED	Instance method	Public	Method	Check if data exists for current instance	20030801
14	IS_LOCKED	Instance method	Private	Method	Check if data is locked	20030801
15	PARAM2GUID	Instance method	Private	Method	Gets GUID for Current Characteristic Combination	20030801
16	PARAM2INT	Static method	Private	Method	Extract Relevant Characteristics from Any Combination	20030804
17	SET_BUFFER	Instance method	Private	Method	Buffer Data	20030801
18	SET_DATA	Instance method	Public	Method	Try to write data to buffer	20030801
19	SET_DIRECTORY	Instance method	Private	Method	Buffering of Directory	20030804
20	UPDATE_TIMESTAMP	Instance method	Private	Method	Update Time Stamp of Buffered Data	20030814

Events

Class CL_UC_OC_BUFFER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_DIR	Public	See coding			20050809	begin of s_dir , guid type guid_22 "The ID , area type uc_value , fiscyear type uc_value , fiscperiod type uc_value , t_param type uc0_ts_value , timestamp type timestamp "customizing-date of last "calculation. , check_string type string "state of the customizing of "the last calculation (if no "timestamp does exist. , afd_stamp type guid_22 "Another GUID to check if the "AFD of the calculated data is "still valid. , lines type i , end of s_dir
2	T_DIR	Public	See coding			20050809	t_dir type standard table of s_dir with default key

Method Signatures

Method CHECK_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_STATE	Value transfer	☐	Type reference (TYPE)	I		Status des Puffers	20030801

Method CHECK_BUFFER on class CL_UC_OC_BUFFER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_UC_OC_BUFFER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_UC_OC_BUFFER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_INCOMPLETE_KEY	Call by reference	☐	Type reference (TYPE)	UC_FLG		virtuelle Instanz, da der Schüssel nur teilspezifiziert ist	20030902
2	Importing	IF_NO_LOCK	Call by reference	☐	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20050811
3	Importing	IO_MODEL	Call by reference	☑	Object reference (TYPE REF TO)	IF_UC_MODEL		Modell (Metadaten)	20030804
4	Importing	IT_PARAM	Call by reference	☑	Type reference (TYPE)	UC0_TS_VALUE		Selektion der Instanz	20030815
5	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Kons-Gebiet	20030902
6	Importing	I_FISCPERIOD	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Periode	20030902
7	Importing	I_FISCYEAR	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Jahr	20030902
8	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	INDX_RELID		Gebiet der Instanz	20030801

Method CONSTRUCTOR on class CL_UC_OC_BUFFER has no exception.

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_LOCAL	Call by reference	☐	Type reference (TYPE)	UC_FLG	'X'	nur lokal für User sperren	20030902
2	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	GUID_22		Zu sperrender Eintrag	20030804

Method ENQUEUE on class CL_UC_OC_BUFFER has no exception.

Method GET_BUFFER 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)	ANY TABLE		aktuelle Daten	20030801
2	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	UC0_T_MESSAGE		Meldungen	20040205
3	Exporting	E_STATE	Call by reference	☐	Type reference (TYPE)	UC_FLG		Gültigkeit der Daten	20030814
4	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	GUID_22		Schlüssel der zu lesenden Daten	20030801

Method GET_BUFFER on class CL_UC_OC_BUFFER has no exception.

Method GET_BUFFERED_DIRECTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_DIR	Value transfer	☐	Type reference (TYPE)	T_DIR		Feldwerte	20050809
2	Importing	IF_ALL	Call by reference	☑	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20050811
3	Importing	I_ID	Call by reference	☑	Type reference (TYPE)	INDX_RELID	'SR'	Gebiet in IMPORT/EXPORT-Datentabelle	20050809

Method GET_BUFFERED_DIRECTORY on class CL_UC_OC_BUFFER has no exception.

Method GET_DATA 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)	ANY TABLE		gepufferte Daten	20030801
2	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	UC0_T_MESSAGE		Meldungen	20040205
3	Exporting	E_STATE	Call by reference	☐	Type reference (TYPE)	UC_FLG		Zustand des Puffers	20030814

Method GET_DATA on class CL_UC_OC_BUFFER has no exception.

Method GET_DIRECTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_DIR	Value transfer	☐	Type reference (TYPE)	T_DIR		aktuelles Verzeichnis	20030804
2	Importing	IF_LOCAL	Call by reference	☑	Type reference (TYPE)	UC_FLG		Verzeichnis der aktiven Instanzen erzeugen	20030902

Method GET_DIRECTORY on class CL_UC_OC_BUFFER has no exception.

Method GET_GLOBAL_AFD_STAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_AFD_STAMP	Value transfer	☐	Type reference (TYPE)	GUID_22		GUID im 'CHAR' Format mit Groß-/Kleinschreibung (!)	20050802
2	Importing	IF_CREATE	Call by reference	☑	Type reference (TYPE)	UC_FLG		"nos170805	20050826

Method GET_GLOBAL_AFD_STAMP on class CL_UC_OC_BUFFER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UC_OC_BUFFER		der Puffer	20030801
2	Importing	IF_NO_LOCK	Call by reference	☑	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20050811
3	Importing	IO_MODEL	Call by reference	☑	Object reference (TYPE REF TO)	IF_UC_MODEL		Modell (Metadaten)	20030804
4	Importing	IT_PARAM	Call by reference	☑	Type reference (TYPE)	UC0_TS_VALUE		Selektion der Instanz	20030815
5	Importing	I_ID	Call by reference	☑	Type reference (TYPE)	INDX_RELID	'SR'	Gebiet des Puffers	20030801

Method GET_INSTANCE on class CL_UC_OC_BUFFER has no exception.

Method GET_INSTANCE_P Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UC_OC_BUFFER		Der Schlüssel ist nicht vollständig	20030902
2	Importing	IF_INCOMPLETE_KEY	Call by reference	☑	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20030902
3	Importing	IF_NO_LOCK	Call by reference	☑	Type reference (TYPE)	UC_FLG		Allgemeines Kennzeichen SAP Konsolidierung	20050811
4	Importing	IO_MODEL	Call by reference	☑	Object reference (TYPE REF TO)	IF_UC_MODEL		Modell (Metadaten)	20030902
5	Importing	IS_REF	Call by reference	☑	Type reference (TYPE)	S_DIR		Selektion der Instanz	20030902
6	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	INDX_RELID	'SR'	Gebiet des Puffers	20030902

Method GET_INSTANCE_P on class CL_UC_OC_BUFFER has no exception.

Method INVALIDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_FINAL	Call by reference	☑	Type reference (TYPE)	UC_FLG		alles, auch das Directory löschen	20030925
2	Importing	IF_LOCAL	Call by reference	☑	Type reference (TYPE)	UC_FLG		nur lokal löschen (nicht im shared-Buffer)	20030902
3	Importing	IF_ONLY_ONE_ENTRY	Call by reference	☑	Type reference (TYPE)	UC_FLG		keine weiteren Instanzen invalidieren	20030827

Method INVALIDATE on class CL_UC_OC_BUFFER has no exception.

Method IS_BUFFERED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_AFD_STAMP	Call by reference	☐	Type reference (TYPE)	GUID_22		GUID im 'CHAR' Format mit Groß-/Kleinschreibung (!)	20050802
2	Exporting	E_CHECK_STRING	Call by reference	☐	Type reference (TYPE)	STRING		aktuelle "Prüfsumme"	20030827
3	Exporting	E_STATE	Value transfer	☐	Type reference (TYPE)	UC_FLG		Zustand der gepufferten Daten (gültig/ungültig)	20030804
4	Exporting	E_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		Zeitstempel der gepufferten Daten	20030818

Method IS_BUFFERED on class CL_UC_OC_BUFFER has no exception.

Method IS_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_STATE	Value transfer	☐	Type reference (TYPE)	I		Sperrstatus	20030801
2	Importing	IF_GLOBAL	Call by reference	☑	Type reference (TYPE)	UC_FLG		nur globale Sperren untersuchen	20030902
3	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	GUID_22		Schlüssel der Sperre	20030801

Method IS_LOCKED on class CL_UC_OC_BUFFER has no exception.

Method PARAM2GUID Signature

Method PARAM2GUID on class CL_UC_OC_BUFFER has no parameter.
Method PARAM2GUID on class CL_UC_OC_BUFFER has no exception.

Method PARAM2INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_INCOMPLETE_KEY	Call by reference	☐	Type reference (TYPE)	UC_FLG		Der Schlüssel ist nicht vollständig	20030820
2	Exporting	ET_PARAM	Call by reference	☐	Type reference (TYPE)	UC0_TS_VALUE		reduzierte Selektion	20030804
3	Exporting	E_AREA	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Gebiet	20030814
4	Exporting	E_FISCPERIOD	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Periode	20030804
5	Exporting	E_FISCYEAR	Call by reference	☐	Type reference (TYPE)	UC_VALUE		Jahr	20030804
6	Importing	IO_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	IF_UC_MODEL		Modell (Metadaten)	20030902
7	Importing	IT_PARAM	Call by reference	☐	Type reference (TYPE)	UC0_TS_VALUE		beliebige Selektion	20030804

Method PARAM2INT on class CL_UC_OC_BUFFER has no exception.

Method SET_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_STATE	Call by reference	☐	Type reference (TYPE)	UC_FLG		Zustand des Puffers	20030822
2	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		zu puffernde Daten	20030804
3	Importing	IT_MSG	Call by reference	☑	Type reference (TYPE)	UC0_T_MESSAGE		Meldungen	20040205
4	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	GUID_22		Schlüssel der zu puffernden Daten	20030804

Method SET_BUFFER on class CL_UC_OC_BUFFER has no exception.

Method SET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		zu puffernde Daten	20030804
2	Importing	IT_MSG	Call by reference	☑	Type reference (TYPE)	UC0_T_MESSAGE		Meldungen	20040205
3	Importing	I_AFD_STAMP	Call by reference	☐	Type reference (TYPE)	GUID_22		GUID im 'CHAR' Format mit Groß-/Kleinschreibung (!)	20050808
4	Importing	I_CHECK_STRING	Call by reference	☐	Type reference (TYPE)	STRING		neue "Prüfsumme'	20030827
5	Importing	I_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		neuer Zeitstempel	20030818

Method SET_DATA on class CL_UC_OC_BUFFER has no exception.

Method SET_DIRECTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DIR	Call by reference	☐	Type reference (TYPE)	T_DIR		vollständiges neues Verzeichnis	20030804

Method SET_DIRECTORY on class CL_UC_OC_BUFFER has no exception.

Method UPDATE_TIMESTAMP Signature

Method UPDATE_TIMESTAMP on class CL_UC_OC_BUFFER has no parameter.
Method UPDATE_TIMESTAMP on class CL_UC_OC_BUFFER has no exception.

History

Last changed by/on	SAP	20060208
SAP Release Created in	350