SAP ABAP Class CL_BS_SOA_MESSAGE_CONTAINER (Message container)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-SOA (Application Component) Enterprise SOA
     ⤷ BS_SOA_REUSE_COMMON_OBJECTS (Package) Business Suite SOA: Reuseable Tools and Objects

Properties

Class	CL_BS_SOA_MESSAGE_CONTAINER
Short Description	Message container
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	BS_SOA_REUSE_COMMON_OBJECTS	Business Suite SOA: Reuseable Tools and Objects
Created	20081024	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BS_SOA_MESSAGE_CONTAINER has no forward declaration.

Interfaces

Class CL_BS_SOA_MESSAGE_CONTAINER has no interface implemented.

Friends

Class CL_BS_SOA_MESSAGE_CONTAINER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ABAP_FALSE	Constant	Protected	☐	Type reference (TYPE)	XFLAG	SPACE	false	20081024
2	ABAP_TRUE	Constant	Protected	☐	Type reference (TYPE)	XFLAG	'X'	true	20081024
3	CO_SEVERITY_CODE	Constant	Public	☐	See coding				20090326
4	GT_MESSAGE	Instance attribute	Protected	☐	Type reference (TYPE)	APPLMSGTAB		Message table	20081024
5	MS_MAIN_ERROR	Instance attribute	Protected	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20090810

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_APPLICATION_MESSAGES	Instance method	Public	Method	Add application message to container	20081024
2	ADD_BAPI_MESSAGE	Instance method	Public	Method	Add BAPI message to container	20081121
3	ADD_SMESG	Instance method	Public	Method	Add message of type SMESG to container	20090202
4	ADD_SY_MESSAGE	Instance method	Public	Method	Add system message to container	20081024
5	APPEND_APPLICATION_MESSAGE	Instance method	Public	Method	Append table of application messages to container	20081024
6	APPEND_BAPI_MESSAGE	Instance method	Public	Method	Append table of BAPI messages to container	20081024
7	APPEND_SMESG	Instance method	Public	Method	Append table of SMESG to container	20090202
8	GET_BAPI_MESSAGES	Instance method	Public	Method	Get BAPI messages	20090202
9	GET_MAIN_ERROR	Instance method	Public	Method	Get main error from memory	20090810
10	GET_MAX_SERVCODE	Instance method	Public	Method	Get maximum severity code 1<2<3<4	20090326
11	GET_MESSAGES	Instance method	Public	Method	Retrieve messages from container	20081024
12	GET_MESSAGE_BY_SERVCODE	Instance method	Public	Method	Get first message for severity code	20090408
13	GET_MESSAGE_FOR_MAX_SERVCODE	Instance method	Public	Method	Get first message for maximum severity code	20101129
14	GET_MSG_TEXT	Static method	Public	Method	Static: Get text from system message	20090807
15	HAS_ERROR	Instance method	Public	Method	Check if container has messages	20081024
16	REFRESH	Instance method	Public	Method	Refresh message container	20081024
17	REMOVE_MESSAGE	Instance method	Public	Method	Remove message from container	20090618
18	SET_ERROR_CATEGORY	Instance method	Protected	Method	Set error category to applmsg	20090810
19	SET_MAIN_ERROR	Instance method	Protected	Method	Set main error to memory	20090810
20	SORT_BY_SERVCODE	Static method	Protected	Method	Sort messages by severity code	20110208
21	SPLIT_MSG_TEXT	Static method	Public	Method	Static: split message text into message variables	20101126
22	S_GET_SY_MESSAGE	Static method	Public	Method	Static: get sy message as applmsg or bapireturn	20090401

Events

Class CL_BS_SOA_MESSAGE_CONTAINER has no event.

Types

Class CL_BS_SOA_MESSAGE_CONTAINER has no local type.

Method Signatures

Method ADD_APPLICATION_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MESSAGE	Call by reference	☐	Type reference (TYPE)	APPLMSG		Application message	20081024
2	Importing	IV_MAIN_ERROR	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20090810

Method ADD_APPLICATION_MESSAGES on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method ADD_BAPI_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BAPIRET	Call by reference	☐	Type reference (TYPE)	BAPIRET2		BAPI message	20081121
2	Importing	IV_ERR_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20090810
3	Importing	IV_MAIN_ERROR	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20090810

Method ADD_BAPI_MESSAGE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method ADD_SMESG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SMESG	Call by reference	☐	Type reference (TYPE)	SMESG		Message collector	20090202
2	Importing	IV_ERR_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20090810
3	Importing	IV_MAIN_ERROR	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20090810

Method ADD_SMESG on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method ADD_SY_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ERR_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20090213
2	Importing	IV_MAIN_ERROR	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20090810

Method ADD_SY_MESSAGE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method APPEND_APPLICATION_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MESSAGE	Call by reference	☐	Type reference (TYPE)	APPLMSGTAB		Table of application messages	20081024

Method APPEND_APPLICATION_MESSAGE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method APPEND_BAPI_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BAPIRET	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table of BAPI messages	20081024

