SAP ABAP Interface IF_SWF_WFM_COMPONENT (WFM: Process Component)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BMT-WFM (Application Component) SAP Business Workflow
     ⤷ SWP (Package) Business Workflow: Processor

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SWF_WFM_COMPONENT	WFM Process Component	20030305

Properties

Interface	IF_SWF_WFM_COMPONENT
Short Description	WFM: Process Component

General Data

Package	SWP	Business Workflow: Processor
Created	20030305	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_SWF_WFM_COMPONENT has no forward declaration.

Interfaces

Interface IF_SWF_WFM_COMPONENT has no interface.

Friends

Interface IF_SWF_WFM_COMPONENT has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DESTROY_MODE_AFTER_COMMIT	Constant	Public	☐	Type reference (TYPE)	SWPCMPDM	'A'	Destructor Mode for WFM Components	20060530
2	C_DESTROY_MODE_CLEANUP	Constant	Public	☐	Type reference (TYPE)	SWPCMPDM	'C'	Destructor Mode for WFM Components	20031120
3	C_DESTROY_MODE_ROLLBACK	Constant	Public	☐	Type reference (TYPE)	SWPCMPDM	'R'	Destructor Mode for WFM Components	20031120
4	C_DESTROY_MODE_SYNC	Constant	Public	☐	Type reference (TYPE)	SWPCMPDM	'S'	Destructor Mode for WFM Components	20031120
5	M_COMPONENT_GUID	Instance attribute	Public	☐	Type reference (TYPE)	SWPCMPGUID			20030714

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_WIM_TRANSACTION	Instance method	Public	Method		20030905
2	CANCEL	Instance method	Public	Method	Cancel Request	20030714
3	CAST_WIM_COMPONENT	Instance method	Public	Method	CAST to Interface IF_SWF_WFM_COMPONENT_WIM	20030620
4	CHECK_EXCEPTION_CAUGHT	Instance method	Public	Method		20040114
5	DESTROY	Instance method	Public	Method	Destructor	20030707
6	DISPOSE_ENQUEUE	Instance method	Public	Method		20060102
7	GET_COMPONENT_TYPE	Instance method	Public	Method		20030328
8	GET_CONSISTENT_STATE	Instance method	Public	Method		20031219
9	GET_CONTAINER	Instance method	Public	Method	Container own WIM object or next highest-level	20030310
10	GET_GUID	Instance method	Public	Method	Gets GUID of component	20030320
11	GET_LOOP_INDEX	Instance method	Public	Method	Gets loop index of component	20040601
12	GET_NEXT_LOOP_COUNTER	Instance method	Public	Method	Gets current loop counter of next loop	20040601
13	GET_NEXT_NODE_STRATEGY	Instance method	Public	Method	Gets NEXT_NODE strategy handle	20030927
14	GET_NODEID	Instance method	Public	Method	Gets ID of (start) node	20030625
15	GET_NODE_HIERARCHY_DATA	Instance method	Public	Method		20030714
16	GET_PARENT	Instance method	Public	Method	Gets parent object	20030305
17	GET_PARFOREACH	Instance method	Public	Method	Gets next ParForEach component in hierarchy	20030825
18	GET_PARFOREACH_INDEX	Instance method	Public	Method	Gets ParForEach index of component	20030702
19	GET_RESULT	Instance method	Public	Method		20031104
20	GET_SAVE_AFTER_SYNC	Instance method	Public	Method		20060616
21	GET_WIM_CONTEXT	Instance method	Public	Method	Determines next complex WIM component	20031011
22	HAS_CHILD	Instance method	Public	Method	Checks whether transferred GUID is a child component	20030714
23	IS_CANCELLED	Instance method	Public	Method		20040129
24	IS_COMPLETED	Instance method	Public	Method		20040129
25	IS_NEW	Instance method	Public	Method		20040113
26	LOG_EXCEPTION	Instance method	Public	Method	Writes an exception to SWWLOGHIST	20040114
27	RAISE_EXCEPTION	Instance method	Public	Method		20031112
28	REGAIN_ENQUEUE	Instance method	Public	Method		20060102
29	RETRY_SET_FINAL_STATES	Instance method	Public	Method	Repeats setting work item to final status	20031021
30	ROLLBACK	Instance method	Public	Method		20031201
31	ROLLBACK_NEW	Instance method	Public	Method	New Rollback Method	20060616
32	SET_DISCARD_AT_CLEANUP	Instance method	Public	Method		20040202
33	SET_PARENT	Instance method	Public	Method	Sets parent of component	20030714
34	SET_STARTING_FLAG	Instance method	Public	Method	Flags the component as started	20031028
35	SET_SUSPEND_ERRORTYPE	Instance method	Public	Method	Sets error type for suspend	20031020
36	SYNC	Instance method	Public	Method	Synchronization Point	20030819

