SAP ABAP Class /UI2/CL_PAGE_CACHE_AREA (Area for Pages of UI2 Pagebuilding Service)
Hierarchy
SAP_UI (Software Component) User Interface Technology
   CA-UI2-INT-BE (Application Component) Backend Enablement
     /UI2/SERVICES_PB_V06_700 (Package) UI BE: PB Service implementation 703 v.06
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 20140604
Properties
Class /UI2/CL_PAGE_CACHE_AREA  
Short Description Area for Pages of UI2 Pagebuilding Service    
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 /UI2/SERVICES_PB_V06_700   UI BE: PB Service implementation 703 v.06 
Created 20140604   SAP 
Last change 20141121    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class /UI2/CL_PAGE_CACHE_AREA has no forward declaration.
Interfaces
Class /UI2/CL_PAGE_CACHE_AREA has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_SHM_AREA 20140605 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 '/UI2/CL_PAGE_CACHE_AREA' Name of an Area Class 20140604
2 ROOT Instance attribute Public Object reference (TYPE REF TO) /UI2/CL_PAGE_CACHE_ROOT SHM: Model of a Data Class 20140604
3 _CLIENT_DEPENDENT Constant Private Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20140604
4 _TRACE_ACTIVE Static Attribute Private Type reference (TYPE) ABAP_BOOL ABAP_FALSE (Internal) Flag: Trace Active? 20140604
5 _TRACE_SERVICE Static Attribute Private Object reference (TYPE REF TO) IF_SHM_TRACE (Internal) Reference to Trace Class 20140604
6 _TRANSACTIONAL Constant Private Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20140604
7 _VERSION_ Constant Private Type reference (TYPE) I 16 (internal) 20140604
Methods
# Method Level Visibility Method type Description Created on
1 ATTACH_FOR_READ Static method Public Method Request a Read Lock 20140604
2 ATTACH_FOR_UPDATE Static method Public Method Request a Change Lock 20140604
3 ATTACH_FOR_WRITE Static method Public Method Request a Write Lock 20140604
4 BUILD Static method Public Method Direct Call of Area Constructor 20140604
5 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 20140604
6 DETACH_AREA Static method Public Method Release all locks on all instances 20140604
7 FREE_AREA Static method Public Method Delete all instances 20140604
8 FREE_INSTANCE Static method Public Method Deletion of an Instance 20140604
9 GET_GENERATOR_VERSION Static method Public Method Query Generator Version 20140604
10 GET_INSTANCE_INFOS Static method Public Method Returns the names of all instances 20140604
11 INVALIDATE_AREA Static method Public Method Active versions of all instances will be set to obsolete 20140604
12 INVALIDATE_INSTANCE Static method Public Method Active version of one instance will be set to obsolete 20140604
13 SET_ROOT Instance method Public Method Sets Root Objects 20140604
Events
Class /UI2/CL_PAGE_CACHE_AREA has no event.
Types
Class /UI2/CL_PAGE_CACHE_AREA 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) /UI2/CL_PAGE_CACHE_AREA SHM: Model of an Area Class 20140604
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 20140604
# Exception Resumable Description Created on
1 CX_SHM_CHANGE_LOCK_ACTIVE A Change Lock Is Already Active 20140604
2 CX_SHM_EXCLUSIVE_LOCK_ACTIVE Instance Already Locked 20140604
3 CX_SHM_INCONSISTENT Different Definitions Between Program and Area 20140604
4 CX_SHM_NO_ACTIVE_VERSION No active version exists for an attach 20140604
5 CX_SHM_PARAMETER_ERROR Incorrect parameter transferred 20140604
6 CX_SHM_READ_LOCK_ACTIVE Request for a Second Read Lock 20140604

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) 20140604
2 Returning HANDLE Value transfer Object reference (TYPE REF TO) /UI2/CL_PAGE_CACHE_AREA SHM: Model of an Area Class 20140604
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 20140604
4 Importing WAIT_TIME Call by reference Type reference (TYPE) I 0 Maximum Wait Time (in Milliseconds) 20140604
# Exception Resumable Description Created on
1 CX_SHM_CHANGE_LOCK_ACTIVE A write lock is already active 20140604
2 CX_SHM_EXCLUSIVE_LOCK_ACTIVE Instance Already Locked 20140604
3 CX_SHM_INCONSISTENT Different Definitions Between Program and Area 20140604
4 CX_SHM_NO_ACTIVE_VERSION No active version exists for an attach 20140604
5 CX_SHM_PARAMETER_ERROR Passed Parameter Has Incorrect Value 20140604
6 CX_SHM_PENDING_LOCK_REMOVED Shared Objects: Waiting Lock Was Deleted 20140604
7 CX_SHM_VERSION_LIMIT_EXCEEDED No Additional Versions Available 20140604

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) 20140604
2 Returning HANDLE Value transfer Object reference (TYPE REF TO) /UI2/CL_PAGE_CACHE_AREA SHM: Model of an Area Class 20140604
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 20140604
4 Importing WAIT_TIME Call by reference Type reference (TYPE) I 0 Maximum Wait Time (in Milliseconds) 20140604
# Exception Resumable Description Created on
1 CX_SHM_CHANGE_LOCK_ACTIVE A write lock is already active 20140604
2 CX_SHM_EXCLUSIVE_LOCK_ACTIVE Instance Already Locked 20140604
3 CX_SHM_PARAMETER_ERROR Passed Parameter Has Incorrect Value 20140604
4 CX_SHM_PENDING_LOCK_REMOVED Shared Objects: Waiting Lock Was Deleted 20140604
5 CX_SHM_VERSION_LIMIT_EXCEEDED No Additional Versions Available 20140604

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 20140604
# Exception Resumable Description Created on
1 CX_SHMA_INCONSISTENT SHM Administration: Inconsistent Attribute Combination 20140604
2 CX_SHMA_NOT_CONFIGURED SHM Administration: Area Property Is Not Configured 20140604
3 CX_SHM_BUILD_FAILED Constructor Run Failed 20140604

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /UI2/CL_PAGE_CACHE_AREA has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/CL_PAGE_CACHE_AREA 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) 20140604

