SAP ABAP Interface IF_SRM_REQUEST (Interface for Request)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_CLIENTFRAME_WIN (Package) Records Management: Wingui Client Framework
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SRM_REQUEST | Request Object | 20010507 |
Properties
| Interface | IF_SRM_REQUEST | |
| Short Description | Interface for Request |
General Data
| Package | SRM_CLIENTFRAME_WIN | Records Management: Wingui Client Framework |
| Created | 20010507 | SAP |
| Last changed | 20041208 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | SRMIF | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface IF_SRM_REQUEST has no interface.
Friends
Interface IF_SRM_REQUEST has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVITY_CANCELED_BY_USER | Constant | Public | Type reference (TYPE) | I | 104 | Activity terminated by user | 20010507 | |
| 2 | ACTIVITY_ERROR | Constant | Public | Type reference (TYPE) | I | 102 | Error: Activity could not be executed | 20010507 | |
| 3 | ACTIVITY_FINISHED_WITH_OK | Constant | Public | Type reference (TYPE) | I | 100 | Activity executed successfully | 20010507 | |
| 4 | ACTIVITY_INITIAL | Constant | Public | Type reference (TYPE) | I | 0 | Activity not yet started | 20010507 | |
| 5 | ACTIVITY_INVALID_DEST | Constant | Public | Type reference (TYPE) | I | 103 | Activity successfully executed, target invalid | 20010507 | |
| 6 | ACTIVITY_NOT_AUTHORIZED | Constant | Public | Type reference (TYPE) | I | 106 | No authorization for activity | 20010808 | |
| 7 | ACTIVITY_NOT_SUPPORTED | Constant | Public | Type reference (TYPE) | I | 105 | Activity not supported by target SP | 20010808 | |
| 8 | ACTIVITY_ONGOING | Constant | Public | Type reference (TYPE) | I | 101 | Asynchronous activity still being executed | 20010507 | |
| 9 | ACTIVITY_QUERY_FINISHED_OK | Constant | Public | Type reference (TYPE) | I | 108 | Search ended with result | 20010816 | |
| 10 | ACTIVITY_QUERY_NOTHING_FOUND | Constant | Public | Type reference (TYPE) | I | 107 | The search has not found anything | 20010816 | |
| 11 | PARA_EXPORTING | Constant | Public | Type reference (TYPE) | I | 2 | Exporting parameter | 20030130 | |
| 12 | PARA_IMPORTING | Constant | Private | Type reference (TYPE) | I | 1 | Importing parameter | 20030130 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add Error Output (for BSP Only) | 20030206 | |
| 2 | Instance method | Public | Method | Gets activity | 20010507 | |
| 3 | Instance method | Public | Method | Gets completion status of activity | 20010507 | |
| 4 | Instance method | Public | Method | Gets Dest POID | 20010507 | |
| 5 | Instance method | Public | Method | List of Error Messages in Request Processing | 20030206 | |
| 6 | Instance method | Public | Method | Gets Parameter | 20030130 | |
| 7 | Instance method | Public | Method | Gets Request ID | 20010507 | |
| 8 | Instance method | Public | Method | Gets result | 20010808 | |
| 9 | Instance method | Public | Method | Get 'result is visible' flag from request | 20010827 | |
| 10 | Instance method | Public | Method | Gets Source POID | 20010507 | |
| 11 | Instance method | Public | Method | Read Update Mode (IF_SRM=>DB_UPDATE...) | 20020426 | |
| 12 | Instance method | Public | Method | Sets activity | 20010507 | |
| 13 | Instance method | Public | Method | Sets completion status of activity | 20010507 | |
| 14 | Instance method | Public | Method | Sets Dest POID | 20010507 | |
| 15 | Instance method | Public | Method | Sets a Parameter | 20030130 | |
| 16 | Instance method | Public | Method | Sets Request ID | 20010507 | |
| 17 | Instance method | Public | Method | Sets result | 20010808 | |
| 18 | Instance method | Public | Method | Set 'result is visible' flag | 20010827 | |
| 19 | Instance method | Public | Method | Sets Source POID | 20010507 | |
| 20 | Instance method | Public | Method | Sets Update Mode (IF_SRM=>DB_UPDATE...) | 20020426 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | STATE_CHANGED | Instance Event (0) |
Public (2) |
Status of activity has been changed | 20010507 |
Types
Interface IF_SRM_REQUEST has no local type.
Method Signatures
Method ADD_ERROR_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_ID | Call by reference | Type reference (TYPE) | STRING | Nachrichtenklasse | 20030206 | |||
| 2 | IM_MESSAGE_V1 | Call by reference | Type reference (TYPE) | STRING | Nachrichtenvariable | 20030206 | |||
| 3 | IM_MESSAGE_V2 | Call by reference | Type reference (TYPE) | STRING | Nachrichtenvariable | 20030206 | |||
| 4 | IM_MESSAGE_V3 | Call by reference | Type reference (TYPE) | STRING | Nachrichtenvariable | 20030206 | |||
| 5 | IM_MESSAGE_V4 | Call by reference | Type reference (TYPE) | STRING | Nachrichtenvariable | 20030206 | |||
| 6 | IM_NUMBER | Call by reference | Type reference (TYPE) | STRING | Nachrichtennummer | 20030206 | |||
| 7 | IM_TYPE | Call by reference | Type reference (TYPE) | STRING | Nachrichtentyp | 20030206 |
Method ADD_ERROR_MESSAGE on Interface IF_SRM_REQUEST has no exception.
Method GET_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVITY | Value transfer | Type reference (TYPE) | SRMACTID | Aktivität | 20010507 |
Method GET_ACTIVITY on Interface IF_SRM_REQUEST has no exception.
Method GET_ACTIVITY_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVITY_STATE | Value transfer | Type reference (TYPE) | SRMIF_SP_ACTIVITY_STATE | Erledigungszustand der Aktivität | 20010507 |
Method GET_ACTIVITY_STATE on Interface IF_SRM_REQUEST has no exception.
Method GET_DEST_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DEST_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Dest POID | 20010507 |
Method GET_DEST_POID on Interface IF_SRM_REQUEST has no exception.
Method GET_ERROR_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_MSG_LIST | Value transfer | Type reference (TYPE) | SRM_LIST_ERRMSG | Liste mit Fehlermeldungen | 20030206 |
Method GET_ERROR_MESSAGES on Interface IF_SRM_REQUEST has no exception.
Method GET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_ID | Call by reference | Type reference (TYPE) | STRING | Parameter-ID | 20030130 | |||
| 2 | RE_VALUE | Value transfer | Object reference (TYPE REF TO) | IF_SRM_ATTRIBUTE_VALUE | Parameter-Wert | 20030130 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Framework (abstrakt) | 20030130 |
Method GET_REQUEST_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | REQUEST_ID | Value transfer | Type reference (TYPE) | SRMREQID | Request ID | 20010507 |
Method GET_REQUEST_ID on Interface IF_SRM_REQUEST has no exception.
Method GET_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Speziell: POID | 20010808 |
Method GET_RESULT on Interface IF_SRM_REQUEST has no exception.
Method GET_RESULT_IS_VISIBLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_RESULT_IS_VISIBLE | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Das Ergebnis ist sichtbar | 20010827 |
Method GET_RESULT_IS_VISIBLE on Interface IF_SRM_REQUEST has no exception.
Method GET_SOURCE_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SOURCE_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Source POID | 20010507 |
Method GET_SOURCE_POID on Interface IF_SRM_REQUEST has no exception.
Method GET_UPDATE_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_UPDATE_MODE | Value transfer | Type reference (TYPE) | STRING | Update Mode (IF_SRM=>DB_UPDATE...) | 20020426 |
Method GET_UPDATE_MODE on Interface IF_SRM_REQUEST has no exception.
Method SET_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVITY | Value transfer | Type reference (TYPE) | SRMACTID | Aktivität | 20010507 |
Method SET_ACTIVITY on Interface IF_SRM_REQUEST has no exception.
Method SET_ACTIVITY_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVITY_STATE | Value transfer | Type reference (TYPE) | SRMIF_SP_ACTIVITY_STATE | Erledigungszustand der Aktivität | 20010507 |
Method SET_ACTIVITY_STATE on Interface IF_SRM_REQUEST has no exception.
Method SET_DEST_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DEST_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Dest POID | 20010507 |
Method SET_DEST_POID on Interface IF_SRM_REQUEST has no exception.
Method SET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_ID | Call by reference | Type reference (TYPE) | STRING | Parameter ID | 20030130 | |||
| 2 | IM_VALUE | Call by reference | Object reference (TYPE REF TO) | IF_SRM_ATTRIBUTE_VALUE | Parameter Wert | 20030130 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20030130 |
Method SET_REQUEST_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | REQUEST_ID | Value transfer | Type reference (TYPE) | SRMREQID | Request ID | 20010507 |
Method SET_REQUEST_ID on Interface IF_SRM_REQUEST has no exception.
Method SET_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Speziell: POID | 20010808 |
Method SET_RESULT on Interface IF_SRM_REQUEST has no exception.
Method SET_RESULT_IS_VISIBLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_RESULT_IS_VISIBLE | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Result ist sichtbar | 20010827 |
Method SET_RESULT_IS_VISIBLE on Interface IF_SRM_REQUEST has no exception.
Method SET_SOURCE_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SOURCE_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Source POID | 20010507 |
Method SET_SOURCE_POID on Interface IF_SRM_REQUEST has no exception.
Method SET_UPDATE_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_UPDATE_MODE | Call by reference | Type reference (TYPE) | STRING | IF_SRM=>DB_UPDATE... | 20020426 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20020426 |
Event Signatures
Event STATE_CHANGED Signature
Event STATE_CHANGED on Interface IF_SRM_REQUEST has no parameter.
History
| Last changed by/on | SAP | 20041208 |
| SAP Release Created in | 620 |