Events

#	Event	Type	Visibility	Description	Created on
1	COMPONENT_QUERY_FOR_GUID	Instance Event (0)	Public (2)		20030825

Types

Interface IF_SWF_WFM_COMPONENT has no local type.

Method Signatures

Method ADD_TO_WIM_TRANSACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PROPAGATE	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	allgemeines flag	20031120

Method ADD_TO_WIM_TRANSACTION on Interface IF_SWF_WFM_COMPONENT has no exception.

Method CANCEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_FAILURE_COUNTER	Value transfer	☑	Type reference (TYPE)	SYINDEX		Schleifen, aktueller Schleifendurchlauf	20040129
2	Importing	IM_CANCEL_ONLY_CHILDREN	Value transfer	☐	Type reference (TYPE)	FLAG	SPACE		20030917
3	Importing	IM_RETRY_MODE	Value transfer	☐	Type reference (TYPE)	FLAG	SPACE	allgemeines flag	20040129

Method CANCEL on Interface IF_SWF_WFM_COMPONENT has no exception.

Method CAST_WIM_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_COMPONENT_WIM	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWF_WFM_COMPONENT_WIM			20030620

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_EMPTY_RESULT	☐	WFM: Methode liefert kein Ergebnis	20031010

Method CHECK_EXCEPTION_CAUGHT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_EXCEPTION_NAME	Call by reference	☐	Type reference (TYPE)	SWD_LEVTNAM		char255	20040114
2	Returning	RE_EXCEPTION_CAUGHT	Value transfer	☐	Type reference (TYPE)	FLAG		allgemeines flag	20040114

Method CHECK_EXCEPTION_CAUGHT on Interface IF_SWF_WFM_COMPONENT has no exception.

Method DESTROY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE	Call by reference	☐	Type reference (TYPE)	SWPCMPDM		Destruktormodus für WFM-Komponenten	20031120
2	Importing	IM_PROPAGATED	Call by reference	☐	Type reference (TYPE)	FLAG	' '		20050201

Method DESTROY on Interface IF_SWF_WFM_COMPONENT has no exception.

Method DISPOSE_ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PROPAGATE	Value transfer	☐	Type reference (TYPE)	FLAG	'X'		20060102

Method DISPOSE_ENQUEUE on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_COMPONENT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_COMPONENT_CLASS	Value transfer	☐	Type reference (TYPE)	SWPCMPCLS			20030928
2	Exporting	EX_COMPONENT_TYPE	Value transfer	☐	Type reference (TYPE)	SWPCMPTYP			20030928
3	Exporting	EX_IS_LOOP	Value transfer	☐	Type reference (TYPE)	FLAG			20030928
4	Exporting	EX_IS_PARALLEL_SECTION	Value transfer	☐	Type reference (TYPE)	FLAG			20030928
5	Exporting	EX_WIM_COMPONENT	Value transfer	☐	Type reference (TYPE)	FLAG			20030928

Method GET_COMPONENT_TYPE on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_CONSISTENT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_METHOD	Call by reference	☐	Type reference (TYPE)	SWF_METNAM		Workflow: Methodenname	20031219
2	Returning	RE_CONSISTENT_STATE	Value transfer	☐	Type reference (TYPE)	SWPCONSTAT		WFM: konsistenter Zustand	20031219

