SAP ABAP Class CL_SRM_SP_PROTOCOL (SRM Protocol)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_PROTOCOL (Package) SRM Protocol
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_SP_OBJECT | Abstract Base Class for SPs | 20020419 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_SP_PROTOCOL_ENTRY | Read/Write SRM Log Entries | 20020419 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_SP_PROTOCOL_META | SRM SP Protocol: Semantic Description | 20020429 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SRM_SP_PROTOCOL_VIEWER | Read/Write SRM Log Entries | 20020419 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_RMPS_LOCATOR_PROTOCOL | 20060420 | |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_RMPS_SP_POST_PROTOCOL | Log Handler for Incoming Post Item | 20030123 |
| 3 | Inheritance (c INHERITING FROM c_ref) | CL_SCMG_CASE_PROTOCOL | SP Case Class for Log | 20020627 |
| 4 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_SK_PROTOCOL | CL_SRM_SK_PROTOCOL | 20020514 |
| 5 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_SP_AL_PROTOCOL | SP AL Protocol | 20041209 |
| 6 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_SP_BDS_PROTOCOL | SP AL Protocol | 20050119 |
Properties
| Class | CL_SRM_SP_PROTOCOL | |
| Short Description | SRM Protocol | |
| Super Class | CL_SRM_SP_OBJECT | Abstract Base Class for SPs |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SRM_PROTOCOL | SRM Protocol |
| Created | 20020419 | 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) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SRM_SP_PROTOCOL_ENTRY | Read/Write SRM Log Entries | 20020419 | ||
| 2 | IF_SRM_SP_PROTOCOL_META | SRM SP Protocol: Semantic Description | 20020429 | ||
| 3 | IF_SRM_SP_PROTOCOL_VIEWER | Read/Write SRM Log Entries | 20020419 |
Friends
Class CL_SRM_SP_PROTOCOL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Type reference (TYPE) | SRMPROTOCOL_U_T | Protocol Entries Before Storage | 20040920 | |||
| 2 | Instance attribute | Protected | Type reference (TYPE) | SRMPT_OTR_TEXT_TAB | Table for OTR Texts Referenced in Protocol | 20020425 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | SRMPT_PROTO_ACT_DESC_TAB | Logging Description of Stand Operations with List | 20020430 | |||
| 4 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_ALV_GRID | ALV Grid for Display Protocol | 20020425 | |||
| 5 | Instance attribute | Protected | Type reference (TYPE) | SRMPT_DISPLAY_CONFIG | Display Setting in ALV Grid | 20030120 | |||
| 6 | Instance attribute | Protected | Type reference (TYPE) | STRING | Display Name | 20031215 | |||
| 7 | Instance attribute | Protected | Type reference (TYPE) | SRMPT_PROTO_ENTRY_TAB | Table of Selected Protocol Entries | 20020425 | |||
| 8 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | GUI Container for Display Protocol | 20020425 | |||
| 9 | Instance attribute | Protected | Type reference (TYPE) | TIMESTAMPL | Time Stamp of Last Log | 20020808 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Protected | Method | Generate Field Catalog for ALV Grid | 20020425 | |
| 2 | Instance method | Protected | Method | Initializing Protocol Description of Operation List | 20020429 | |
| 3 | Instance method | Protected | Event handling method | Process ALV Standard Functions | 20020429 | |
| 4 | Instance method | Protected | Event handling method | ALV event context my handler | 20030121 | |
| 5 | Instance method | Protected | Event handling method | ALV Event Toolbar Handler | 20020514 | |
| 6 | Instance method | Protected | Event handling method | ALV User Command Handler | 20030120 | |
| 7 | Static method | Protected | Method | Converts Raw Data (RecID, UName, Timestamp) to Display Text | 20020808 | |
| 8 | Static method | Public | Method | Reading logs independent of POID | 20020808 | |
| 9 | Instance method | Protected | Method | Read Procl to be Displayed (Can be from Other POIDs/Objects) | 20030121 | |
| 10 | Instance method | Protected | Method | Reading Data Records of SRMGSPROTO Table | 20020426 | |
| 11 | Instance method | Protected | Method | Translate OTR Alias Contained in Text and Marked by & | 20030116 | |
| 12 | Instance method | Private | Method | Write a Protocol Entry Immediately | 20040920 |
Events
Class CL_SRM_SP_PROTOCOL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | SRMPROTOCOL_UPD | Protected | See coding | 20040920 | BEGIN OF srmprotocol_upd,
entry TYPE srmprotocol,
update_mode TYPE string,
END OF srmprotocol_upd
|
||
| 2 | SRMPROTOCOL_U_T | Protected | See coding | 20040920 | srmprotocol_u_t TYPE STANDARD TABLE OF srmprotocol_upd WITH DEFAULT KEY
|
Method Signatures
Method BUILD_ALV_FIELDCATALOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_FIELDCATALOG | Call by reference | Type reference (TYPE) | SRMGU_FIELDCATALOG_TAB | Field catalog für ALV Grid | 20020425 | |||
| 2 | IM_COLTEXT_ARG1 | Value transfer | Type reference (TYPE) | STRING | Column heading in ALV Grid für ARG1 | 20020425 | |||
| 3 | IM_COLTEXT_ARG2 | Value transfer | Type reference (TYPE) | STRING | Column heading in ALV Grid für ARG2 | 20020425 | |||
| 4 | IM_COLTEXT_ARG_STRING | Value transfer | Type reference (TYPE) | STRING | Column heading in ALV Grid für ARG_STRING | 20020425 | |||
| 5 | IM_HIDE_ARG1 | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Keine Anzeige der Spalte ARG1 | 20020425 | |||
| 6 | IM_HIDE_ARG2 | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Keine Anzeige der Spalte ARG2 | 20020425 | |||
| 7 | IM_HIDE_SUBOBJ | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Keine Anzeige der Spalte SUBOBJ | 20020730 |
Method BUILD_ALV_FIELDCATALOG on class CL_SRM_SP_PROTOCOL has no exception.
Method INIT_PROTO_OPERATION_LIST Signature
Method INIT_PROTO_OPERATION_LIST on class CL_SRM_SP_PROTOCOL has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception class for SRM protocol | 20020710 |
Method ON_ALV_BEFORE_USER_COMMAND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_UCOMM | Value transfer | Attribute reference (LIKE) | 20020429 |
Method ON_ALV_BEFORE_USER_COMMAND on class CL_SRM_SP_PROTOCOL has no exception.
Method ON_ALV_CONTEXT_MENU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_OBJECT | Value transfer | Attribute reference (LIKE) | 20030121 |
Method ON_ALV_CONTEXT_MENU on class CL_SRM_SP_PROTOCOL has no exception.
Method ON_ALV_TOOLBAR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_OBJECT | Value transfer | Attribute reference (LIKE) | 20020514 |
Method ON_ALV_TOOLBAR on class CL_SRM_SP_PROTOCOL has no exception.
Method ON_ALV_USER_COMMAND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_UCOMM | Value transfer | Attribute reference (LIKE) | 20030120 |
Method ON_ALV_USER_COMMAND on class CL_SRM_SP_PROTOCOL has no exception.
Method PREPARE_FOR_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA_ID | Call by reference | Type reference (TYPE) | STRING | 20020808 | ||||
| 2 | ENTRIES | Call by reference | Type reference (TYPE) | SRMPT_PROTO_ENTRY_TAB | Protokolle | 20020808 | |||
| 3 | SRM | Call by reference | Object reference (TYPE REF TO) | IF_SRM | Referenz auf if_srm | 20020808 |
Method PREPARE_FOR_DISPLAY on class CL_SRM_SP_PROTOCOL has no exception.
Method READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_ENTRIES | Call by reference | Type reference (TYPE) | SRMPT_PROTO_ENTRY_TAB | Protokolle | 20020808 | |||
| 2 | IM_AREA_ID | Call by reference | Type reference (TYPE) | STRING | AREA ID | 20020812 | |||
| 3 | IM_END_DATE | Value transfer | Type reference (TYPE) | D | Enddatum | 20020808 | |||
| 4 | IM_MAX_ROWS | Value transfer | Type reference (TYPE) | I | Maximale Anzahl der zu lesenden Einträge | 20020808 | |||
| 5 | IM_PDIR_ID | Value transfer | Type reference (TYPE) | STRING | POID Dir ID | 20020808 | |||
| 6 | IM_SRM | Call by reference | Object reference (TYPE REF TO) | IF_SRM | Allgemeine SRM Methoden | 20020812 | |||
| 7 | IM_START_DATE | Value transfer | Type reference (TYPE) | D | Startdatum | 20020808 |
Method READ on class CL_SRM_SP_PROTOCOL has no exception.
Method READ_FOR_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_ENTRIES | Call by reference | Type reference (TYPE) | SRMPT_PROTO_ENTRY_TAB | 20030121 | ||||
| 2 | IM_END_DATE | Value transfer | Type reference (TYPE) | D | 20030121 | ||||
| 3 | IM_MAX_ROWS | Value transfer | Type reference (TYPE) | I | 20030121 | ||||
| 4 | IM_START_DATE | Value transfer | Type reference (TYPE) | D | 20030121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception class for SRM protocol | 20030121 |
Method READ_GSPROTO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_ENTRIES | Call by reference | Type reference (TYPE) | SRMPT_PROTO_ENTRY_TAB | Tabelle der Protokoll-Einträge | 20020426 | |||
| 2 | IM_END_DATE | Value transfer | Type reference (TYPE) | D | Enddatum der Protokollierung | 20020426 | |||
| 3 | IM_MAX_ROWS | Value transfer | Type reference (TYPE) | I | Anzahl der maximalen Datensätze | 20020426 | |||
| 4 | IM_START_DATE | Value transfer | Type reference (TYPE) | D | Startdatum der Protokollierung | 20020426 |
Method READ_GSPROTO on class CL_SRM_SP_PROTOCOL has no exception.
Method TRANSLATE_OTR_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_TEXT | Value transfer | Type reference (TYPE) | STRING | 20030116 | ||||
| 2 | RE_TEXT | Value transfer | Type reference (TYPE) | STRING | 20030116 |
Method TRANSLATE_OTR_TEXT on class CL_SRM_SP_PROTOCOL has no exception.
Method WRITE_INTERNAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PROTO_ENTRY | Call by reference | Type reference (TYPE) | SRMPROTOCOL | SRM protocol entries | 20040920 | |||
| 2 | IM_UPDATE_MODE | Call by reference | Type reference (TYPE) | STRING | Update-Modus | 20040920 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception class for SRM protocol | 20040920 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 630 |