SAP ABAP Interface /IWBEP/IF_MESSAGE_CONTAINER (Message Container Interface)
Hierarchy
☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement
     ⤷ /IWBEP/MGW_GSR_CORE (Package) OData Channel - Service Interface - Core
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  /IWBEP/CL_MGW_MSG_CONTAINER Message Container (for Client messages) 20110707
Properties
Interface /IWBEP/IF_MESSAGE_CONTAINER  
Short Description Message Container Interface    
General Data
Package /IWBEP/MGW_GSR_CORE   OData Channel - Service Interface - Core 
Created 20110706   SAP 
Last changed 20141120    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /IWBEP/CL_MGW_MSG_CONTAINER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 /IWBEP/CX_MGW_BASE_EXCEPTION Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 /IWBEP/IF_MESSAGE_CONTAINER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
4 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Interface /IWBEP/IF_MESSAGE_CONTAINER has no interface.
Friends
Interface /IWBEP/IF_MESSAGE_CONTAINER has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CS_SEVERITY Constant Public See coding 20110725
2 GCS_ERROR_CATEGORY Constant Public See coding 20110706
3 GCS_EXCEPTION_CATEGORY Constant Public See coding 20110714
4 GCS_LEADING_MSG_SEARCH_OPTION Constant Public See coding 20110719
5 GCS_MESSAGE_TYPE Constant Public See coding 20110706
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ERROR_DETAIL Instance method Public Method Add error detail to the OData Inner Error section 20110725
2 ADD_MESSAGE Instance method Public Method Adds an error message 20110706
3 ADD_MESSAGES_FROM_BAPI Instance method Public Method Adds messages of type BAPIRET2 to the message container 20110706
4 ADD_MESSAGES_FROM_CONTAINER Instance method Public Method Adds messages of another Message Container 20110706
5 ADD_MESSAGES_FROM_LOG Instance method Public Method Adds messages of type BAL_S_MSG to the message container 20110713
6 ADD_MESSAGE_FROM_EXCEPTION Instance method Public Method Adds the exception text as error message 20110706
7 ADD_MESSAGE_TEXT_ONLY Instance method Public Method Adds an error message text without a corresponding message 20110706
8 GET_HAS_LEADING_MESSAGE Instance method Public Method Returns if there is a leading message or not 20110706
9 GET_LEADING_MESSAGE_TEXT Instance method Public Method Returns the text of leading message if exists, else INITIAL 20110706
10 GET_MESSAGES Instance method Public Method Returns the list of all messages - Message text can be empty 20110706
11 GET_WORST_MESSAGE_TYPE Instance method Public Method Returns the type of the "worst" message (A > E > W > I > S) 20110706
Events
Interface /IWBEP/IF_MESSAGE_CONTAINER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_BAL_T_MSG Public See coding 20110713 ty_bal_t_msg TYPE STANDARD TABLE OF bal_s_msg
2 TY_DETAIL_CODE Public Type reference (TYPE) CHAR80 Char 80 20110725
3 TY_DETAIL_MESSAGE Public Type reference (TYPE) STRING 20110725
4 TY_DETAIL_PROPERTY_REFERENCE Public Type reference (TYPE) STRING 20110725
5 TY_DETAIL_SEVERITY Public Type reference (TYPE) CHAR20 Char 20 20110725
6 TY_ERROR_CATEGORY Public Type reference (TYPE) CHAR15 Char 15 20110722
7 TY_LEADING_MSG_FLAG Public Type reference (TYPE) CHAR1 Single-Character Indicator 20110722
8 TY_S_ERROR_DETAIL Public See coding 20110725 BEGIN OF ty_s_error_detail, code TYPE ty_detail_code, message_text TYPE ty_detail_message, severity TYPE ty_detail_severity, property_reference TYPE ty_detail_property_reference, END OF ty_s_error_detail
Method Signatures

Method ADD_ERROR_DETAIL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ERROR_DETAIL Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_S_ERROR_DETAIL Error detail 20110725

Method ADD_ERROR_DETAIL on Interface /IWBEP/IF_MESSAGE_CONTAINER has no exception.

Method ADD_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_KEY_TAB Call by reference Type reference (TYPE) /IWBEP/T_MGW_NAME_VALUE_PAIR Entity key as name-value pair 20110714
2 Importing IV_ADD_TO_RESPONSE_HEADER Call by reference Type reference (TYPE) /IWBEP/SUP_MC_ADD_TO_RESPONSE ABAP_FALSE Flag for adding or not the message to the response header 20131008
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type/name 20110714
4 Importing IV_ERROR_CATEGORY Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_ERROR_CATEGORY /IWBEP/IF_MESSAGE_CONTAINER=>GCS_ERROR_CATEGORY-PROCESSING Error Category 20110707
5 Importing IV_IS_LEADING_MESSAGE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20110707
6 Importing IV_MESSAGE_TARGET Call by reference Type reference (TYPE) /IWBEP/SUP_MC_MESSAGE_TARGET Target (reference) (e.g. Property ID) of a message 20131014
7 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYMSGID Message Class 20110707
8 Importing IV_MSG_NUMBER Call by reference Type reference (TYPE) SYMSGNO Message Number 20110707
9 Importing IV_MSG_TEXT Call by reference Type reference (TYPE) BAPI_MSG Message Text 20110707
10 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type 20110707
11 Importing IV_MSG_V1 Call by reference Type reference (TYPE) SYMSGV Message Variable 20110707
12 Importing IV_MSG_V2 Call by reference Type reference (TYPE) SYMSGV Message Variable 20110707
13 Importing IV_MSG_V3 Call by reference Type reference (TYPE) SYMSGV Message Variable 20110707
14 Importing IV_MSG_V4 Call by reference Type reference (TYPE) SYMSGV Message Variable 20110707