Method GET_CONSISTENT_STATE on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PARFOREACH_INDEX	Call by reference	☑	Type reference (TYPE)	SWC_INDEX			20030626
2	Importing	IM_WIM_BINDING_SOURCE	Value transfer	☐	Type reference (TYPE)	FLAG	SPACE	allgemeines flag	20031118
3	Returning	RE_CONTAINER	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		$REF$	20030310

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM	☐	WFM: Ausnahme	20030715

Method GET_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_GUID	Value transfer	☐	Type reference (TYPE)	SWPCMPGUID			20030320

Method GET_GUID on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_LOOP_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_LOOP_INDEX	Value transfer	☐	Type reference (TYPE)	SWP_LOOPIND		WFM: Schleifenzähler eines Knotens	20040601

Method GET_LOOP_INDEX on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_NEXT_LOOP_COUNTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_LOOP_COUNTER	Value transfer	☐	Type reference (TYPE)	SWP_LOOPIND		WFM: Schleifenzähler eines Knotens	20040601

Method GET_NEXT_LOOP_COUNTER on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_NEXT_NODE_STRATEGY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NEXT_NODE_STRATEGY	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWF_WFM_NEXT_NODE_STRATEGY			20030927

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_SYSTEM	☐	WFM System-Ausnahme	20031010

Method GET_NODEID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NODEID	Value transfer	☐	Type reference (TYPE)	SWD_NODEID			20030625

Method GET_NODEID on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_NODE_HIERARCHY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_DATA	Value transfer	☐	Type reference (TYPE)	SWP_NODES			20030714

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_METHOD_ABSURD	☐	WFM: Methodenaufruf an konkreter Instanz unsinnig	20031010

Method GET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_PARENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWF_WFM_COMPONENT		$REF$	20030305

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_EMPTY_RESULT	☐	WFM: Methode liefert kein Ergebnis	20031010

Method GET_PARFOREACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_PARFOREACH	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_WFM_PARALLEL_DYNAMIC			20030825

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_EMPTY_RESULT	☐	WFM: Methode liefert kein Ergebnis	20031010

Method GET_PARFOREACH_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_PARFOREACH_INDEX	Value transfer	☐	Type reference (TYPE)	SWP_PARIND			20030702

Method GET_PARFOREACH_INDEX on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_RESULT		Workflow: Ergebnis	20031104

Method GET_RESULT on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_SAVE_AFTER_SYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_METHOD	Call by reference	☐	Type reference (TYPE)	SWF_METNAM			20060616
2	Returning	RE_SAVE_AFTER_SYNC	Value transfer	☐	Type reference (TYPE)	FLAG			20060616

Method GET_SAVE_AFTER_SYNC on Interface IF_SWF_WFM_COMPONENT has no exception.

Method GET_WIM_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_COMPONENT_TYPE	Value transfer	☐	Type reference (TYPE)	SWPCMPTYP			20031011
2	Exporting	EX_WIM_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_WFM_COMPONENT			20031011
3	Exporting	EX_WIM_CONTEXT_WIID	Call by reference	☐	Type reference (TYPE)	SWW_WIID			20031011

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_METHOD_ABSURD	☐	WFM: Methodenaufruf an konkreter Instanz unsinnig	20031011
2	CX_SWF_WFM_SYSTEM	☐	WFM System-Ausnahme	20031011

Method HAS_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMPONENT_GUID	Value transfer	☐	Type reference (TYPE)	SWPCMPGUID			20030714
2	Returning	RE_HAS_CHILD	Value transfer	☐	Type reference (TYPE)	FLAG			20030714

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_METHOD_ABSURD	☐	WFM: Methodenaufruf an konkreter Instanz unsinnig	20031010

Method IS_CANCELLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_CANCELLED	Value transfer	☐	Type reference (TYPE)	FLAG		allgemeines flag	20040129

Method IS_CANCELLED on Interface IF_SWF_WFM_COMPONENT has no exception.

Method IS_COMPLETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_COMPLETED	Value transfer	☐	Type reference (TYPE)	FLAG		allgemeines flag	20040129

Method IS_COMPLETED on Interface IF_SWF_WFM_COMPONENT has no exception.

Method IS_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_NEW	Value transfer	☐	Type reference (TYPE)	FLAG		allgemeines flag	20040113

