SAP ABAP Class CL_UKM_BUFFER (UKM: Buffer)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-UKM (Application Component) Standardized Key Mapping
⤷
S_UKM_ENGINE (Package) Unified Key Mapping Engine
⤷
⤷
Properties
| Class | CL_UKM_BUFFER | |
| Short Description | UKM: Buffer | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_UKM_ENGINE | Unified Key Mapping Engine |
| Created | 20050110 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_UKM_BUFFER has no interface implemented.
Friends
Class CL_UKM_BUFFER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_UKM_CONFIGURATION | UKM: Access to configuration tables | 20060220 | |||
| 2 | Instance attribute | Protected | Type reference (TYPE) | UKM_T_BUFFER_KEY | UKM: Buffer table for key | 20050122 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | UKM_T_BUFFER_MGP_BY_OBJECT_ID | UKM: Buffer table for grouped mapping | 20050122 | |||
| 4 | Instance attribute | Protected | Type reference (TYPE) | UKM_T_GROUPS | UKM: Group IDs | 20050122 | |||
| 5 | Instance attribute | Public | Type reference (TYPE) | UKM_T_BUFFER_KEY | UKM: Buffer table for key | 20050110 | |||
| 6 | Instance attribute | Public | Type reference (TYPE) | UKM_T_BUFFER_KEY_BY_OBJECT_ID | UKM: Buffer table for key | 20050112 | |||
| 7 | Instance attribute | Public | Type reference (TYPE) | UKM_T_BUFFER_MGP | UKM: Buffer table for grouped mapping | 20050110 | |||
| 8 | Instance attribute | Public | Type reference (TYPE) | UKM_T_BUFFER_MGP_BY_OBJECT_ID | UKM: Buffer table for grouped mapping | 20050112 | |||
| 9 | Instance attribute | Protected | Type reference (TYPE) | UKM_E_GROUP_ID | UKM: Current group | 20050122 | |||
| 10 | Instance attribute | Public | Type reference (TYPE) | UKM_E_MAIN_CONTEXT_ID | UKM: ID of the Main Context | 20050110 | |||
| 11 | Instance attribute | Public | Type reference (TYPE) | UKM_E_RUNT_GEN_CONTEXT_BOOLEAN | UKM: Context Generated at Runtime (No Customizing) | 20060419 | |||
| 12 | Instance attribute | Public | Type reference (TYPE) | UKM_E_SUB_CONTEXT_ID | UKM: ID of the Subcontext | 20050110 | |||
| 13 | Constant | Public | Type reference (TYPE) | UKM_E_BUFFER_STATUS_CODE | 'BD' | UKM: Status of Buffer | 20050110 | ||
| 14 | Constant | Public | Type reference (TYPE) | UKM_E_BUFFER_STATUS_CODE | 'BE' | UKM: Status of Buffer | 20050110 | ||
| 15 | Constant | Public | Type reference (TYPE) | UKM_E_BUFFER_STATUS_CODE | 'BS' | UKM: Status of Buffer | 20050110 | ||
| 16 | Constant | Public | Type reference (TYPE) | UKM_E_BUFFER_STATUS_CODE | 'DE' | UKM: Status of Buffer | 20050110 | ||
| 17 | Constant | Public | Type reference (TYPE) | UKM_E_BUFFER_STATUS_CODE | 'DN' | UKM: Status of Buffer | 20050110 | ||
| 18 | Static Attribute | Private | Type reference (TYPE) | UKM_T_BUFFERS | UKM: Key mapping buffer | 20050110 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | UKM: Provides a buffer instance | 20050110 | |
| 2 | Static method | Public | Method | UKM: Empty buffer of all instances | 20050114 | |
| 3 | Instance method | Public | Method | UKM: Empty buffer of the current instance | 20050114 | |
| 4 | Instance method | Public | Constructor | UKM: Constructor | 20050110 | |
| 5 | Static method | Public | Method | UKM: Provides all buffer instances that contain data | 20050110 | |
| 6 | Instance method | Public | Method | UKM: Provides the current level of the buffer | 20050201 | |
| 7 | Instance method | Protected | Method | UKM: Reference to Configuration | 20060220 | |
| 8 | Instance method | Public | Method | UKM: Add new GroupedPositive mapping | 20050117 | |
| 9 | Instance method | Public | Method | UKM: Delete one or two objects from the mapping group | 20050117 | |
| 10 | Instance method | Public | Method | UKM: Uses the internal buffer for GP key mapping | 20050117 | |
| 11 | Instance method | Public | Method | UKM: Read the mapping results into the internal buffer | 20050118 | |
| 12 | Instance method | Protected | Method | UKM: Insert a mapping row | 20050119 | |
| 13 | Instance method | Protected | Method | UKM: Delete a mapping row | 20050126 | |
| 14 | Instance method | Protected | Method | UKM: Copy all mapping rows into the buffer | 20050123 | |
| 15 | Instance method | Protected | Method | UKM: Determines the current CLIENT_DEFAULT | 20050203 | |
| 16 | Instance method | Protected | Method | UKM: Determines the current CLIENT_DEFAULT | 20050202 |
Events
Class CL_UKM_BUFFER has no event.
Types
Class CL_UKM_BUFFER has no local type.
Method Signatures
Method ATTACH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BUFFER | Call by reference | Type reference (TYPE) | UKM_S_BUFFER | UKM: Key-Mapping Puffer | 20050110 | |||
| 2 | IR_CONFIGURATION | Call by reference | Object reference (TYPE REF TO) | CL_UKM_CONFIGURATION | UKM: Zugriff auf die Konfigurations-Tabellen | 20060220 | |||
| 3 | IV_MAIN_CONTEXT_ID | Value transfer | Type reference (TYPE) | UKM_E_MAIN_CONTEXT_ID | UKM: ID des Hauptkontextes | 20050110 | |||
| 4 | IV_RUNTIME_GENERATED_CONTEXT | Call by reference | Type reference (TYPE) | UKM_E_RUNT_GEN_CONTEXT_BOOLEAN | ABAP_TRUE | UKM: Kontext zur Laufzeit generiert (kein Customizing) | 20060419 | ||
| 5 | IV_SUB_CONTEXT_ID | Value transfer | Type reference (TYPE) | UKM_E_SUB_CONTEXT_ID | UKM: ID des Subkontextes | 20050110 |
Method ATTACH on class CL_UKM_BUFFER has no exception.
Method CLEANUP_ALL_BUFFERS Signature
Method CLEANUP_ALL_BUFFERS on class CL_UKM_BUFFER has no parameter.
Method CLEANUP_ALL_BUFFERS on class CL_UKM_BUFFER has no exception.
Method CLEANUP_BUFFER Signature
Method CLEANUP_BUFFER on class CL_UKM_BUFFER has no parameter.
Method CLEANUP_BUFFER on class CL_UKM_BUFFER has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_CONFIGURATION | Call by reference | Object reference (TYPE REF TO) | CL_UKM_CONFIGURATION | UKM: Zugriff auf die Konfigurations-Tabellen | 20060220 | |||
| 2 | IV_MAIN_CONTEXT_ID | Call by reference | Type reference (TYPE) | UKM_E_MAIN_CONTEXT_ID | UKM: ID des Hauptkontextes | 20050110 | |||
| 3 | IV_RUNTIME_GENERATED_CONTEXT | Call by reference | Type reference (TYPE) | UKM_E_RUNT_GEN_CONTEXT_BOOLEAN | ABAP_TRUE | UKM: Kontext zur Laufzeit generiert (kein Customizing) | 20060419 | ||
| 4 | IV_SUB_CONTEXT_ID | Call by reference | Type reference (TYPE) | UKM_E_SUB_CONTEXT_ID | UKM: ID des Subkontextes | 20050110 |
Method CONSTRUCTOR on class CL_UKM_BUFFER has no exception.
Method GET_ALL_FILLED_BUFFERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BUFFERS | Call by reference | Type reference (TYPE) | UKM_T_BUFFERS | UKM: Key-Mapping Puffer | 20050110 |
Method GET_ALL_FILLED_BUFFERS on class CL_UKM_BUFFER has no exception.
Method GET_BUFFER_FILL_LEVEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_BUFFER_LINES | Value transfer | Type reference (TYPE) | UKM_E_BUFFER_LINES_MAX | Maximale Anzahl der Zeilen im Buffer | 20050201 |
Method GET_BUFFER_FILL_LEVEL on class CL_UKM_BUFFER has no exception.
Method GET_REF_TO_CONFIG Signature
Method GET_REF_TO_CONFIG on class CL_UKM_BUFFER has no parameter.
Method GET_REF_TO_CONFIG on class CL_UKM_BUFFER has no exception.
Method GROUPED_MAPPING_ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_MESSAGE | Call by reference | Type reference (TYPE) | UKM_S_MESSAGE | Tabelle mit BAPI Return Informationen | 20050117 | |||
| 2 | IS_SOURCE_KEY_EXT | Call by reference | Type reference (TYPE) | UKM_S_KEY_EASY | UKM: Qualifizierter Schlüssel mit CCT-Identifier-Attributen | 20050117 | |||
| 3 | IS_TARGET_KEY_EXT | Call by reference | Type reference (TYPE) | UKM_S_KEY_EASY | UKM: Qualifizierter Schlüssel mit CCT-Identifier-Attributen | 20050117 |
Method GROUPED_MAPPING_ADD on class CL_UKM_BUFFER has no exception.
Method GROUPED_MAPPING_DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_MESSAGE | Call by reference | Type reference (TYPE) | UKM_S_MESSAGE | Tabelle mit BAPI Return Informationen | 20050117 | |||
| 2 | IS_SOURCE_KEY_EXT | Call by reference | Type reference (TYPE) | UKM_S_KEY_EASY | UKM: Qualifizierter Schlüssel mit CCT-Identifier-Attributen | 20050117 | |||
| 3 | IS_TARGET_KEY_EXT | Call by reference | Type reference (TYPE) | UKM_S_KEY_EASY | UKM: Qualifizierter Schlüssel mit CCT-Identifier-Attributen | 20050117 |
Method GROUPED_MAPPING_DELETE on class CL_UKM_BUFFER has no exception.
Method GROUPED_MAPPING_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_ACTION | Call by reference | Type reference (TYPE) | UKM_S_ACTION_SINGLE | UKM: Eine Einzelaktion (eines Massen-Aufrufs) | 20050202 | |||
| 2 | CT_ADDITIONAL_MAPPINGS | Call by reference | Type reference (TYPE) | UKM_T_MAPPINGS_EASY | Zusätzliche Mappings | 20050118 | |||
| 3 | EV_DB_NOT_EXISTS_FOUND | Call by reference | Type reference (TYPE) | ABAP_BOOL | Mapping mit Status DB_NOT_EXISTS gefunden | 20050117 | |||
| 4 | EV_MAPPING_FOUND | Call by reference | Type reference (TYPE) | ABAP_BOOL | Mapping wurde gefunden | 20050118 |
Method GROUPED_MAPPING_GET on class CL_UKM_BUFFER has no exception.
Method GROUPED_MAPPING_GET_FROM_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_KEY_MAPPING | Call by reference | Type reference (TYPE) | UKM_T_MAPPINGS_EASY | UKM: Mappings | 20050119 | |||
| 2 | IV_GET_WHOLE_GROUP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20050118 | |||
| 3 | IV_UPDATE_BUFFER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20050119 | |||
| 4 | RS_ACTION_CONTEXT | Call by reference | Object reference (TYPE REF TO) | UKM_S_ACTION_CONTEXT | UKM: Alle Aktionen zu einem Kontext | 20050202 |
Method GROUPED_MAPPING_GET_FROM_DB on class CL_UKM_BUFFER has no exception.
Method MAPPING_ENTRY_ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_KEY | Call by reference | Type reference (TYPE) | UKM_S_BUFFER_KEY | UKM: Pufferstruktur für Schlüssel | 20050122 | |||
| 2 | CS_MGP | Call by reference | Type reference (TYPE) | UKM_S_BUFFER_MGP | UKM: Pufferstruktur für Schlüssel | 20050122 | |||
| 3 | IV_CLIENT_DEFAULT | Call by reference | Type reference (TYPE) | UKM_E_CLIENT_DEFAULT_BOOLEAN | UKM: Indikator für Standard-Objekt des Client-Systems | 20050123 | |||
| 4 | IV_FROM_IF | Call by reference | Type reference (TYPE) | UKM_E_BOOLEAN | UKM: Hinzufügung von öffentl. Schnittstelle (nicht von DB) | 20050122 |
Method MAPPING_ENTRY_ADD on class CL_UKM_BUFFER has no exception.
Method MAPPING_ENTRY_DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_KEY | Call by reference | Type reference (TYPE) | UKM_S_BUFFER_KEY | UKM: Pufferstruktur für Schlüssel | 20050126 |
Method MAPPING_ENTRY_DELETE on class CL_UKM_BUFFER has no exception.
Method MAPPING_ENTRY_SAVE_TO_BUFFER Signature
Method MAPPING_ENTRY_SAVE_TO_BUFFER on class CL_UKM_BUFFER has no parameter.
Method MAPPING_ENTRY_SAVE_TO_BUFFER on class CL_UKM_BUFFER has no exception.
Method SET_CLIENT_DEFAULT_BY_GROUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_GROUP_ID | Call by reference | Type reference (TYPE) | UKM_E_GROUP_ID | UKM: Pufferstruktur für Schlüssel | 20050203 |
Method SET_CLIENT_DEFAULT_BY_GROUP on class CL_UKM_BUFFER has no exception.
Method SET_CLIENT_DEFAULT_BY_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_CLIENT_DEFAULT | Call by reference | Type reference (TYPE) | UKM_E_CLIENT_DEFAULT_BOOLEAN | UKM: Indikator für Standard-Objekt des Client-Systems | 20050203 | |||
| 2 | IS_KEY | Call by reference | Type reference (TYPE) | UKM_S_BUFFER_KEY | UKM: Pufferstruktur für Schlüssel | 20050203 | |||
| 3 | IV_FROM_IF | Call by reference | Type reference (TYPE) | UKM_E_IF_FLAG_BOOLEAN | UKM: Update vom Interface | 20050203 | |||
| 4 | IV_KEY_HAS_PRIORITY | Call by reference | Type reference (TYPE) | UKM_E_IF_FLAG_BOOLEAN | ABAP_TRUE | UKM: Der übergebene Schlüssel hat Vorrang vor dem add-Buffer | 20050203 |
Method SET_CLIENT_DEFAULT_BY_KEY on class CL_UKM_BUFFER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 700 |