SAP ABAP Interface /IWFND/IF_MESSAGE_CONTAINER (GW Message Container Interface)
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-FND-CS (Application Component) IWF Common Services
⤷
/IWFND/COS_MESSAGE_CONTAINER (Package) GW Framework - Message Container
SAP_GWFND (Software Component) SAP Gateway Foundation⤷
OPU-FND-CS (Application Component) IWF Common Services⤷
/IWFND/COS_MESSAGE_CONTAINER (Package) GW Framework - Message Container
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWFND/CL_MESSAGE_CONTAINER | Message Container | 20090723 |
Properties
| Interface | /IWFND/IF_MESSAGE_CONTAINER | |
| Short Description | GW Message Container Interface |
General Data
| Package | /IWFND/COS_MESSAGE_CONTAINER | GW Framework - Message Container |
| Created | 20090723 | SAP |
| Last changed | 20131127 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface /IWFND/IF_MESSAGE_CONTAINER has no interface.
Friends
Interface /IWFND/IF_MESSAGE_CONTAINER has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GCS_ERROR_CATEGORY | Constant | Public | See coding | Constants for the error category | 20090723 | |||
| 2 | GCS_MESSAGE_TYPE | Constant | Public | See coding | Constants for the message type | 20090723 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_MESSAGE |
Instance method | Public | Method | Adds an error message | 20090723 |
| 2 | ADD_MESSAGES_FROM_BAPI |
Instance method | Public | Method | Adds messages of type BAPIRET2 to the message container | 20090811 |
| 3 | ADD_MESSAGES_FROM_CONTAINER |
Instance method | Public | Method | Adds messages of another Message Container | 20090811 |
| 4 | ADD_MESSAGE_FROM_EXCEPTION |
Instance method | Public | Method | Adds the exception text as error message | 20090723 |
| 5 | ADD_MESSAGE_FROM_LOG_ITEM |
Instance method | Public | Method | Adds a Webservice LOG Item to the message container | 20090824 |
| 6 | ADD_MESSAGE_TEXT_ONLY |
Instance method | Public | Method | Adds an error message text without a corresponding message | 20100126 |
| 7 | GET_HAS_LEADING_MESSAGE |
Instance method | Public | Method | Returns if there is a leading message or not | 20100430 |
| 8 | GET_LEADING_MESSAGE_TEXT |
Instance method | Public | Method | Returns the text of leading message if exists, else INITIAL | 20090902 |
| 9 | GET_MESSAGES |
Instance method | Public | Method | Returns the list of all messages - Message text can be empty | 20090727 |
| 10 | GET_MESSAGES_AS_LOG_ITEMS |
Instance method | Public | Method | Returns the list of all messages in log item format | 20090915 |
| 11 | GET_WORST_MESSAGE_TYPE |
Instance method | Public | Method | Returns the type of the "worst" message (A > E > W > I > S) | 20090902 |
Events
Interface /IWFND/IF_MESSAGE_CONTAINER has no event.
Types
Interface /IWFND/IF_MESSAGE_CONTAINER has no local type.
Method Signatures
Method ADD_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IS_OBJECT_KEY | Call by reference | Type reference (TYPE) | /IWFND/S_COR_ID | ID of the object whose proccessing caused the errors | 20090728 | ||
| 2 | Importing |
IV_ERROR_CATEGORY | Call by reference | Type reference (TYPE) | CHAR15 | GCS_ERROR_CATEGORY-PROCESSING | Error category - defined by GCS_ERROR_CATEGORY | 20090723 | |
| 3 | Importing |
IV_IS_EXTERNAL_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20110718 | ||
| 4 | Importing |
IV_IS_LEADING_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Flags this message as the leading error message | 20090723 | |
| 5 | Importing |
IV_MESSAGE_CREATOR | Call by reference | Type reference (TYPE) | /IWFND/SUP_IW_AGENT | Name of the Component which created the message | 20090811 | ||
| 6 | Importing |
IV_MSG_ID | Call by reference | Type reference (TYPE) | SYMSGID | Message Class | 20090723 | ||
| 7 | Importing |
IV_MSG_NUMBER | Call by reference | Type reference (TYPE) | SYMSGNO | Message Number | 20090723 | ||
| 8 | Importing |
IV_MSG_TEXT | Call by reference | Type reference (TYPE) | BAPI_MSG | Message Text | 20090723 | ||
| 9 | Importing |
IV_MSG_TYPE | Call by reference | Type reference (TYPE) | SYMSGTY | Message Type - defined by GCS_MESSAGE_TYPE | 20090723 | ||
| 10 | Importing |
IV_MSG_V1 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20090723 | ||
| 11 | Importing |
IV_MSG_V2 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20090723 | ||
| 12 | Importing |
IV_MSG_V3 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20090723 | ||
| 13 | Importing |
IV_MSG_V4 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20090723 |
Method ADD_MESSAGE on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method ADD_MESSAGES_FROM_BAPI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_OBJECT_KEY | Call by reference | Type reference (TYPE) | /IWFND/S_COR_ID | ID of the object whose proccessing caused the errors | 20090811 | ||
| 2 | Importing |
IT_BAPI_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRET2_T | Table of BAPIRET2 messages | 20090811 | ||
| 3 | Importing |
IV_ERROR_CATEGORY | Call by reference | Type reference (TYPE) | CHAR15 | GCS_ERROR_CATEGORY-PROCESSING | Error category - defined by GCS_ERROR_CATEGORY | 20090811 | |
| 4 | Importing |
IV_MESSAGE_CREATOR | Call by reference | Type reference (TYPE) | /IWFND/SUP_IW_AGENT | Name of the Component which created the message | 20090811 |
Method ADD_MESSAGES_FROM_BAPI on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method ADD_MESSAGES_FROM_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGE_CONTAINER | Call by reference | Object reference (TYPE REF TO) | /IWFND/IF_MESSAGE_CONTAINER | IWF Message Container Interface | 20090811 |
Method ADD_MESSAGES_FROM_CONTAINER on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method ADD_MESSAGE_FROM_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_EXCEPTION | Call by reference | Object reference (TYPE REF TO) | /IWFND/CX_BASE | IWFND Base Exception | 20090723 | ||
| 2 | Importing |
IS_OBJECT_KEY | Call by reference | Type reference (TYPE) | /IWFND/S_COR_ID | ID of the object whose proccessing caused the errors | 20090728 | ||
| 3 | Importing |
IV_ERROR_CATEGORY | Call by reference | Type reference (TYPE) | CHAR15 | GCS_ERROR_CATEGORY-PROCESSING | Error category - defined by GCS_ERROR_CATEGORY | 20090723 | |
| 4 | Importing |
IV_IS_LEADING_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Flags this message as the leading error message | 20090917 | |
| 5 | Importing |
IV_LOG_TO_ERROR_LOG | Call by reference | Type reference (TYPE) | XSDBOOLEAN | ABAP_TRUE | 'X': Always write to Error Log | 20121204 | |
| 6 | Importing |
IV_MESSAGE_CREATOR | Call by reference | Type reference (TYPE) | /IWFND/SUP_IW_AGENT | Name of the Component which created the message | 20090811 |
Method ADD_MESSAGE_FROM_EXCEPTION on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method ADD_MESSAGE_FROM_LOG_ITEM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_LOG_ITEM_FIELDS | Call by reference | Type reference (TYPE) | /IWFND/S_MECO_LOG_ITEM | Fields of a Log Item | 20090824 | ||
| 2 | Importing |
IS_OBJECT_KEY | Call by reference | Type reference (TYPE) | /IWFND/S_COR_ID | ID of the object whose proccessing caused the errors | 20090824 | ||
| 3 | Importing |
IV_ERROR_CATEGORY | Call by reference | Type reference (TYPE) | CHAR15 | GCS_ERROR_CATEGORY-PROCESSING | Error category - defined by GCS_ERROR_CATEGORY | 20090824 | |
| 4 | Importing |
IV_MESSAGE_CREATOR | Call by reference | Type reference (TYPE) | /IWFND/SUP_IW_AGENT | Name of the Component which created the message | 20090824 |
Method ADD_MESSAGE_FROM_LOG_ITEM on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method ADD_MESSAGE_TEXT_ONLY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_OBJECT_KEY | Call by reference | Type reference (TYPE) | /IWFND/S_COR_ID | ID of the object whose proccessing caused the errors | 20100126 | ||
| 2 | Importing |
IV_ERROR_CATEGORY | Call by reference | Type reference (TYPE) | CHAR15 | GCS_ERROR_CATEGORY-PROCESSING | Error category - defined by GCS_ERROR_CATEGORY | 20100126 | |
| 3 | Importing |
IV_IS_LEADING_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Flags this message as the leading error message | 20100126 | |
| 4 | Importing |
IV_MESSAGE_CREATOR | Call by reference | Type reference (TYPE) | /IWFND/SUP_IW_AGENT | Name of the Component which created the message | 20100126 | ||
| 5 | Importing |
IV_MSG_TEXT | Call by reference | Type reference (TYPE) | BAPI_MSG | Message Text | 20100126 | ||
| 6 | Importing |
IV_MSG_TYPE | Call by reference | Type reference (TYPE) | SYMSGTY | Message Type - defined by GCS_MESSAGE_TYPE | 20100126 |
Method ADD_MESSAGE_TEXT_ONLY on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method GET_HAS_LEADING_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RV_HAS_LEADING_MESSAGE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE if there is leading message, ABAP_FALSE otherwise | 20100430 |
Method GET_HAS_LEADING_MESSAGE on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method GET_LEADING_MESSAGE_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_MESSAGE_TEXT | Value transfer | Type reference (TYPE) | BAPI_MSG | Message Text | 20090902 |
Method GET_LEADING_MESSAGE_TEXT on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method GET_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PROVIDE_TEXT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | If true the message texts will be filled | 20090825 | |
| 2 | Returning |
RT_MESSAGES | Value transfer | Type reference (TYPE) | /IWFND/T_MECO_MESSAGE | Message table for "Message Container" | 20090727 |
Method GET_MESSAGES on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method GET_MESSAGES_AS_LOG_ITEMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_LOG_ITEMS | Value transfer | Type reference (TYPE) | /IWFND/T_MECO_LOG_ITEM | Log item table for "Message Container" | 20090915 |
Method GET_MESSAGES_AS_LOG_ITEMS on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
Method GET_WORST_MESSAGE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_MESSAGE_TYPE | Value transfer | Type reference (TYPE) | SYMSGTY | Message Type - defined by GCS_MESSAGE_TYPE | 20090902 |
Method GET_WORST_MESSAGE_TYPE on Interface /IWFND/IF_MESSAGE_CONTAINER has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 100 |