Method IS_NEW on Interface IF_SWF_WFM_COMPONENT has no exception.

Method LOG_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_SWF_WFM		WFM: Ausnahme	20040114
2	Importing	IM_STAGE	Call by reference	☐	Type reference (TYPE)	SWPCMPEXST		WFM: Phase in der synchronen Queue	20040114

Method LOG_EXCEPTION on Interface IF_SWF_WFM_COMPONENT has no exception.

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DO_ROLLBACK	Call by reference	☑	Type reference (TYPE)	FLAG		allgemeines flag	20031201
2	Importing	IM_EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_SWF_WFM		WFM: Ausnahme	20040113
3	Importing	IM_RESULT	Call by reference	☑	Object reference (TYPE REF TO)	IF_SWF_RUN_RESULT		Workflow: Result	20031112
4	Importing	IM_RESULT_TYPE	Call by reference	☑	Type reference (TYPE)	SWF_RESTYP		Workflow: Resulttyp	20031112
5	Importing	IM_RESULT_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20031112

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_EXCEPTION_UNCAUGHT	☐	WFM: Nicht abgefangene Exception (Definition)	20031112
2	CX_SWF_WFM_WIM_RETURN_ERROR	☐	WFM: Exception für den WIM	20040114

Method REGAIN_ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PROPAGATE	Value transfer	☐	Type reference (TYPE)	FLAG	'X'		20060102

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM	☐	WFM: Ausnahme	20060102
2	CX_SWF_WFM_ENQUEUE_EXC	☐	WFM Fehler: Enqueue im WIM	20060102

Method RETRY_SET_FINAL_STATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_FAILURE_COUNTER	Value transfer	☑	Type reference (TYPE)	SYTABIX		Interne Tabellen, aktueller Zeilenindex	20040129
2	Importing	IM_CANCEL_ERROR	Call by reference	☑	Type reference (TYPE)	FLAG		allgemeines flag	20050518
3	Importing	IM_COMPLETION_ERROR	Call by reference	☑	Type reference (TYPE)	FLAG		allgemeines flag	20050518

Method RETRY_SET_FINAL_STATES on Interface IF_SWF_WFM_COMPONENT has no exception.

Method ROLLBACK Signature

Method ROLLBACK on Interface IF_SWF_WFM_COMPONENT has no parameter.
Method ROLLBACK on Interface IF_SWF_WFM_COMPONENT has no exception.

Method ROLLBACK_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SWPJOIN	Call by reference	☑	Type reference (TYPE)	SWP_JOIN			20060616
2	Importing	IM_SWPNODE	Call by reference	☑	Type reference (TYPE)	SWPNODE			20060616
3	Importing	IM_SWPNODEWI	Call by reference	☑	Type reference (TYPE)	SWP_NODEWI			20060616

Method ROLLBACK_NEW on Interface IF_SWF_WFM_COMPONENT has no exception.

Method SET_DISCARD_AT_CLEANUP Signature

Method SET_DISCARD_AT_CLEANUP on Interface IF_SWF_WFM_COMPONENT has no parameter.
Method SET_DISCARD_AT_CLEANUP on Interface IF_SWF_WFM_COMPONENT has no exception.

Method SET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20030714

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_SYSTEM	☐	WFM System-Ausnahme	20031010

Method SET_STARTING_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STARTING_FLAG	Call by reference	☐	Type reference (TYPE)	FLAG	'X'		20031028

Method SET_STARTING_FLAG on Interface IF_SWF_WFM_COMPONENT has no exception.

Method SET_SUSPEND_ERRORTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SUSPEND_ERRORTYPE	Call by reference	☐	Type reference (TYPE)	SWP_ERRTYP			20031020

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM_METHOD_ABSURD	☐	WFM: Methodenaufruf an konkreter Instanz unsinnig	20031020

Method SYNC Signature

Method SYNC on Interface IF_SWF_WFM_COMPONENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_WFM	☐		20070405

Event Signatures

Event COMPONENT_QUERY_FOR_GUID Signature
Event COMPONENT_QUERY_FOR_GUID on Interface IF_SWF_WFM_COMPONENT has no parameter.

History

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