SAP ABAP Interface /IWFND/IF_MGW_MSG_CONTAINER (GW ODC Message Container Interface)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-GW-COR (Application Component) Gateway Framework
     ⤷ /IWFND/MGW_SUPPORTABILITY (Package) GW Framework - ODC - Message Container and Logging

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/IWFND/CL_MGW_MSG_CONTAINER	ODC Message Container	20110711

Properties

Interface	/IWFND/IF_MGW_MSG_CONTAINER
Short Description	GW ODC Message Container Interface

General Data

Package	/IWFND/MGW_SUPPORTABILITY	GW Framework - ODC - Message Container and Logging
Created	20110711	SAP
Last changed	20141120
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWFND/IF_MGW_MSG_CONTAINER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface /IWFND/IF_MGW_MSG_CONTAINER has no interface.

Friends

Interface /IWFND/IF_MGW_MSG_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	20110711
2	GCS_EXCEPTION_CATEGORY	Constant	Public	☐	See coding				20131016
3	GCS_MESSAGE_TYPE	Constant	Public	☐	See coding			Constants for the message type	20110711
4	GCS_SEVERITY	Constant	Public	☐	See coding				20110726

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ERRROR_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	20110711
3	ADD_MESSAGES_FROM_BAPI	Instance method	Public	Method	Adds messages of type BAPIRET2 to the message container	20110711
4	ADD_MESSAGES_FROM_CONTAINER	Instance method	Public	Method	Adds messages of another Message Container	20110711
5	ADD_MESSAGES_FROM_MGW_TAB	Instance method	Public	Method	Adds messages of an backend message table	20110714
6	ADD_MESSAGE_FROM_EXCEPTION	Instance method	Public	Method	Adds the exception text as error message	20110711
7	ADD_MESSAGE_FROM_LOG_ITEM	Instance method	Public	Method	Adds a Webservice LOG Item to the message container	20110711
8	ADD_MESSAGE_TEXT_ONLY	Instance method	Public	Method	Adds an error message text without a corresponding message	20110711
9	GET_ERROR_DETAILS	Instance method	Public	Method	Get list of error details for the OData Inner Error section	20131014
10	GET_HAS_LEADING_MESSAGE	Instance method	Public	Method	Returns if there is a leading message or not	20110711
11	GET_HAS_WARNINGS	Instance method	Public	Method	TRUE if there are messages to be returned to a client	20131016
12	GET_LEADING_MESSAGE_TEXT	Instance method	Public	Method	Returns the text of leading message if exists, else INITIAL	20110711
13	GET_MESSAGES	Instance method	Public	Method	Returns the list of all messages - Message text can be empty	20110711
14	GET_MESSAGES_AS_LOG_ITEMS	Instance method	Public	Method	Returns the list of all messages in log item format	20110711
15	GET_WORST_MESSAGE_TYPE	Instance method	Public	Method	Returns the type of the "worst" message (A > E > W > I > S)	20110711

Events

Interface /IWFND/IF_MGW_MSG_CONTAINER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_DETAIL_CODE	Public	Type reference (TYPE)	CHAR80	Char 80	20110725
2	TY_DETAIL_MESSAGE	Public	Type reference (TYPE)	STRING		20110725
3	TY_DETAIL_PROPERTY_REFERENCE	Public	Type reference (TYPE)	STRING		20110725
4	TY_DETAIL_SEVERITY	Public	Type reference (TYPE)	CHAR20	Char 20	20110725
5	TY_ERROR_CATEGORY	Public	Type reference (TYPE)	CHAR15	Char 15	20110725
6	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_ERRROR_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)	/IWFND/IF_MGW_MSG_CONTAINER=>TY_S_ERROR_DETAIL			20110725

Method ADD_ERRROR_DETAIL on Interface /IWFND/IF_MGW_MSG_CONTAINER has no exception.

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ENTITY	Call by reference	☑	Type reference (TYPE)	ANY			20110711
2	Importing	IV_ENTITY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20110711
3	Importing	IV_ERROR_CATEGORY	Call by reference	☐	Type reference (TYPE)	CHAR15	GCS_ERROR_CATEGORY-PROCESSING	Error category - defined by GCS_ERROR_CATEGORY	20110711
4	Importing	IV_IS_EXTERNAL_MESSAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110805
5	Importing	IV_IS_LEADING_MESSAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Flags this message as the leading error message	20110711
6	Importing	IV_MESSAGE_CREATOR	Call by reference	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT		Name of the Component which created the message	20110711
7	Importing	IV_MSG_ID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20110711
8	Importing	IV_MSG_NUMBER	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20110711
9	Importing	IV_MSG_TEXT	Call by reference	☑	Type reference (TYPE)	BAPI_MSG		Message Text	20110711
10	Importing	IV_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type - defined by GCS_MESSAGE_TYPE	20110711
11	Importing	IV_MSG_V1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20110711
12	Importing	IV_MSG_V2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20110711
13	Importing	IV_MSG_V3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20110711
14	Importing	IV_MSG_V4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20110711
15	Importing	IV_SYSTEM_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWFND/DEFI_SYSTEM_ALIAS		SAP System Alias	20110711

Method ADD_MESSAGE on Interface /IWFND/IF_MGW_MSG_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_ENTITY	Call by reference	☑	Type reference (TYPE)	ANY			20110711
2	Importing	IT_BAPI_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Table of BAPIRET2 messages	20110711
3	Importing	IV_ENTITY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20110711
4	Importing	IV_ERROR_CATEGORY	Call by reference	☐	Type reference (TYPE)	CHAR15	GCS_ERROR_CATEGORY-PROCESSING	Error category - defined by GCS_ERROR_CATEGORY	20110711
5	Importing	IV_MESSAGE_CREATOR	Call by reference	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT		Name of the Component which created the message	20110711
6	Importing	IV_SYSTEM_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWFND/DEFI_SYSTEM_ALIAS		SAP System Alias	20110711

