SAP ABAP Interface IF_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 - Used By

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

Properties

Interface	IF_WS_MESSAGE
Short Description	Handling of Messages with Errors

General Data

Package	SOAP_WS_MESSAGE	Access to WS Message
Created	20060109	SAP
Last changed	20090618	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)
2	IF_WS_MESSAGE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	TSOAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_WS_MESSAGE has no interface.

Friends

Interface IF_WS_MESSAGE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_SAVE_MODE_IMMEDIATELY	Constant	Public	☐	Type reference (TYPE)	SAVE_MODE	'IMMEDIATELY'	Save Now (in Current Process)	20060809
2	CO_SAVE_MODE_IN_UPDATE_TASK	Constant	Public	☐	Type reference (TYPE)	SAVE_MODE	'IN_UPDATE_TASK'	Save in Update	20060809
3	CO_STATE_APPL_ERROR	Constant	Public	☐	Type reference (TYPE)	STATE	'APPLICATION_ERROR'	Processed with application error; modifiable	20060426
4	CO_STATE_CANCELLED	Constant	Public	☐	Type reference (TYPE)	STATE	'CANCELLED'	Processed with errors and closed	20060215
5	CO_STATE_CHANGED_MANUALLY	Constant	Public	☐	Type reference (TYPE)	STATE	'CHANGED_MANUALLY'	Changed Manually	20060214
6	CO_STATE_FINISHED	Constant	Public	☐	Type reference (TYPE)	STATE	'FINISHED'	Processed successfully and closed	20060215
7	CO_STATE_IN_ERROR	Constant	Public	☐	Type reference (TYPE)	STATE	'IN_ERROR'	Processed with errors and can be changed	20060215
8	CO_STATE_NOT_EXISTING	Constant	Public	☐	Type reference (TYPE)	STATE	'NOT_EXISTING'	Not existent	20060224
9	CO_STATE_RELEASED	Constant	Public	☐	Type reference (TYPE)	STATE	'RELEASED'	Released for Message Processing	20060222
10	CO_STATE_SYSTEM_ERROR	Constant	Public	☐	Type reference (TYPE)	STATE	'SYSTEM_ERROR'	Processed with system error; modifiable	20060426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_PAYLOAD	Instance method	Public	Method	Checks specified or currently set payload	20060123
2	DESERIALIZE_PAYLOAD	Instance method	Public	Method	Sends ABAP Data References for Current Payload	20060802
3	GET_MESSAGE_ID	Instance method	Public	Method	Gets Message ID	20070122
4	GET_PAYLOAD	Instance method	Public	Method	Gets Payload (First Subnode of SOAP Body)	20060123
5	GET_PERSIST_ID	Instance method	Public	Method	Gets Persist ID of Message	20070122
6	GET_STATE	Instance method	Public	Method	Gets Status of Message	20060123
7	GET_VERSION	Instance method	Public	Method	Gets version of message instance	20071213
8	RESTART	Instance method	Public	Method	Reschedules Corresponding Sequence	20060202
9	RESTART_IMMEDIATELY	Instance method	Public	Method	Direct Start of Corresponding Sequence	20060202
10	SAVE	Instance method	Public	Method	Saves Messages	20060123
11	SET_CHANGE_MODE	Instance method	Public	Method	Switches to Change Mode	20060123
12	SET_PAYLOAD	Instance method	Public	Method	Writes Payload (First Subnode of SOAP Body)	20060123
13	SET_READ_ONLY_MODE	Instance method	Public	Method	Switches to Display Mode	20060123
14	SET_STATE	Instance method	Public	Method	Sets Message State	20060804
15	SKIP_AND_RESTART	Instance method	Public	Method	Skips Message and Reschedules Sequence	20060330

Events

Interface IF_WS_MESSAGE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ERROR_TEXTS	Public	See coding		List of Error Texts of Nested Error Objects	20060130	ERROR_TEXTS type standard table of STRING WITH DEFAULT KEY
2	SAVE_MODE	Public	Type reference (TYPE)	SRT_WS_MESSAGE_SAVE_MODE	Save Mode for Database Changes	20060809
3	STATE	Public	Type reference (TYPE)	SRT_WS_MESSAGE_STATE	State of WS Message	20060123

Method Signatures

Method CHECK_PAYLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ERROR_TEXTS	Value transfer	☐	Type reference (TYPE)	ERROR_TEXTS		Liste der Fehlertexte der geschachtelten Fehlerobjekte	20060130
2	Importing	XML10_DOCUMENT	Call by reference	☑	Type reference (TYPE)	XSTRING		Payload als XML 1.0 Fragment in UTF-8 Kodierung	20060209

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_PAYLOAD	☐	Fehler bei der Payload-Verarbeitung	20060210
2	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060214