Method DETACH_AREA on class /UI2/CL_PAGE_CACHE_AREA 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) 20140604
2 Importing TERMINATE_CHANGER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Writing processes will be ended 20140604
# Exception Resumable Description Created on
1 CX_SHM_PARAMETER_ERROR Incorrect parameter transferred 20140604

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 20140604
2 Returning RC Value transfer Type reference (TYPE) SHM_RC Return Value (Constants in CL_SHM_AREA) 20140604
3 Importing TERMINATE_CHANGER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Writing processes will be ended 20140604
# Exception Resumable Description Created on
1 CX_SHM_PARAMETER_ERROR Incorrect parameter transferred 20140604

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 20140604

Method GET_GENERATOR_VERSION on class /UI2/CL_PAGE_CACHE_AREA 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 20140604

Method GET_INSTANCE_INFOS on class /UI2/CL_PAGE_CACHE_AREA 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) 20140604
2 Importing TERMINATE_CHANGER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Active writing processes will be ended 20140604
# Exception Resumable Description Created on
1 CX_SHM_PARAMETER_ERROR Incorrect parameter transferred 20140604

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 20140604
2 Returning RC Value transfer Type reference (TYPE) SHM_RC Detach Return Value (Constants in CL_SHM_AREA) 20140604
3 Importing TERMINATE_CHANGER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Active writing processes will be ended 20140604
# Exception Resumable Description Created on
1 CX_SHM_PARAMETER_ERROR Incorrect parameter transferred 20140604

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) /UI2/CL_PAGE_CACHE_ROOT Root object 20140604
# Exception Resumable Description Created on
1 CX_SHM_INITIAL_REFERENCE Initial Reference Passed 20140604
2 CX_SHM_WRONG_HANDLE Incorrect Handle 20140604
History
Last changed by/on SAP  20141121 
SAP Release Created in 100