SAP ABAP Class CL_WS_MESSAGE (Handling of Messages with Errors)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
     ⤷ SOAP_WS_MESSAGE (Package) Access to WS Message

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WS_MESSAGE	Handling of Messages with Errors	20060109

Properties

Class	CL_WS_MESSAGE
Short Description	Handling of Messages with Errors
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAP_WS_MESSAGE	Access to WS Message
Created	20060109	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	TSOAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_WS_MESSAGE	☐	☐	Handling of Messages with Errors	20060109

Friends

#	Friend	Modeled only	Created on	Description
1	CL_WS_MESSAGING_FACTORY	☐	20060109	Create Instances for Messages with Errors
2	CL_WS_MESSAGING_FACTORY_IN	☐	20080901	Internal Payload API

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SOAP_CONTEXT		Context for SOAP Call	20060109
2	LOCK_SERVICE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRT_MESSAGE_LOCK_SERVICE		Lock/Unlock Messages	20060212
3	MESSAGE_ID	Instance attribute	Private	☐	Type reference (TYPE)	SRTMSGID		Message ID in SOAP Runtime	20060217
4	PAYLOAD	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING		Payload	20060123
5	PERSIST_ID	Instance attribute	Private	☐	Type reference (TYPE)	SXMS_PERSIST_ID		Persist ID	20060109
6	VERSION	Instance attribute	Private	☐	Type reference (TYPE)	SXMSLSQNBR		Version number	20071203
7	VERSION_SUPPLIED	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN	TSOAP_FALSE	Version number provided when instance created?	20071203

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_PAYLOAD	Instance method	Private	Method		20060209
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060109
3	GET_PAYLOAD	Instance method	Private	Method		20060123
4	GET_REQUEST_PART	Instance method	Private	Method	Gets Request Part Object	20060802
5	SAVE	Instance method	Private	Method		20060123
6	SAVE_PAYLOAD_UPDTSK	Instance method	Public	Method	Save Payload from Update Module (Internal)	20060808
7	SET_CHANGE_MODE	Instance method	Private	Method		20060123
8	SET_PAYLOAD	Instance method	Private	Method		20060123
9	SET_READ_ONLY_MODE	Instance method	Private	Method		20060123
10	SET_STATE_INTERNAL	Instance method	Private	Method	Sets Message State	20060804
11	SET_STATE_UPDTSK	Instance method	Public	Method	Sets Message Status from Update Module (Internal)	20060808
12	USER_RESTORE	Static method	Public	Method	Restores user before RFC (RBAM-privileged mode)	20080403

Events

Class CL_WS_MESSAGE has no event.

Types

Class CL_WS_MESSAGE has no local type.

Method Signatures

Method CHECK_PAYLOAD Signature

Method CHECK_PAYLOAD on class CL_WS_MESSAGE has no parameter.
Method CHECK_PAYLOAD on class CL_WS_MESSAGE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE_ID	Value transfer	☑	Type reference (TYPE)	SRTMSGID		Message Id in SOAP Runtime	20060217
2	Importing	PERSIST_ID	Value transfer	☐	Type reference (TYPE)	SXMS_PERSIST_ID		Persist-Id	20060109
3	Importing	VERSION	Value transfer	☑	Type reference (TYPE)	SXMSLSQNBR		Versionsnummer	20071203

#	Exception	Resumable	Description	Created on
1	CX_WS_NO_MESSAGE	☐	Error	20071203

Method GET_PAYLOAD Signature

Method GET_PAYLOAD on class CL_WS_MESSAGE has no parameter.
Method GET_PAYLOAD on class CL_WS_MESSAGE has no exception.

Method GET_REQUEST_PART Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REQUEST_PART	Value transfer	☐	Object reference (TYPE REF TO)	IF_SXMLP_PART		Request Part in deserialisierter Form	20060802

Method GET_REQUEST_PART on class CL_WS_MESSAGE has no exception.

Method SAVE Signature

Method SAVE on class CL_WS_MESSAGE has no parameter.
Method SAVE on class CL_WS_MESSAGE has no exception.

Method SAVE_PAYLOAD_UPDTSK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	XML10_DOCUMENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Payload als XML 1.0 Fragment in UTF-8 Kodierung	20060808

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_INTERNAL	☐	interne Ausnahmen der WS Message Verarbeitung	20060808
2	CX_WS_MESSAGE_USAGE	☐	Fehler in der Verwendung	20060808

Method SET_CHANGE_MODE Signature

Method SET_CHANGE_MODE on class CL_WS_MESSAGE has no parameter.
Method SET_CHANGE_MODE on class CL_WS_MESSAGE has no exception.

Method SET_PAYLOAD Signature

Method SET_PAYLOAD on class CL_WS_MESSAGE has no parameter.
Method SET_PAYLOAD on class CL_WS_MESSAGE has no exception.

Method SET_READ_ONLY_MODE Signature

Method SET_READ_ONLY_MODE on class CL_WS_MESSAGE has no parameter.
Method SET_READ_ONLY_MODE on class CL_WS_MESSAGE has no exception.

Method SET_STATE_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATE	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Status der Message	20060804

Method SET_STATE_INTERNAL on class CL_WS_MESSAGE has no exception.

Method SET_STATE_UPDTSK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATE	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Status der Message	20060808

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_USAGE	☐	Fehler in der Verwendung	20060808

Method USER_RESTORE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	USER_PRESERVE	Call by reference	☐	Type reference (TYPE)	SRT_WS_MSG_USER_PRESERVE		Structure for data for "user preserve and restore"	20080403

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_SYSTEM	☐	System-related error in WS message processing	20080403

History

Last changed by/on	SAP	20130531
SAP Release Created in	710