Method DESERIALIZE_PAYLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DATA_REFERENCES	Value transfer	☐	Type reference (TYPE)	ABAP_TRANS_RESBIND_TAB			20060802

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_PAYLOAD	☐	Fehler bei der Payload-Verarbeitung	20060807
2	CX_WS_MESSAGE_SYSTEM	☐	systembedingte Fehler bei der WS Message-Verarbeitung	20060807
3	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060809

Method GET_MESSAGE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MESSAGE_ID	Value transfer	☐	Type reference (TYPE)	SRTMSGID		Message Id in SOAP Runtime	20070122

Method GET_MESSAGE_ID on Interface IF_WS_MESSAGE has no exception.

Method GET_PAYLOAD Signature

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

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_PAYLOAD	☐	Fehler bei der Payload-Verarbeitung	20060210
2	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060209

Method GET_PERSIST_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PERSIST_ID	Value transfer	☐	Type reference (TYPE)	SXMS_PERSIST_ID		Persist-Id	20070122

Method GET_PERSIST_ID on Interface IF_WS_MESSAGE has no exception.

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATE	Value transfer	☐	Type reference (TYPE)	STATE		Status einer WS Message	20060123

#	Exception	Resumable	Description	Created on
1	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060123

Method GET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VERSION	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Version der Message Instanz	20071213

Method GET_VERSION on Interface IF_WS_MESSAGE has no exception.

Method RESTART Signature

Method RESTART on Interface IF_WS_MESSAGE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_AUTHORITY	☐	Missing authorization	20090116
2	CX_WS_MESSAGE_LOCKING	☐	Ausnahme bei der Sperr-Behandlung	20060215
3	CX_WS_MESSAGE_SYSTEM	☐	Fehler bei RFC-Aufruf	20060215
4	CX_WS_MESSAGE_WRONG_STATE	☐	Operation im aktuellen Message Status nicht erlaubt	20060212
5	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060212

Method RESTART_IMMEDIATELY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_RFC	Call by reference	☐	Type reference (TYPE)	BOOLEAN	TSOAP_FALSE	Kennzeichen für Aufruf ohne RFC	20070126

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_AUTHORITY	☐	Missing authorization	20090116
2	CX_WS_MESSAGE_LOCKING	☐	Ausnahme bei der Sperr-Behandlung	20060215
3	CX_WS_MESSAGE_SYSTEM	☐	Fehler bei RFC-Aufruf	20060215
4	CX_WS_MESSAGE_WRONG_STATE	☐	Operation im aktuellen Message Status nicht erlaubt	20060212
5	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060212

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SAVE_MODE	Call by reference	☑	Type reference (TYPE)	SAVE_MODE	CO_SAVE_MODE_IN_UPDATE_TASK	Modus zur Sicherung von Änderungen auf der Datenbank	20060809

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_PAYLOAD	☐	Fehler bei der Payload-Verarbeitung	20060214
2	CX_WS_MESSAGE_USAGE	☐	Fehler in der Verwendung	20060212

Method SET_CHANGE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MESSAGE_OUTDATED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		gesetzt, falls die Message nachgelesen werden muss	20060212

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_LOCKING	☐	Ausnahme bei der Sperr-Behandlung	20060123
2	CX_WS_MESSAGE_WRONG_STATE	☐	Operation im aktuellen Message Status nicht erlaubt	20060212
3	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060123

Method SET_PAYLOAD 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	20060123

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_PAYLOAD	☐	Fehler bei der Payload-Verarbeitung	20060210
2	CX_WS_MESSAGE_USAGE	☐	Fehler in der Verwendung	20060210

Method SET_READ_ONLY_MODE Signature

Method SET_READ_ONLY_MODE on Interface IF_WS_MESSAGE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060123

Method SET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SAVE_MODE	Call by reference	☑	Type reference (TYPE)	SAVE_MODE	CO_SAVE_MODE_IN_UPDATE_TASK	Modus zur Sicherung von Änderungen auf der Datenbank	20060809
2	Importing	STATE	Call by reference	☐	Type reference (TYPE)	STATE		Status einer WS Message	20060804

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_USAGE	☐	Fehler in der Verwendung	20060804
2	CX_WS_MESSAGE_WRONG_STATE	☐	Operation im aktuellen Message Status nicht erlaubt	20060804

Method SKIP_AND_RESTART Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_RFC	Call by reference	☐	Type reference (TYPE)	BOOLEAN	TSOAP_FALSE	Kennzeichen für Aufruf ohne RFC	20070126

#	Exception	Resumable	Description	Created on
1	CX_WS_MESSAGE_LOCKING	☐	Ausnahme bei der Sperr-Behandlung	20060330
2	CX_WS_MESSAGE_SYSTEM	☐	Fehler bei RFC-Aufruf	20060330
3	CX_WS_MESSAGE_WRONG_STATE	☐	Operation im aktuellen Message Status nicht erlaubt	20060330
4	CX_WS_NO_MESSAGE	☐	Message existiert nicht	20060330

History

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