SAP ABAP Class CL_SWR_WI_MASS_API_LOC (Work Item API Manager (Mass-Capable))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BMT-WFM (Application Component) SAP Business Workflow
     ⤷ SWF_SWR (Package) Workflow: Internal Implementation for API Layer

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SWR_API_BASE	Basis Class for APIs	20100216
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SWR_API_REMOTE_INTERNAL	Basis Interface for Internal Functions	20100303
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SWR_WI_MASS_API_INTERNAL	Internal Interface for Work Item (Mass Processing)	20100216

Properties

Class	CL_SWR_WI_MASS_API_LOC
Short Description	Work Item API Manager (Mass-Capable)
Super Class	CL_SWR_API_BASE	Basis Class for APIs
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWF_SWR	Workflow: Internal Implementation for API Layer
Created	20100216	SAP
Last change	20130531	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

#	Interface	Abstract	Final	Description	Created on
1	IF_SWR_API_REMOTE_INTERNAL	☐	☐	Basis Interface for Internal Functions	20100303
2	IF_SWR_WI_MASS_API_INTERNAL	☐	☐	Internal Interface for Work Item (Mass Processing)	20100216

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SWR_API_FACTORY	☐	20100216	Factory for Instantiating APIs
2	CL_SWR_WORKITEM_API	☐	20100216	Work Item API Manager

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_NOTE_OBJECT_TYPE	Constant	Public	☐	Type reference (TYPE)	SWOTOBJID-OBJTYPE	'SOFM'	BOR Type for Attachments	20100729

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20100216
2	GET_INSTANCE	Static method	Public	Method	Returns Interface to Object Instance	20100826
3	_AUTHORITY_CHECK_FOR_WI	Instance method	Private	Method	Authority Check (WI-Specific)	20101103
4	_CHECK_DECISION_KEY	Instance method	Private	Method	Help Function (Checks if Decision Alternative is Valid)	20100818
5	_CHECK_FUNCTION_ALLOWED	Instance method	Private	Method	Help Function (Checks if WAPI are Executed)	20100819
6	_CHECK_NODETYPE_DECISION	Instance method	Private	Method	Help Function (Determines if WI is a User Decision)	20100818
7	_COMMIT	Instance method	Private	Method	Execute Data Changes	20101126
8	_FORWARD_WORKITEM	Instance method	Private	Method	Internal: Forward Work Item	20110323
9	_GET_ATTACHMENT	Instance method	Private	Method	Gets SOFM Attachment + Detailed Information + Content	20110203
10	_GET_BOR_KEY_FROM_DOCID	Instance method	Private	Method	Help Function	20100729
11	_GET_METHOD_DEF_DATA	Instance method	Private	Method	Help Function (Method Definition)	20100806
12	_GET_METHOD_RUN_DATA	Instance method	Private	Method	Help Function (Methods Runtime Data)	20100806
13	_GET_WI_HANDLE_FOR_UPDATE	Instance method	Private	Method	WIM Instance for Update Functions (with Enqueue)	20110120
14	_REJECT_WORKITEM	Instance method	Private	Method	Internal: Decline Work Item Processing	20110323
15	_ROLLBACK	Instance method	Private	Method	Rollback Data Changes	20101126
16	_SET_WORKITEM_TO_COMPLETED	Instance method	Private	Method	Internal: Set Work Item to Completed	20101130

Events

Class CL_SWR_WI_MASS_API_LOC has no event.

Types

Class CL_SWR_WI_MASS_API_LOC has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DEST_ID	Call by reference	☐	Type reference (TYPE)	SWR_DEST		Workflow: Destination für Remote-Aufrufe	20100216
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20100216
3	Importing	I_RFCDEST	Call by reference	☐	Type reference (TYPE)	SWR_RFCDEST		logische Destination (Wird bei Funktionsaufruf angegeben)	20100216
4	Importing	I_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO		Zeitzone des aktuellen Benutzers	20100216
5	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Benutzername	20100216

