SAP ABAP Class /IPRO/SHARED_ELEMENTS (shared memory for Document Builder Elements)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/PROGS (Package) programs

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SHM_AREA	Shared Memory: General Area Handle	20101021

Properties

Class	/IPRO/SHARED_ELEMENTS
Short Description	shared memory for Document Builder Elements
Super Class	CL_SHM_AREA	Shared Memory: General Area Handle
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	S	System Program
Category	45	Area Class (Shared Objects)
Package	/IPRO/PROGS	programs
Created	20101021	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /IPRO/SHARED_ELEMENTS has no forward declaration.

Interfaces

Class /IPRO/SHARED_ELEMENTS has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SHM_AREA	☐	20101028	Shared Memory: General Area Handle

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AREA_NAME	Constant	Public	☐	Type reference (TYPE)	SHM_AREA_NAME	'/IPRO/SHARED_ELEMENTS'	Name of an Area Class	20101021
2	ROOT	Instance attribute	Public	☑	Object reference (TYPE REF TO)	/IPRO/CL_SHARED_ELEMENTS		SHM: Model of a Data Class	20101021
3	_CLIENT_DEPENDENT	Constant	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101021
4	_LIFE_CONTEXT	Constant	Private	☐	Type reference (TYPE)	SHM_LIFE_CONTEXT	CL_SHM_AREA=>LIFE_CONTEXT_APPSERVER	Lifetime of an Area (Constants in CL_SHM_AREA)	20101021
5	_TRACE_ACTIVE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	(Internal) Flag: Trace Active?	20101021
6	_TRACE_SERVICE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_SHM_TRACE		(Internal) Reference to Trace Class	20101021
7	_TRANSACTIONAL	Constant	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101021
8	_VERSION_	Constant	Private	☐	Type reference (TYPE)	I	19	(internal)	20101021

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_FOR_READ	Static method	Public	Method	Request a Read Lock	20101021
2	ATTACH_FOR_UPDATE	Static method	Public	Method	Request a Change Lock	20101021
3	ATTACH_FOR_WRITE	Static method	Public	Method	Request a Write Lock	20101021
4	BUILD	Static method	Public	Method	Direct Call of Area Constructor	20101021
5	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20101021
6	DETACH_AREA	Static method	Public	Method	Release all locks on all instances	20101021
7	FREE_AREA	Static method	Public	Method	Delete all instances	20101021
8	FREE_INSTANCE	Static method	Public	Method	Deletion of an Instance	20101021
9	GET_GENERATOR_VERSION	Static method	Public	Method	Query Generator Version	20101021
10	GET_INSTANCE_INFOS	Static method	Public	Method	Returns the names of all instances	20101021
11	INVALIDATE_AREA	Static method	Public	Method	Active versions of all instances will be set to obsolete	20101021
12	INVALIDATE_INSTANCE	Static method	Public	Method	Active version of one instance will be set to obsolete	20101021
13	SET_ROOT	Instance method	Public	Method	Sets Root Objects	20101021

Events

Class /IPRO/SHARED_ELEMENTS has no event.

Types

Class /IPRO/SHARED_ELEMENTS has no local type.

Method Signatures

Method ATTACH_FOR_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/SHARED_ELEMENTS		SHM: Model of an Area Class	20101021
2	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	A Change Lock Is Already Active	20101021
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instance Already Locked	20101021
3	CX_SHM_INCONSISTENT	☐	Different Definitions Between Program and Area	20101021
4	CX_SHM_NO_ACTIVE_VERSION	☐	No active version exists for an attach	20101021
5	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20101021
6	CX_SHM_READ_LOCK_ACTIVE	☐	Request for a Second Read Lock	20101021

