SAP ABAP Class CL_INM_NAV_SHM (Shared Memory INM Navigation)
Hierarchy
☛
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
⤷ PPM-CF (Application Component) Common Functions
⤷ INM_UI_NAV (Package) PPM Cross Application Navigation Objects
⤷ PPM-CF (Application Component) Common Functions
⤷ INM_UI_NAV (Package) PPM Cross Application Navigation Objects
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 | 20090511 |
Properties
Class | CL_INM_NAV_SHM | |
Short Description | Shared Memory INM Navigation | |
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 | INM_UI_NAV | PPM Cross Application Navigation Objects |
Created | 20090511 | SAP |
Last change | 20141109 | |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
Class CL_INM_NAV_SHM has no forward declaration.
Interfaces
Class CL_INM_NAV_SHM has no interface implemented.
Friends
# | Friend | Modeled only | Created on | Description |
---|---|---|---|---|
1 | CL_SHM_AREA | 20090511 | 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_INM_NAV_SHM' | Name of an Area Class | 20090511 | |
2 | ROOT | Instance attribute | Public | Object reference (TYPE REF TO) | CL_INM_NAV_SHM_ROOT | SHM: Model of a Data Class | 20090511 | ||
3 | _CLIENT_DEPENDENT | Constant | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20090511 | ||
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) | 20090511 | |
5 | _TRACE_ACTIVE | Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | (Internal) Flag: Trace Active? | 20090511 | |
6 | _TRACE_SERVICE | Static Attribute | Private | Object reference (TYPE REF TO) | IF_SHM_TRACE | (Internal) Reference to Trace Class | 20090511 | ||
7 | _TRANSACTIONAL | Constant | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20090511 | ||
8 | _VERSION_ | Constant | Private | Type reference (TYPE) | I | 19 | (internal) | 20090511 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | ATTACH_FOR_READ | Static method | Public | Method | Request a Read Lock | 20090511 |
2 | ATTACH_FOR_UPDATE | Static method | Public | Method | Request a Change Lock | 20090511 |
3 | ATTACH_FOR_WRITE | Static method | Public | Method | Request a Write Lock | 20090511 |
4 | BUILD | Static method | Public | Method | Direct Call of Area Constructor | 20090511 |
5 | CLASS_CONSTRUCTOR | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20090511 |
6 | DETACH_AREA | Static method | Public | Method | Release all locks on all instances | 20090511 |
7 | FREE_AREA | Static method | Public | Method | Delete all instances | 20090511 |
8 | FREE_INSTANCE | Static method | Public | Method | Deletion of an Instance | 20090511 |
9 | GET_GENERATOR_VERSION | Static method | Public | Method | Query Generator Version | 20090511 |
10 | GET_INSTANCE_INFOS | Static method | Public | Method | Returns the names of all instances | 20090511 |
11 | INVALIDATE_AREA | Static method | Public | Method | Active versions of all instances will be set to obsolete | 20090511 |
12 | INVALIDATE_INSTANCE | Static method | Public | Method | Active version of one instance will be set to obsolete | 20090511 |
13 | SET_ROOT | Instance method | Public | Method | Sets Root Objects | 20090511 |
Events
Class CL_INM_NAV_SHM has no event.
Types
Class CL_INM_NAV_SHM 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) | CL_INM_NAV_SHM | SHM: Model of an Area Class | 20090511 | ||
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 | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | A Change Lock Is Already Active | 20090511 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instance Already Locked | 20090511 | |
3 | CX_SHM_INCONSISTENT | Different Definitions Between Program and Area | 20090511 | |
4 | CX_SHM_NO_ACTIVE_VERSION | No active version exists for an attach | 20090511 | |
5 | CX_SHM_PARAMETER_ERROR | Incorrect parameter transferred | 20090511 | |
6 | CX_SHM_READ_LOCK_ACTIVE | Request for a Second Read Lock | 20090511 |
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) | 20090511 | |
2 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_INM_NAV_SHM | SHM: Model of an Area Class | 20090511 | ||
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 | 20090511 | |
4 | Importing | WAIT_TIME | Call by reference | Type reference (TYPE) | I | 0 | Maximum Wait Time (in Milliseconds) | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | A write lock is already active | 20090511 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instance Already Locked | 20090511 | |
3 | CX_SHM_INCONSISTENT | Different Definitions Between Program and Area | 20090511 | |
4 | CX_SHM_NO_ACTIVE_VERSION | No active version exists for an attach | 20090511 | |
5 | CX_SHM_PARAMETER_ERROR | Passed Parameter Has Incorrect Value | 20090511 | |
6 | CX_SHM_PENDING_LOCK_REMOVED | Shared Objects: Waiting Lock Was Deleted | 20090511 | |
7 | CX_SHM_VERSION_LIMIT_EXCEEDED | No Additional Versions Available | 20090511 |
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) | 20090511 | |
2 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_INM_NAV_SHM | SHM: Model of an Area Class | 20090511 | ||
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 | 20090511 | |
4 | Importing | WAIT_TIME | Call by reference | Type reference (TYPE) | I | 0 | Maximum Wait Time (in Milliseconds) | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | A write lock is already active | 20090511 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instance Already Locked | 20090511 | |
3 | CX_SHM_PARAMETER_ERROR | Passed Parameter Has Incorrect Value | 20090511 | |
4 | CX_SHM_PENDING_LOCK_REMOVED | Shared Objects: Waiting Lock Was Deleted | 20090511 | |
5 | CX_SHM_VERSION_LIMIT_EXCEEDED | No Additional Versions Available | 20090511 |
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 | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHMA_INCONSISTENT | SHM Administration: Inconsistent Attribute Combination | 20090511 | |
2 | CX_SHMA_NOT_CONFIGURED | SHM Administration: Area Property Is Not Configured | 20090511 | |
3 | CX_SHM_BUILD_FAILED | Constructor Run Failed | 20090511 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_INM_NAV_SHM has no parameter.
Method CLASS_CONSTRUCTOR on class CL_INM_NAV_SHM 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) | 20090511 |
Method DETACH_AREA on class CL_INM_NAV_SHM 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) | 20090511 | ||
2 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Writing processes will be ended | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Incorrect parameter transferred | 20090511 |
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 | 20090511 | |
2 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Return Value (Constants in CL_SHM_AREA) | 20090511 | ||
3 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Writing processes will be ended | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Incorrect parameter transferred | 20090511 |
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 | 20090511 |
Method GET_GENERATOR_VERSION on class CL_INM_NAV_SHM 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 | 20090511 |
Method GET_INSTANCE_INFOS on class CL_INM_NAV_SHM 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) | 20090511 | ||
2 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Active writing processes will be ended | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Incorrect parameter transferred | 20090511 |
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 | 20090511 | |
2 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach Return Value (Constants in CL_SHM_AREA) | 20090511 | ||
3 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Active writing processes will be ended | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Incorrect parameter transferred | 20090511 |
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_INM_NAV_SHM_ROOT | Root object | 20090511 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_INITIAL_REFERENCE | Initial Reference Passed | 20090511 | |
2 | CX_SHM_WRONG_HANDLE | Incorrect Handle | 20090511 |
History
Last changed by/on | SAP | 20141109 |
SAP Release Created in | 500_702 |