Method CONSTRUCTOR on class CL_SWR_WI_MASS_API_LOC has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BASE_DATA	Call by reference	☐	Type reference (TYPE)	SWFSWRSBASE			20100909
2	Returning	R_WI_MASS_API_INTERNAL	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWR_WI_MASS_API_INTERNAL		internes Interface für Workitem (Massenverarbeitung)	20100826

Method GET_INSTANCE on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _AUTHORITY_CHECK_FOR_WI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_METHOD	Call by reference	☐	Type reference (TYPE)	C			20101103
2	Importing	I_TCLASS	Call by reference	☐	Type reference (TYPE)	HR_TASK_CL		Klassifikation von Aufgaben	20101103
3	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20101208
4	Importing	I_WI_TYPE	Call by reference	☐	Type reference (TYPE)	SWW_WITYPE		Workitem-Typ	20101103

#	Exception	Resumable	Description	Created on
1	CX_SWR_INT_EXCP_WO_ROLLBACK	☐	Interne Ausnahme, die keinen Rollback erfordert	20101123

Method _CHECK_DECISION_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_KEY	Call by reference	☐	Type reference (TYPE)	SWR_DECIKEY		Index einer Alternative einer Benutzerentscheidung	20100818
2	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20100818

#	Exception	Resumable	Description	Created on
1	CX_SWR_INT_EXCP_WO_ROLLBACK	☐	interne Ausnahme	20101130

Method _CHECK_FUNCTION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FUNCTION	Call by reference	☐	Type reference (TYPE)	C			20100819
2	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20100819

#	Exception	Resumable	Description	Created on
1	CX_SWR_INT_EXCP_WO_ROLLBACK	☐	Interne Ausnahme, die keinen Rollback erfordert	20101122

Method _CHECK_NODETYPE_DECISION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20100818

#	Exception	Resumable	Description	Created on
1	CX_SWR_INT_EXCP_WO_ROLLBACK	☐	interne Ausnahme	20101130

Method _COMMIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	XFELD		Feld zum Ankreuzen	20101126
2	Importing	I_TXMGR	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_TRANSACTION_MANAGER		Workflow: Transaktionsmanager	20101126

Method _COMMIT on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _FORWARD_WORKITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NEW_STATUS	Call by reference	☐	Type reference (TYPE)	SWW_WISTAT			20110323
2	Importing	IT_AGENTS	Call by reference	☐	Type reference (TYPE)	SWRTAGENTLOC		Workflow: Tabelle mit Bearbeitern (lokaler Benutzer)	20110323
3	Importing	I_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'		20110323
4	Importing	I_FUNCTION	Call by reference	☐	Type reference (TYPE)	C			20110323
5	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID			20110323

#	Exception	Resumable	Description	Created on
1	CX_SWR_INTERNAL_EXCEPTION	☐	interne Ausnahme	20110323

Method _GET_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BIN	Call by reference	☐	Type reference (TYPE)	SWFTSOLIX		Workflow: Tabellentyp für SAPOFFICE-Proxy	20110203
2	Exporting	ET_TEXT	Call by reference	☐	Type reference (TYPE)	SWFTLISTI1		Workflow: Tabellentyp für SAPOFFICE-Proxy	20110203
3	Exporting	E_ATTACHMENT	Call by reference	☐	Type reference (TYPE)	SWRSATTACH		Workitem: Attachment Details	20110203
4	Exporting	E_RETCODE	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Rückgabewert von ABAP-Anweisungen	20110203
5	Importing	IH_RETURN_MSG	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWR_API_RETURN_MSG		Nachrichten der API Aufrufe	20110203
6	Importing	I_POR	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20110203
7	Importing	I_WITH_CONTENT	Call by reference	☐	Type reference (TYPE)	XFELD	SPACE	Inhalt abholen	20110204

Method _GET_ATTACHMENT on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _GET_BOR_KEY_FROM_DOCID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	SWOTOBJID		Struktur für Objekt-ID	20100729
2	Exporting	E_RETCODE	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Ausnahme einer Methode	20100729
3	Importing	I_DOC_ID	Call by reference	☐	Type reference (TYPE)	C		ID eines Anlagendokumentes	20100729

