SAP ABAP Class CL_SHM_AREA_MODEL (SHM: Model of an Area Class)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷ BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
⤷ SHARED_OBJECTS (Package) Shared Objects: Basis Components
⤷ BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
⤷ SHARED_OBJECTS (Package) Shared Objects: Basis Components
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 | 20020827 |
Properties
Class | CL_SHM_AREA_MODEL | |
Short Description | SHM: Model of an Area Class | |
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 | 0 | |
Package | SHARED_OBJECTS | Shared Objects: Basis Components |
Created | 20020827 | SAP |
Last change | 20130531 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
2 | CL_SHM_AREA | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_SHM_AREA_MODEL has no interface implemented.
Friends
# | Friend | Modeled only | Created on | Description |
---|---|---|---|---|
1 | CL_SHM_AREA | 20030407 | 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 | 'CL_SHM_AREA_MODEL' | Name of an Area Class | 20021003 | |
2 | ROOT | Instance attribute | Public | Object reference (TYPE REF TO) | CL_SHM_DATA_MODEL | SHM: Model of a Data Class | 20030515 | ||
3 | _CLIENT_DEPENDENT | Constant | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20030828 | ||
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) | 20060531 | |
5 | _TRACE_ACTIVE | Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | (Internal) Flag: Trace Active? | 20030117 | |
6 | _TRACE_SERVICE | Static Attribute | Private | Object reference (TYPE REF TO) | IF_SHM_TRACE | (Internal) Reference to Trace Class | 20030117 | ||
7 | _TRANSACTIONAL | Constant | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20030828 | ||
8 | _VERSION_ | Constant | Private | Type reference (TYPE) | I | 21 | (internal) | 20021129 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | ATTACH_FOR_READ | Static method | Public | Method | Request a Read Lock | 20020827 |
2 | ATTACH_FOR_UPDATE | Static method | Public | Method | Request a Change Lock | 20020827 |
3 | ATTACH_FOR_WRITE | Static method | Public | Method | Request a Write Lock | 20020827 |
4 | BUILD | Static method | Public | Method | Direct Call of Area Constructor | 20020827 |
5 | CLASS_CONSTRUCTOR | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20020827 |
6 | DETACH_AREA | Static method | Public | Method | Release all locks on all instances | 20020827 |
7 | FREE_AREA | Static method | Public | Method | Delete all instances | 20020827 |
8 | FREE_INSTANCE | Static method | Public | Method | Deletion of an Instance | 20020827 |
9 | GET_GENERATOR_VERSION | Static method | Public | Method | Query Generator Version | 20030521 |
10 | GET_INSTANCE_INFOS | Static method | Public | Method | Returns the names of all instances | 20020906 |
11 | INVALIDATE_AREA | Static method | Public | Method | Active versions of all instances will be set to obsolete | 20020827 |
12 | INVALIDATE_INSTANCE | Static method | Public | Method | Active version of one instance will be set to obsolete | 20020827 |
13 | PROPAGATE_AREA | Static method | Public | Method | OBSOLET: Use INVALIDATE_AREA | 20030521 |
14 | PROPAGATE_INSTANCE | Static method | Public | Method | OBSOLET: Use INVALIDATE_INSTANCE | 20030521 |
15 | SET_ROOT | Instance method | Public | Method | Sets Root Objects | 20030515 |
Events
Class CL_SHM_AREA_MODEL has no event.
Types
Class CL_SHM_AREA_MODEL 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 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
2 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_SHM_AREA_MODEL | SHM: Modell einer Gebietsklasse | 20020905 | ||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20020905 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | Eine Änderungssperre ist schon aktiv | 20030918 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instanz ist schon gesperrt | 20020827 | |
3 | CX_SHM_INCONSISTENT | Unterschiedliche Definitionen zwischen Program und Gebiet | 20020827 | |
4 | CX_SHM_NO_ACTIVE_VERSION | Keine aktive Version für ein Attach vorhanden | 20020827 | |
5 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030514 | |
6 | CX_SHM_READ_LOCK_ACTIVE | Anforderung einer 2. Lesesperre | 20020906 |
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 | Modus des ATTACHS (Konstanten in CL_SHM_AREA) | 20030815 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
3 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_SHM_AREA_MODEL | SHM: Modell einer Gebietsklasse | 20020906 | ||
4 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20020906 | |
5 | Importing | WAIT_TIME | Call by reference | Type reference (TYPE) | I | 0 | Maximale Wartezeit (in Millisekunden) | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | Eine Schreibsperre ist schon aktiv | 20020827 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instanz ist schon gesperrt | 20020827 | |
3 | CX_SHM_INCONSISTENT | Unterschiedliche Definitionen zwischen Program und Gebiet | 20020827 | |
4 | CX_SHM_NO_ACTIVE_VERSION | Keine aktive Version für ein Attach vorhanden | 20020827 | |
5 | CX_SHM_PARAMETER_ERROR | Übergebener Parameter hat falschen Wert | 20030403 | |
6 | CX_SHM_PENDING_LOCK_REMOVED | Shared Objects: wartende Sperre wurde gelöscht | 20040908 | |
7 | CX_SHM_VERSION_LIMIT_EXCEEDED | Keine weiteren Versionen verfügbar | 20020827 |
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 | Modus des ATTACHS (Konstanten in CL_SHM_AREA) | 20030815 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
3 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_SHM_AREA_MODEL | SHM: Modell einer Gebietsklasse | 20020906 | ||
4 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20020906 | |
5 | Importing | WAIT_TIME | Call by reference | Type reference (TYPE) | I | 0 | Maximale Wartezeit (in Millisekunden) | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | Eine Schreibsperre ist schon aktiv | 20020827 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instanz ist schon gesperrt | 20020827 | |
3 | CX_SHM_PARAMETER_ERROR | Übergebener Parameter hat falschen Wert | 20030403 | |
4 | CX_SHM_PENDING_LOCK_REMOVED | Shared Objects: wartende Sperre wurde gelöscht | 20040908 | |
5 | CX_SHM_VERSION_LIMIT_EXCEEDED | Keine weiteren Versionen verfügbar | 20020827 |
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 einer Shared Object Instanz eines Areas | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHMA_INCONSISTENT | SHMA: Inkonsistente Attribut-Kombination | 20021129 | |
2 | CX_SHMA_NOT_CONFIGURED | SHMA: Gebietseigenschaft ist nicht konfiguriert | 20021129 | |
3 | CX_SHM_BUILD_FAILED | Konstruktorlauf ist fehlgeschlagen | 20030408 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_SHM_AREA_MODEL has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SHM_AREA_MODEL has no exception.
Method DETACH_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
2 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach-Rückgabewert (Konstanten in CL_SHM_AREA) | 20020906 |
Method DETACH_AREA on class CL_SHM_AREA_MODEL has no exception.
Method FREE_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AFFECT_SERVER | Call by reference | Type reference (TYPE) | SHM_AFFECT_SERVER | CL_SHM_AREA=>AFFECT_LOCAL_SERVER | Server, auf denen das Gebiet gelöscht oder invalidiert wird | 20060307 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
3 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Rückgabewert (Konstanten in CL_SHM_AREA) | 20020906 | ||
4 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Schreiber werden beendet | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030429 |
Method FREE_INSTANCE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AFFECT_SERVER | Call by reference | Type reference (TYPE) | SHM_AFFECT_SERVER | CL_SHM_AREA=>AFFECT_LOCAL_SERVER | Server, auf denen das Gebiet gelöscht oder invalidiert wird | 20060307 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20020906 | |
4 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Rückgabewert (Konstanten in CL_SHM_AREA) | 20020906 | ||
5 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Schreiber werden beendet | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030429 |
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 | 20030521 |
Method GET_GENERATOR_VERSION on class CL_SHM_AREA_MODEL has no exception.
Method GET_INSTANCE_INFOS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
2 | Returning | INFOS | Value transfer | Type reference (TYPE) | SHM_INST_INFOS | Übersicht aller Instanzen eines SHM-Gebiets | 20020906 | ||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | Name einer Shared Object Instanz eines Areas | 20111024 |
Method GET_INSTANCE_INFOS on class CL_SHM_AREA_MODEL has no exception.
Method INVALIDATE_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AFFECT_SERVER | Call by reference | Type reference (TYPE) | SHM_AFFECT_SERVER | CL_SHM_AREA=>AFFECT_LOCAL_SERVER | Server, auf denen das Gebiet gelöscht oder invalidiert wird | 20060307 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
3 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach-Rückgabewert (Konstanten in CL_SHM_AREA) | 20020906 | ||
4 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aktive Schreiber werden beendet | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030429 |
Method INVALIDATE_INSTANCE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AFFECT_SERVER | Call by reference | Type reference (TYPE) | SHM_AFFECT_SERVER | CL_SHM_AREA=>AFFECT_LOCAL_SERVER | Server, auf denen das Gebiet gelöscht oder invalidiert wird | 20060307 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030512 | |||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20020906 | |
4 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach-Rückgabewert (Konstanten in CL_SHM_AREA) | 20020906 | ||
5 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aktive Schreiber werden beendet | 20020906 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030429 |
Method PROPAGATE_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AFFECTING_LOCAL_SERVER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Auch lokaler Server soll synchronisiert werden | 20030521 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030521 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030521 |
Method PROPAGATE_INSTANCE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AFFECTING_LOCAL_SERVER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Auch lokaler Server soll synchronisiert werden | 20030521 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20030521 | |||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20030521 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20030521 |
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) | CL_SHM_DATA_MODEL | Wurzelobjekt | 20030515 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_INITIAL_REFERENCE | Initiale Referenz übergeben | 20030515 | |
2 | CX_SHM_WRONG_HANDLE | Falsches Handle | 20030515 |
History
Last changed by/on | SAP | 20130531 |
SAP Release Created in | 630 |