SAP ABAP Class CL_SWF_XI_PAYLOAD_EDITING (Utilities for Payload Editor)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-BPE (Application Component) Business Process Engine
     ⤷ SWF_XI_ADAPTER (Package) Workflow Adapter for XI

Properties

Class	CL_SWF_XI_PAYLOAD_EDITING
Short Description	Utilities for Payload Editor
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWF_XI_ADAPTER	Workflow Adapter for XI
Created	20060811	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_SWF_XI_PAYLOAD_EDITING has no interface implemented.

Friends

Class CL_SWF_XI_PAYLOAD_EDITING has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_EDITING_ALLOWED	Constant	Public	☐	Type reference (TYPE)	TY_EDITING_ALLOWED	5	Unrestricted Editing Permitted	20060823
2	CO_EDITING_ENQ_FAILED	Constant	Public	☐	Type reference (TYPE)	TY_EDITING_ALLOWED	1	Editing not possible, read from or lock failed	20060824
3	CO_EDITING_NOT_ALLOWED	Constant	Public	☐	Type reference (TYPE)	TY_EDITING_ALLOWED	0	Editing not possible, no process in required status	20060811
4	CO_EDITING_NO_PE_MESSAGE	Constant	Public	☐	Type reference (TYPE)	TY_EDITING_ALLOWED	3	Editing not possible, message is not a PE message	20060823
5	CO_EDITING_OBSOLETE	Constant	Public	☐	Type reference (TYPE)	TY_EDITING_ALLOWED	2	Editing obsolete, all processes already completed	20060811
6	CO_LOG_METHOD	Constant	Private	☐	Type reference (TYPE)	SWF_METNAM	'SWF_XI_MESSAGE_EDITED'	Log Function Module	20060823
7	MT_WI_HANDLES	Instance attribute	Private	☐	Type reference (TYPE)	SWWTWIHNDL		Work item handles of checked process instances	20060811
8	M_LAST_ERROR	Instance attribute	Private	☐	Type reference (TYPE)	SWF_T100MS		Last Error	20060911
9	M_LAST_EXCEPTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_XMS_SYSERR_BPE		Last Exception for Editability	20060911
10	M_MESSAGE_XMB	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB		Message to be processed	20060811
11	M_XI_INSTANCE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_XI_INSTANCE		XI_Instance object	20060811

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYZE_PROCESS_STATUS	Instance method	Private	Method	Checking Whether Processes Used Can Be Edited	20060823
2	AUTHORITY_CHECK	Instance method	Public	Method	Checks Authorization	20060911
3	CALL_BROWSER_WITH_SSO	Instance method	Public	Method	Calls Editor URL with SSO Using HTML Control	20060911
4	CHECK_ALLOWED	Instance method	Private	Method	Checking Whether Editing Is Permitted	20060811
5	CONSTRUCTOR	Instance method	Public	Constructor		20060811
6	CREATE_FROM_GUID	Static method	Public	Method	Creates Objects By Using a Message GUID	20060824
7	CREATE_FROM_XMB	Static method	Public	Method	Creates Objects from XMB Message	20060811
8	FINALIZE	Instance method	Public	Method	Clean-up work such as lock release, call after commit	20060823
9	GET_EDITOR_URL	Instance method	Public	Method	Gets Payload Editor URL	20060811
10	GET_LAST_ERROR	Instance method	Public	Method	Gets Error Message for Editability Status	20060911
11	GET_PROCESSES	Instance method	Private	Method	Gets processes that contain the XI object	20060823
12	GET_UPDATE_EXCEPTION	Instance method	Private	Method	Gets Exception for Last Editability Check	20060911
13	INVALIDATE_BUFFER	Instance method	Public	Method	Invalidates Buffer for Edited Message as a Precaution	20060911
14	IS_EDITING_ALLOWED	Instance method	Public	Method	Checks the editing scope permitted for the message	20060811
15	UPDATE_MESSAGE	Instance method	Public	Method	Updates message copy and message proxy	20060811
16	WRITE_LOG_MESSAGE	Instance method	Private	Method	Writing information to log of transferred process	20060823

Events

Class CL_SWF_XI_PAYLOAD_EDITING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_EDITING_ALLOWED	Public	Type reference (TYPE)	I		20060811

Method Signatures

Method ANALYZE_PROCESS_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_OBSOLETE	Call by reference	☐	Type reference (TYPE)	XFLAG		'X', falls kein Prozess in Status, der Bearbeiten erfordert	20060823
2	Importing	IM_WI_HANDLES	Call by reference	☐	Type reference (TYPE)	SWWTWIHNDL		Laufzeitobjekte der zu untersuchenden Prozesse	20060823