Method _GET_BOR_KEY_FROM_DOCID on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _GET_METHOD_DEF_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SWR_METH	Call by reference	☐	Type reference (TYPE)	SWR_METHOD		WAPI: Struktur für Methoden	20100806
2	Importing	I_CLSNAME	Call by reference	☐	Type reference (TYPE)	C		Objekttyp	20100806
3	Importing	I_CLSTYPE	Call by reference	☐	Type reference (TYPE)	SIBFCATID		Objektkategorie	20100806
4	Importing	I_METHOD	Call by reference	☐	Type reference (TYPE)	C		Workflow: Methodename	20100806
5	Importing	I_SWR_METH	Call by reference	☐	Type reference (TYPE)	SWR_METHOD		WAPI: Struktur für Methoden	20100809

Method _GET_METHOD_DEF_DATA on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _GET_METHOD_RUN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SWR_METH	Call by reference	☐	Type reference (TYPE)	SWR_METHOD		WAPI: Struktur für Methoden	20100806
2	Importing	I_OBJNAME	Call by reference	☐	Type reference (TYPE)	SWFDNAME	SWFCO_WI_LEADING_OBJECT	Elementname (32 Zeichen, eindeutig, nicht sprachabhängig)	20100806
3	Importing	I_PERS_PROFIL	Call by reference	☐	Type reference (TYPE)	SWD_PERSID		Art des Persistenzprofils	20100806
4	Importing	I_SWR_METH	Call by reference	☐	Type reference (TYPE)	SWR_METHOD		Objekttyp	20100806
5	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20100806

Method _GET_METHOD_RUN_DATA on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _GET_WI_HANDLE_FOR_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONTEXT	Call by reference	☐	Type reference (TYPE)	SWW_WIMCTX		Workflow: Context des WIM	20110120
2	Importing	I_METHOD	Call by reference	☐	Type reference (TYPE)	SWF_CLSMET		Workflow: Methodename	20110120
3	Importing	I_TXMGR	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_TRANSACTION_MANAGER		Workflow: Transaktionsmanager	20110120
4	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20110120
5	Exporting	RE_WI_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_RUN_WIM_INTERNAL		Workflow: Workitemmanager (lokal)	20110120

#	Exception	Resumable	Description	Created on
1	CX_SWR_INT_EXCP_WO_ROLLBACK	☐	Interne Ausnahme, die keinen Rollback erfordert	20110120

Method _REJECT_WORKITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NEW_STATUS	Call by reference	☐	Type reference (TYPE)	SWW_WISTAT			20110323
2	Importing	I_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'		20110323
3	Importing	I_FUNCTION	Call by reference	☐	Type reference (TYPE)	C			20110323
4	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID			20110323

#	Exception	Resumable	Description	Created on
1	CX_SWR_INTERNAL_EXCEPTION	☐	interne Ausnahme	20110323

Method _ROLLBACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	XFELD		Feld zum Ankreuzen	20101126
2	Importing	I_TXMGR	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_TRANSACTION_MANAGER		Workflow: Transaktionsmanager	20101126

Method _ROLLBACK on class CL_SWR_WI_MASS_API_LOC has no exception.

Method _SET_WORKITEM_TO_COMPLETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NEW_STATUS	Call by reference	☐	Type reference (TYPE)	SWW_WISTAT			20101130
2	Importing	IH_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		Container - Implementierung einer 'Collection'	20101130
3	Importing	I_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'		20101130
4	Importing	I_FUNCTION	Call by reference	☐	Type reference (TYPE)	C			20101130
5	Importing	I_METHOD	Call by reference	☐	Type reference (TYPE)	C			20110329
6	Importing	I_SET_OBSOLET	Call by reference	☐	Type reference (TYPE)	XFLAG	SPACE		20101130
7	Importing	I_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID			20101130

#	Exception	Resumable	Description	Created on
1	CX_SWR_INTERNAL_EXCEPTION	☐	interne Ausnahme	20101130

History

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