Method APPEND_BAPI_MESSAGE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method APPEND_SMESG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SMESG	Call by reference	☐	Type reference (TYPE)	TSMESG		Message table message collector	20090202

Method APPEND_SMESG on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method GET_BAPI_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SORTED_BY_SEVTY_CODE	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20110208
2	Returning	RT_BAPI_MESSAGE	Value transfer	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20090202

Method GET_BAPI_MESSAGES on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method GET_MAIN_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_MAIN_ERROR	Value transfer	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20090810

Method GET_MAIN_ERROR on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method GET_MAX_SERVCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_MAX_SERVCODE	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20090326

Method GET_MAX_SERVCODE on class CL_BS_SOA_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_SORTED_BY_SEVTY_CODE	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20110208
2	Returning	RT_MESSAGE	Value transfer	☐	Type reference (TYPE)	APPLMSGTAB		Table for messages	20081024

Method GET_MESSAGES on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method GET_MESSAGE_BY_SERVCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SERVCODE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20090408
2	Returning	RS_MESSAGE	Value transfer	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20090408

Method GET_MESSAGE_BY_SERVCODE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method GET_MESSAGE_FOR_MAX_SERVCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WITH_TEXT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20101129
2	Returning	RS_MESSAGE	Value transfer	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20101129

Method GET_MESSAGE_FOR_MAX_SERVCODE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method GET_MSG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPLMSG	Call by reference	☑	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20101125
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	BAPI_MSG		Message Text	20090807

Method GET_MSG_TEXT on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method HAS_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO_INFORMATION	Call by reference	☑	Type reference (TYPE)	XFLAG		ignore information messages	20081024
2	Importing	I_NO_SUCCESS	Call by reference	☑	Type reference (TYPE)	XFLAG		Ignore success messages	20081024
3	Importing	I_NO_WARNING	Call by reference	☑	Type reference (TYPE)	XFLAG		Ignore warning messages	20081024
4	Returning	R_RESULT	Value transfer	☐	Type reference (TYPE)	XFLAG		Return indicator	20081024

Method HAS_ERROR on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method REFRESH Signature

Method REFRESH on class CL_BS_SOA_MESSAGE_CONTAINER has no parameter.
Method REFRESH on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method REMOVE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	SYMSGID			20090618
2	Importing	IV_MESSAGE_V1	Call by reference	☑	Type reference (TYPE)	SYMSGV			20090618
3	Importing	IV_MESSAGE_V2	Call by reference	☑	Type reference (TYPE)	SYMSGV			20090618
4	Importing	IV_MESSAGE_V3	Call by reference	☑	Type reference (TYPE)	SYMSGV			20090618
5	Importing	IV_MESSAGE_V4	Call by reference	☑	Type reference (TYPE)	SYMSGV			20090618
6	Importing	IV_NUMBER	Call by reference	☐	Type reference (TYPE)	SYMSGNO			20090618
7	Importing	IV_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY			20090618

Method REMOVE_MESSAGE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method SET_ERROR_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_MESSAGE	Call by reference	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20090810
2	Importing	IV_ERROR_CATEGORY	Call by reference	☐	Type reference (TYPE)	STRING			20090810

Method SET_ERROR_CATEGORY on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method SET_MAIN_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MAIN_ERROR	Call by reference	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20090810

Method SET_MAIN_ERROR on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method SORT_BY_SERVCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_APPLMSG	Call by reference	☐	Type reference (TYPE)	APPLMSGTAB		Return Table for Messages	20110208
2	Returning	RT_APPLMSG	Value transfer	☐	Type reference (TYPE)	APPLMSGTAB		Return Table for Messages	20110208

Method SORT_BY_SERVCODE on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method SPLIT_MSG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LOST_TEXT	Call by reference	☐	Type reference (TYPE)	SYMSGV		Message Variable	20101126
2	Exporting	EV_MSG_VAR1	Call by reference	☐	Type reference (TYPE)	SYMSGV		Message Variable	20101126
3	Exporting	EV_MSG_VAR2	Call by reference	☐	Type reference (TYPE)	SYMSGV		Message Variable	20101126
4	Exporting	EV_MSG_VAR3	Call by reference	☐	Type reference (TYPE)	SYMSGV		Message Variable	20101126
5	Exporting	EV_MSG_VAR4	Call by reference	☐	Type reference (TYPE)	SYMSGV		Message Variable	20101126
6	Importing	IV_MSG_TEXT	Call by reference	☐	Type reference (TYPE)	BAPI_MSG		Message Text	20101126

Method SPLIT_MSG_TEXT on class CL_BS_SOA_MESSAGE_CONTAINER has no exception.

Method S_GET_SY_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_APPLMSG	Call by reference	☐	Type reference (TYPE)	APPLMSG		Return Structure for Messages	20090401
2	Exporting	ES_BAPIRETURN	Call by reference	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20090401
3	Importing	IV_ERR_CATEGORY	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20090401

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Integration: Application Error	20090401

History

Last changed by/on	SAP	20110908
SAP Release Created in	702