Method ATTACH_FOR_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTACH_MODE	Call by reference	☐	Type reference (TYPE)	SHM_ATTACH_MODE	CL_SHM_AREA=>ATTACH_MODE_DEFAULT	Mode of ATTACH (Constants in CL_SHM_AREA)	20101021
2	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/SHARED_ELEMENTS		SHM: Model of an Area Class	20101021
3	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20101021
4	Importing	WAIT_TIME	Call by reference	☐	Type reference (TYPE)	I	0	Maximum Wait Time (in Milliseconds)	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	A write lock is already active	20101021
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instance Already Locked	20101021
3	CX_SHM_INCONSISTENT	☐	Different Definitions Between Program and Area	20101021
4	CX_SHM_NO_ACTIVE_VERSION	☐	No active version exists for an attach	20101021
5	CX_SHM_PARAMETER_ERROR	☐	Passed Parameter Has Incorrect Value	20101021
6	CX_SHM_PENDING_LOCK_REMOVED	☐	Shared Objects: Waiting Lock Was Deleted	20101021
7	CX_SHM_VERSION_LIMIT_EXCEEDED	☐	No Additional Versions Available	20101021

Method ATTACH_FOR_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTACH_MODE	Call by reference	☐	Type reference (TYPE)	SHM_ATTACH_MODE	CL_SHM_AREA=>ATTACH_MODE_DEFAULT	Mode of ATTACH (Constants in CL_SHM_AREA)	20101021
2	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/SHARED_ELEMENTS		SHM: Model of an Area Class	20101021
3	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20101021
4	Importing	WAIT_TIME	Call by reference	☐	Type reference (TYPE)	I	0	Maximum Wait Time (in Milliseconds)	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	A write lock is already active	20101021
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instance Already Locked	20101021
3	CX_SHM_PARAMETER_ERROR	☐	Passed Parameter Has Incorrect Value	20101021
4	CX_SHM_PENDING_LOCK_REMOVED	☐	Shared Objects: Waiting Lock Was Deleted	20101021
5	CX_SHM_VERSION_LIMIT_EXCEEDED	☐	No Additional Versions Available	20101021

Method BUILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INST_NAME	Call by reference	☐	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHMA_INCONSISTENT	☐	SHM Administration: Inconsistent Attribute Combination	20101021
2	CX_SHMA_NOT_CONFIGURED	☐	SHM Administration: Area Property Is Not Configured	20101021
3	CX_SHM_BUILD_FAILED	☐	Constructor Run Failed	20101021

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /IPRO/SHARED_ELEMENTS has no parameter.
Method CLASS_CONSTRUCTOR on class /IPRO/SHARED_ELEMENTS has no exception.

Method DETACH_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Detach Return Value (Constants in CL_SHM_AREA)	20101021

Method DETACH_AREA on class /IPRO/SHARED_ELEMENTS has no exception.

Method FREE_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Return Value (Constants in CL_SHM_AREA)	20101021
2	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Writing processes will be ended	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20101021

Method FREE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20101021
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Return Value (Constants in CL_SHM_AREA)	20101021
3	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Writing processes will be ended	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20101021

Method GET_GENERATOR_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	GENERATOR_VERSION	Value transfer	☐	Type reference (TYPE)	I			20101021

Method GET_GENERATOR_VERSION on class /IPRO/SHARED_ELEMENTS has no exception.

Method GET_INSTANCE_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INFOS	Value transfer	☐	Type reference (TYPE)	SHM_INST_INFOS		Overview of all Instances of an SHM Area	20101021

Method GET_INSTANCE_INFOS on class /IPRO/SHARED_ELEMENTS has no exception.

Method INVALIDATE_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Detach Return Value (Constants in CL_SHM_AREA)	20101021
2	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Active writing processes will be ended	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20101021

Method INVALIDATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20101021
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Detach Return Value (Constants in CL_SHM_AREA)	20101021
3	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Active writing processes will be ended	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20101021

Method SET_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ROOT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/CL_SHARED_ELEMENTS		Root object	20101021

#	Exception	Resumable	Description	Created on
1	CX_SHM_INITIAL_REFERENCE	☐	Initial Reference Passed	20101021
2	CX_SHM_WRONG_HANDLE	☐	Incorrect Handle	20101021

History

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