SAP ABAP Class CL_SRM_HELPER_1 (Class for General Help Functions 1)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_GENERAL (Package) General Records Management Package
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-RM (Application Component) SAP Records Management⤷
SRM_GENERAL (Package) General Records Management PackageProperties
| Class | CL_SRM_HELPER_1 | |
| Short Description | Class for General Help Functions 1 | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | SRM_GENERAL | |
| Program status | ||
| Category | 0 | |
| Package | SRM_GENERAL | General Records Management Package |
| Created | 20001130 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  IF_SRM |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class CL_SRM_HELPER_1 has no interface implemented.
Friends
Class CL_SRM_HELPER_1 has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | VIRUS_SCANNER |
Static Attribute | Public | Object reference (TYPE REF TO) | CL_VSI | Handle to virus scanner | 20120116 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_SPS_WHEREUSED_CONF |
Static method | Public | Method | Checks whether SPS is to write where-used list | 20011207 |
| 2 | EXCEPTION_POPUP |
Static method | Public | Method | Display Popup for Exception | 20041007 |
| 3 | EXECUTE_VIRUS_SCAN |
Static method | Public | Method | Execute virus scan | 20120116 |
| 4 | GET_SPS_ICONS |
Static method | Public | Method | Determining Icons for Element Type Model and Instance | 20001207 |
| 5 | GET_SPTYPE_POSITION |
Static method | Public | Method | Select Customizing for SP Type Position | 20021028 |
| 6 | GET_SP_TYPE_LIST |
Static method | Public | Method | Gets List with SP Types from Registry | 20040921 |
| 7 | GET_WHEREUSED |
Static method | Public | Method | Read Where-Used List | 20011207 |
| 8 | SET_WHEREUSED |
Static method | Public | Method | Write Where-Used List | 20011207 |
Events
Class CL_SRM_HELPER_1 has no event.
Types
Class CL_SRM_HELPER_1 has no local type.
Method Signatures
Method CHECK_SPS_WHEREUSED_CONF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IM_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | POID | 20011207 | ||
| 2 |  Returning |
RE_WRITE_WHEREUSED | Value transfer | Type reference (TYPE) | SRMBOOLEAN | IF_SRM=>TRUE: Verwendungsnachweis schreiben | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRM_FRAMEWORK |
Framework (abstrakt) | 20011207 |
Method EXCEPTION_POPUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_EXCEPTION | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstrakte Oberklasse aller globalen Exceptions | 20041007 |
Method EXCEPTION_POPUP on class CL_SRM_HELPER_1 has no exception.
Method EXECUTE_VIRUS_SCAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EX_ERROR_MSG_TAB | Call by reference | Type reference (TYPE) | VSCAN_BAPIRET2_T | Error messages | 20120116 | ||
| 2 | Exporting |
EX_VSCAN_OK | Call by reference | Type reference (TYPE) | SRMBOOLEAN | Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE | 20120116 | ||
| 3 | Importing |
IM_BIN_CONTENT | Call by reference | Type reference (TYPE) | TABLE | either XSTRING or BIN content provided | 20120116 | ||
| 4 | Importing |
IM_FILE_PATH | Call by reference | Type reference (TYPE) | STRING | file path | 20120116 | ||
| 5 | Importing |
IM_FILE_SIZE | Call by reference | Type reference (TYPE) | I | size of content | 20120116 | ||
| 6 | Importing |
IM_VSCAN_PROFILE | Call by reference | Type reference (TYPE) | VSCAN_PROFILE | '/SRM/RCM_CREATE' | virus scan profile | 20120116 | |
| 7 | Importing |
IM_XSTRING_CONTENT | Call by reference | Type reference (TYPE) | XSTRING | either XSTRING or BIN content provided | 20120117 |
Method EXECUTE_VIRUS_SCAN on class CL_SRM_HELPER_1 has no exception.
Method GET_SPS_ICONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_ICON_INSTANCE_ID | Value transfer | Type reference (TYPE) | ICON-ID | Ikone in Textfeldern (Ersatzdarstellung, Alias) | 20001207 | ||
| 2 | Exporting |
EX_ICON_INSTANCE_NAME | Value transfer | Type reference (TYPE) | SRMICONIN | ICON: Instanz | 20001207 | ||
| 3 | Exporting |
EX_ICON_MODEL_ID | Value transfer | Type reference (TYPE) | ICON-ID | Ikone in Textfeldern (Ersatzdarstellung, Alias) | 20001207 | ||
| 4 | Exporting |
EX_ICON_MODEL_NAME | Value transfer | Type reference (TYPE) | SRMICINMO | ICON: Modell | 20001207 | ||
| 5 | Importing |
IM_SPS_ID | Value transfer | Type reference (TYPE) | SRMSPSID | ID SPS | 20001207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOTHING_FOUND |
Keine Einträge gefunden | 20001207 |
Method GET_SPTYPE_POSITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_TYPE | Call by reference | Type reference (TYPE) | STRING | Typ (z.B. SRM_DOCUMENT) | 20021028 | ||
| 2 | Returning |
RE_POSITION | Value transfer | Type reference (TYPE) | I | Position in Liste (-1 = unsichtbar) | 20021028 |
Method GET_SPTYPE_POSITION on class CL_SRM_HELPER_1 has no exception.
Method GET_SP_TYPE_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_AREA_ID | Call by reference | Type reference (TYPE) | STRING | 20040921 | |||
| 2 | Importing |
IM_SRM_REF | Call by reference | Object reference (TYPE REF TO) | IF_SRM | Allgemeine SRM Methoden | 20040921 | ||
| 3 | Returning |
RE_LIST | Value transfer | Type reference (TYPE) | SRM_LIST_ORGTYPE | Liste: Typen für Organizer | 20040921 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_FRAMEWORK |
Framework (abstrakt) | 20040921 |
Method GET_WHEREUSED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_USED | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | verwendetes Objekt | 20011207 | ||
| 2 | Returning |
RE_USERS | Value transfer | Type reference (TYPE) | SRM_LIST_OBJECT | Liste mit POIDs der Verwender | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_FRAMEWORK |
Framework (abstrakt) | 20011207 |
Method SET_WHEREUSED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_UPDATE_MODE | Call by reference | Type reference (TYPE) | STRING | IF_SRM=>DB_UPDATE | 20030512 | ||
| 2 | Importing |
IM_USED | Value transfer | Type reference (TYPE) | SRM_LIST_OBJECT | Verwendete Objekte | 20011207 | ||
| 3 | Importing |
IM_USER | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Verwender (z.B. Akte) | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_FRAMEWORK |
Framework (abstrakt) | 20011207 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 610 |