Method ADD_MESSAGE on Interface /IWBEP/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 IT_BAPI_MESSAGES Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20110707
2 Importing IT_KEY_TAB Call by reference Type reference (TYPE) /IWBEP/T_MGW_NAME_VALUE_PAIR Entity key as name-value pair 20110714
3 Importing IV_ADD_TO_RESPONSE_HEADER Call by reference Type reference (TYPE) /IWBEP/SUP_MC_ADD_TO_RESPONSE ABAP_FALSE Flag for adding or not the message to the response header 20131008
4 Importing IV_DETERMINE_LEADING_MSG Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_LEADING_MSG_FLAG /IWBEP/IF_MESSAGE_CONTAINER=>GCS_LEADING_MSG_SEARCH_OPTION-NONE Use no/first/last as leading message 20110719
5 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type/name 20110714
6 Importing IV_ERROR_CATEGORY Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_ERROR_CATEGORY /IWBEP/IF_MESSAGE_CONTAINER=>GCS_ERROR_CATEGORY-PROCESSING Error Category 20110707

Method ADD_MESSAGES_FROM_BAPI on Interface /IWBEP/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) /IWBEP/IF_MESSAGE_CONTAINER Message Container Interface 20110707

Method ADD_MESSAGES_FROM_CONTAINER on Interface /IWBEP/IF_MESSAGE_CONTAINER has no exception.

Method ADD_MESSAGES_FROM_LOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_KEY_TAB Call by reference Type reference (TYPE) /IWBEP/T_MGW_NAME_VALUE_PAIR Entity key as name-value pair 20110714
2 Importing IT_LOG_MESSAGES Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_BAL_T_MSG 20110713
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type/name 20110714
4 Importing IV_ERROR_CATEGORY Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_ERROR_CATEGORY /IWBEP/IF_MESSAGE_CONTAINER=>GCS_ERROR_CATEGORY-PROCESSING Error category 20110713

Method ADD_MESSAGES_FROM_LOG on Interface /IWBEP/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) /IWBEP/CX_MGW_BASE_EXCEPTION Base Exception 20110707
2 Importing IT_KEY_TAB Call by reference Type reference (TYPE) /IWBEP/T_MGW_NAME_VALUE_PAIR Entity key as name-value pair 20110714
3 Importing IV_ADD_TO_RESPONSE_HEADER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Flag for adding or not the message to the response header 20131008
4 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type/name 20110714
5 Importing IV_ERROR_CATEGORY Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_ERROR_CATEGORY /IWBEP/IF_MESSAGE_CONTAINER=>GCS_ERROR_CATEGORY-PROCESSING Error Category 20110707
6 Importing IV_IS_LEADING_MESSAGE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20110707
7 Importing IV_MESSAGE_TARGET Call by reference Type reference (TYPE) /IWBEP/SUP_MC_MESSAGE_TARGET Target (reference) (e.g. Property ID) of a message 20131015

Method ADD_MESSAGE_FROM_EXCEPTION on Interface /IWBEP/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 IT_KEY_TAB Call by reference Type reference (TYPE) /IWBEP/T_MGW_NAME_VALUE_PAIR Entity key as name-value pair 20110714
2 Importing IV_ADD_TO_RESPONSE_HEADER Call by reference Type reference (TYPE) /IWBEP/SUP_MC_ADD_TO_RESPONSE ABAP_FALSE Flag for adding or not the message to the response header 20131008
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type/name 20110714
4 Importing IV_ERROR_CATEGORY Call by reference Type reference (TYPE) /IWBEP/IF_MESSAGE_CONTAINER=>TY_ERROR_CATEGORY /IWBEP/IF_MESSAGE_CONTAINER=>GCS_ERROR_CATEGORY-PROCESSING Error category - defined by GCS_ERROR_CATEGORY 20110707
5 Importing IV_IS_LEADING_MESSAGE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Flags this message as the leading error message 20110707
6 Importing IV_MESSAGE_TARGET Call by reference Type reference (TYPE) /IWBEP/SUP_MC_MESSAGE_TARGET Target (reference) (e.g. Property ID) of a message 20131015
7 Importing IV_MSG_TEXT Call by reference Type reference (TYPE) BAPI_MSG Message Text 20110707
8 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type - defined by GCS_MESSAGE_TYPE 20110707

Method ADD_MESSAGE_TEXT_ONLY on Interface /IWBEP/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 20110707

Method GET_HAS_LEADING_MESSAGE on Interface /IWBEP/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 20110707

Method GET_LEADING_MESSAGE_TEXT on Interface /IWBEP/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 20110707
2 Returning RT_MESSAGES Value transfer Type reference (TYPE) /IWBEP/T_MESSAGE_CONTAINER Message Container Data Table 20110707

Method GET_MESSAGES on Interface /IWBEP/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 20110707

Method GET_WORST_MESSAGE_TYPE on Interface /IWBEP/IF_MESSAGE_CONTAINER has no exception.
History
Last changed by/on SAP  20141120 
SAP Release Created in 200