Method ADD_MESSAGES_FROM_BAPI on Interface /IWFND/IF_MGW_MSG_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_MGW_MSG_CONTAINER		IWF Message Container Interface	20110711

Method ADD_MESSAGES_FROM_CONTAINER on Interface /IWFND/IF_MGW_MSG_CONTAINER has no exception.

Method ADD_MESSAGES_FROM_MGW_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MSG_CONTAINER_HEADER	Call by reference	☐	Type reference (TYPE)	/IWFND/S_MESSAGE_CONTAINER_H		Message Container Header Data	20110715
2	Importing	IT_MSG_CONTAINER	Call by reference	☐	Type reference (TYPE)	/IWFND/T_MGW_MESSAGE_CONTAINER		Message Container Data Table	20110714

Method ADD_MESSAGES_FROM_MGW_TAB on Interface /IWFND/IF_MGW_MSG_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	20110711
2	Importing	IS_ENTITY	Call by reference	☑	Type reference (TYPE)	ANY			20110711
3	Importing	IV_ENTITY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Entity Type	20110711
4	Importing	IV_ERROR_CATEGORY	Call by reference	☐	Type reference (TYPE)	CHAR15	GCS_ERROR_CATEGORY-PROCESSING	Error category - defined by GCS_ERROR_CATEGORY	20110711
5	Importing	IV_IS_LEADING_MESSAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flags this message as the leading error message	20110711
6	Importing	IV_LOG_TO_ERROR_LOG	Call by reference	☐	Type reference (TYPE)	XSDBOOLEAN	ABAP_TRUE	'X': Always write to Error Log	20121204
7	Importing	IV_MESSAGE_CREATOR	Call by reference	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT		Name of the Component which created the message	20110711
8	Importing	IV_SYSTEM_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWFND/DEFI_SYSTEM_ALIAS		SAP System Alias	20110711

Method ADD_MESSAGE_FROM_EXCEPTION on Interface /IWFND/IF_MGW_MSG_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_ENTITY	Call by reference	☑	Type reference (TYPE)	ANY			20110711
2	Importing	IS_LOG_ITEM_FIELDS	Call by reference	☐	Type reference (TYPE)	/IWFND/S_MECO_LOG_ITEM		Fields of a Log Item	20110711
3	Importing	IV_ENTITY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20110711
4	Importing	IV_ERROR_CATEGORY	Call by reference	☐	Type reference (TYPE)	CHAR15	GCS_ERROR_CATEGORY-PROCESSING	Error category - defined by GCS_ERROR_CATEGORY	20110711
5	Importing	IV_MESSAGE_CREATOR	Call by reference	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT		Name of the Component which created the message	20110711
6	Importing	IV_SYSTEM_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWFND/DEFI_SYSTEM_ALIAS		SAP System Alias	20110711

Method ADD_MESSAGE_FROM_LOG_ITEM on Interface /IWFND/IF_MGW_MSG_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_ENTITY	Call by reference	☑	Type reference (TYPE)	ANY			20110711
2	Importing	IV_ENTITY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20110711
3	Importing	IV_ERROR_CATEGORY	Call by reference	☐	Type reference (TYPE)	CHAR15	GCS_ERROR_CATEGORY-PROCESSING	Error category - defined by GCS_ERROR_CATEGORY	20110711
4	Importing	IV_IS_LEADING_MESSAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Flags this message as the leading error message	20110711
5	Importing	IV_MESSAGE_CREATOR	Call by reference	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT		Name of the Component which created the message	20110711
6	Importing	IV_MSG_TEXT	Call by reference	☐	Type reference (TYPE)	BAPI_MSG		Message Text	20110711
7	Importing	IV_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type - defined by GCS_MESSAGE_TYPE	20110711
8	Importing	IV_SYSTEM_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWFND/DEFI_SYSTEM_ALIAS		SAP System Alias	20110711

Method ADD_MESSAGE_TEXT_ONLY on Interface /IWFND/IF_MGW_MSG_CONTAINER has no exception.

Method GET_ERROR_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ERROR_DETAILS	Value transfer	☐	Type reference (TYPE)	/IWFND/T_MGW_ODATA_INNER_ERROR		OData Inner Error	20131014

Method GET_ERROR_DETAILS on Interface /IWFND/IF_MGW_MSG_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	20110711

Method GET_HAS_LEADING_MESSAGE on Interface /IWFND/IF_MGW_MSG_CONTAINER has no exception.

Method GET_HAS_WARNINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HAS_WARNINGS	Value transfer	☐	Type reference (TYPE)	BOOLE		TRUE if there are warnings, FALSE otherwise	20131016

Method GET_HAS_WARNINGS on Interface /IWFND/IF_MGW_MSG_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	20110711

Method GET_LEADING_MESSAGE_TEXT on Interface /IWFND/IF_MGW_MSG_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	20110711
2	Returning	RT_MESSAGES	Value transfer	☐	Type reference (TYPE)	/IWFND/T_MECO_MESSAGE		Message table for "Message Container"	20110711

Method GET_MESSAGES on Interface /IWFND/IF_MGW_MSG_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"	20110711

Method GET_MESSAGES_AS_LOG_ITEMS on Interface /IWFND/IF_MGW_MSG_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	20110711

Method GET_WORST_MESSAGE_TYPE on Interface /IWFND/IF_MGW_MSG_CONTAINER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	250