SAP ABAP Class /UI2/CL_CFG_COMP_SHBROKER (UI2 Transactional Shared Object)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/WD_CONFIGURATION (Package) UI2: WD Configuration

Properties

Class	/UI2/CL_CFG_COMP_SHBROKER
Short Description	UI2 Transactional Shared Object
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/UI2/WD_CONFIGURATION	UI2: WD Configuration
Created	20131028	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/UI2/CL_WDR_CFG_CONTEXT_MODEL	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class /UI2/CL_CFG_COMP_SHBROKER has no interface implemented.

Friends

Class /UI2/CL_CFG_COMP_SHBROKER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_CFG_COMP_SHM	Constant	Public	☐	Type reference (TYPE)	SHM_AREA_NAME	'CL_WDR_CFG_COMP_SHM'	Name of Area Class	20131028
2	C_SCOPE_COMPONENT	Constant	Public	☐	Type reference (TYPE)	I	1	All Configurations of a Component	20131028
3	C_SCOPE_CONFIG	Constant	Public	☐	Type reference (TYPE)	I	2	One Configuration	20131028
4	C_SCOPE_GLOBAL	Constant	Public	☐	Type reference (TYPE)	I	0	Invalidates all configurations	20131028
5	M_INSTANCE_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SHM_INST_NAME		Name of a Shared Object Instance in an Area	20131028
6	M_INST_MAP	Static Attribute	Private	☐	Type reference (TYPE)	INST_MAP			20131028

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_SHARED_OBJECT	Static method	Public	Method	build shared object out of configuration	20131120
2	DETACH	Static method	Public	Method	Releases an instance (read lock removed)	20131028
3	GET_CFG_KEY_FROM_INSTANCE_NAME	Static method	Public	Method	Calculates the config ID from instance(s)	20131107
4	GET_INSTANCE_NAME	Static method	Public	Method	Calculates the instance(s) from the config ID	20131028
5	INVALIDATE	Static method	Public	Method	Invalidates SHO instances	20131028
6	READ_CFG_OBJECT	Static method	Public	Method	Reads data from the SHO	20131028

Events

Class /UI2/CL_CFG_COMP_SHBROKER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	INST_MAP	Private	See coding			20131028	inst_map TYPE STANDARD TABLE OF inst_map_line
2	INST_MAP_LINE	Private	See coding			20131028	BEGIN OF inst_map_line , inst_name TYPE shm_inst_name, inst_ref TYPE REF TO /UI2/cl_cfg_comp_shm_trans , END OF inst_map_line

Method Signatures

Method BUILD_SHARED_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/CL_WDR_CFG_CONTEXT_MODEL=>CONTEXT			20131120
2	Importing	IS_CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20131120
3	Importing	IT_SCOPE_TO_KEYS	Call by reference	☐	Type reference (TYPE)	/UI2/WDY_CHANGE_SCOPE_TO_KEYS		Configuration Data	20131125
4	Importing	IV_COMPONENT_NAME	Call by reference	☐	Type reference (TYPE)	WDY_COMPONENT_NAME			20131120
5	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Language Key	20131125
6	Importing	IV_MAX_NODE_ID	Call by reference	☐	Type reference (TYPE)	/UI2/CL_WDR_CFG_CONTEXT_MODEL=>NODE_ID			20131125

Method BUILD_SHARED_OBJECT on class /UI2/CL_CFG_COMP_SHBROKER has no exception.

Method DETACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Component Configuration Shared Data	20131028

Method DETACH on class /UI2/CL_CFG_COMP_SHBROKER has no exception.

Method GET_CFG_KEY_FROM_INSTANCE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INSTANCE_NAME	Value transfer	☐	Type reference (TYPE)	SHM_INST_NAME		Name of a Shared Object Instance of an Area	20131107
2	Returning	R_CONFIG_KEY	Value transfer	☐	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20131107

Method GET_CFG_KEY_FROM_INSTANCE_NAME on class /UI2/CL_CFG_COMP_SHBROKER has no exception.

Method GET_INSTANCE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20131028
2	Importing	I_LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Language	20131125
3	Returning	R_INSTANCE_NAME	Value transfer	☐	Type reference (TYPE)	SHM_INST_NAME		Name of a Shared Object Instance of an Area	20131028

Method GET_INSTANCE_NAME on class /UI2/CL_CFG_COMP_SHBROKER has no exception.

Method INVALIDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☑	Type reference (TYPE)	SY-MANDT	'*'	Client ID of Current User	20131028
2	Importing	CONFIG_KEY	Call by reference	☑	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20131028
3	Importing	SCOPE	Call by reference	☑	Type reference (TYPE)	I			20131028

Method INVALIDATE on class /UI2/CL_CFG_COMP_SHBROKER has no exception.

Method READ_CFG_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DATA_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CFG_COMP_SHDATA		Component Configuration Shared Data	20131028
2	Importing	I_CONFIG_KEY	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20131028
3	Importing	LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20131028

Method READ_CFG_OBJECT on class /UI2/CL_CFG_COMP_SHBROKER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100