Method ANALYZE_PROCESS_STATUS on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method AUTHORITY_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_SUCCESS	Value transfer	☐	Type reference (TYPE)	XFLAG		'X', falls Berechtigung vorliegt	20060911

Method AUTHORITY_CHECK on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method CALL_BROWSER_WITH_SSO Signature

Method CALL_BROWSER_WITH_SSO on class CL_SWF_XI_PAYLOAD_EDITING has no parameter.

#	Exception	Resumable	Description	Created on
1	CALL_FAILED	☐		20060911

Method CHECK_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ALLOWED	Call by reference	☐	Type reference (TYPE)	XFLAG		'X' falls Bearbeitung erlaubt	20060811
2	Exporting	EX_ENQ_FAILED_WI	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Prozess, der nicht gelesen oder gesperrt werden konnte	20060824
3	Exporting	EX_HANDLES	Call by reference	☐	Type reference (TYPE)	SWWTWIHNDL		Workitem-Handles zu den Prozessinstanzen	20060811
4	Importing	IM_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	XFLAG		'X' fordert Sperre auf Workitem an	20060811
5	Importing	IM_PROCESSES	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Zu untersuchende Prozessinstanzen	20060811

Method CHECK_ALLOWED on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MESSAGE_XMB	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB		Zu bearbeitende Nachricht	20060811

#	Exception	Resumable	Description	Created on
1	CX_SWF_XI_EXCEPTION	☐	XI-Ausnahme	20060824

Method CREATE_FROM_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MESSAGE_GUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20060824
2	Returning	RE_PAYLOAD_EDITING	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_XI_PAYLOAD_EDITING		Payload Editor; NOT BOUND, falls Message nicht verfügbar	20060824

Method CREATE_FROM_GUID on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method CREATE_FROM_XMB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MESSAGE_XMB	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB		Zu bearbeitende Message	20060811
2	Returning	RE_EDITING	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_XI_PAYLOAD_EDITING		Bearbeitungsklasse	20060811

Method CREATE_FROM_XMB on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method FINALIZE Signature

Method FINALIZE on class CL_SWF_XI_PAYLOAD_EDITING has no parameter.
Method FINALIZE on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method GET_EDITOR_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL zum Aufruf des Editors, leer falls Konfigurationsfehler	20060822

Method GET_EDITOR_URL on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method GET_LAST_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_MESSAGE	Value transfer	☐	Type reference (TYPE)	SWF_T100MS		Struktur für T100 Meldung	20060911

Method GET_LAST_ERROR on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method GET_PROCESSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_PROCESSES	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Prozesse, in denen das Objekt vorkommt	20060823
2	Importing	IM_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_XI_INSTANCE		XI-Objekt, dessen Verwendung geprüft wird	20060823

Method GET_PROCESSES on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method GET_UPDATE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ALLOW_RESULT	Call by reference	☐	Type reference (TYPE)	TY_EDITING_ALLOWED		Ergebnis der Bearbeitbarkeitsprüfung	20060911
2	Importing	IM_ENQ_FAILED_WI	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem mit fehlgeschlagener Sperre	20060911
3	Returning	RE_EXCEPTION	Value transfer	☐	Object reference (TYPE REF TO)	CX_XMS_SYSERR_BPE		Zugehörige Exception	20060911

Method GET_UPDATE_EXCEPTION on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method INVALIDATE_BUFFER Signature

Method INVALIDATE_BUFFER on class CL_SWF_XI_PAYLOAD_EDITING has no parameter.
Method INVALIDATE_BUFFER on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method IS_EDITING_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ALLOWED	Call by reference	☐	Type reference (TYPE)	TY_EDITING_ALLOWED		Umfang, in dem Bearbeiten erlaubt ist	20060811
2	Exporting	EX_ENQ_FAILED_WI	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Prozess, der nicht gesperrt oder gelesen werden konnte	20060824
3	Exporting	EX_PROCESSES	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Prozesse, deren Status Bearbeitbarkeit bestimmt	20060811
4	Importing	IM_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	XFLAG	SPACE	'X', falls Bearbeitung folgt (prüft/holt Sperren)	20060823

Method IS_EDITING_ALLOWED on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

Method UPDATE_MESSAGE Signature

Method UPDATE_MESSAGE on class CL_SWF_XI_PAYLOAD_EDITING has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSERR_BPE	☐	XI: Systemfehler BPE	20060823

Method WRITE_LOG_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_WI_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_RUN_WIM_INTERNAL		Prozess, in dessen Log geschrieben wird	20060823

Method WRITE_LOG_MESSAGE on class CL_SWF_XI_PAYLOAD_EDITING has no exception.

History

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