SAP ABAP Class CL_BS_CONTEXT_STORE_SHM (Context Store SHM)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-MDG-APP-BP (Application Component) MDG Business Partner (Central Part)
     ⤷ BS_COMMON_OBJECTS (Package) Common Tools and Interfaces

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BS_CONTEXT_STORE	Context Store	20110129

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BS_CONTEXT_STORE_GLOBAL	Context Store For Global Context	20110223

Properties

Class	CL_BS_CONTEXT_STORE_SHM
Short Description	Context Store SHM
Super Class	CL_BS_CONTEXT_STORE	Context Store
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	BS_COMMON_OBJECTS	Common Tools and Interfaces
Created	20110129	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BS_CONTEXT_STORE_SHM has no forward declaration.

Interfaces

Class CL_BS_CONTEXT_STORE_SHM has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BS_CONTEXT_STORE_FACTORY	☐	20110131	Factory For Context Stores
2	IF_PRTCL_CONTEXT_SHM	☐	20110131	Delegation Protocol For SHM Contexts

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_REPORTING	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BS_INOB_REPORTING		Reporting For Incident Observation	20120716
2	MT_DELEGATES	Instance attribute	Protected	☐	Type reference (TYPE)	TY_DELEGATES		List of context delegates	20110131
3	MV_DELEGATE_CLASS_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	SEOCLNAME	'CL_BS_CONTEXT_SHM_DELEGATE'	Class Name	20110227

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_CONTEXT_VALUE	Instance method	Protected	Method	clears the value for a context id	20110131
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20121210
3	CREATE_DELEGATE	Instance method	Protected	Method	creates a delegate	20110131
4	CREATE_INSTANCE	Instance method	Protected	Method	creates the SHM instance	20110222
5	CREATE_ROOT	Instance method	Protected	Method	creates the SHM root class instance for a given area handle	20110222
6	FREE_USERS_INSTANCES	Instance method	Public	Method	frees all instances related to the current user	20110222
7	GET_CONTEXT_VALUE	Instance method	Protected	Method	gets the value for a context id	20110131
8	GET_DELEGATE	Instance method	Protected	Method	gets a delegate by name	20110131
9	INSTANCE_NAME_BY_CONTEXT_NAME	Instance method	Protected	Method	builds an instance name by a given context name	20110222
10	SET_CONTEXT_VALUE	Instance method	Protected	Method	sets the value for a context id	20110131

Events

Class CL_BS_CONTEXT_STORE_SHM has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_DELEGATE	Protected	See coding			20110131	BEGIN OF ty_delegate, name TYPE string, context_class_name TYPE seoclname, instance TYPE REF TO if_prtcl_context_shm, END OF ty_delegate
2	TY_DELEGATES	Protected	See coding			20110131	ty_delegates TYPE TABLE OF ty_delegate WITH KEY name

Method Signatures

Method CLEAR_CONTEXT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110131
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20110131

Method CLEAR_CONTEXT_VALUE on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method CONSTRUCTOR Signature

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

Method CREATE_DELEGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLNAME	'CL_BS_CONTEXT'	Class Name	20110222
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		name of the delegate	20110131
3	Returning	RO_DELEGATE	Value transfer	☐	Object reference (TYPE REF TO)	IF_PRTCL_CONTEXT_SHM		Delegation Protocol For SHM Contexts	20110131

Method CREATE_DELEGATE on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLNAME	'CL_BS_CONTEXT'	Class Name	20110222
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110222

Method CREATE_INSTANCE on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method CREATE_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_BS_CONTEXT_STORE_SHM_AREA		Shared Memory: General Area Handle	20110222
2	Importing	IV_CONTEXT_CLASS_NAME	Call by reference	☑	Type reference (TYPE)	SEOCLNAME		Class Name	20110222
3	Importing	IV_CONTEXT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110222
4	Returning	RO_ROOT	Value transfer	☐	Object reference (TYPE REF TO)	CL_BS_CONTEXT		Context	20110222

Method CREATE_ROOT on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method FREE_USERS_INSTANCES Signature

Method FREE_USERS_INSTANCES on class CL_BS_CONTEXT_STORE_SHM has no parameter.
Method FREE_USERS_INSTANCES on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method GET_CONTEXT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20110131
2	Importing	IV_CONTEXT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110131
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20110131

Method GET_CONTEXT_VALUE on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method GET_DELEGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		name of the delegate	20110131
2	Returning	RO_DELEGATE	Value transfer	☐	Object reference (TYPE REF TO)	IF_PRTCL_CONTEXT_SHM		Delegation Protocol For SHM Contexts	20110131

Method GET_DELEGATE on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method INSTANCE_NAME_BY_CONTEXT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110222
2	Returning	RV_INSTANCE_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20110222

Method INSTANCE_NAME_BY_CONTEXT_NAME on class CL_BS_CONTEXT_STORE_SHM has no exception.

Method SET_CONTEXT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110131
2	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20110131
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20110131

Method SET_CONTEXT_VALUE on class CL_BS_CONTEXT_STORE_SHM has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	703