SAP ABAP Class CL_SWF_EVT_QUEUE_MANAGER (Event Queue Manager)

Hierarchy

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

Properties

Class	CL_SWF_EVT_QUEUE_MANAGER
Short Description	Event Queue Manager
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWF_EVT	Workflow: Events
Created	20000608	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SWF_CNT_FACTORY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SWFEV	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SWF_EVT_QUEUE_MANAGER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SWF_EVT_SERVICES	☐	20010323	Services for Events/Handlers

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_ENQUEUE_LOCK	Instance attribute	Private	☐	Type reference (TYPE)	XFELD			20011115
2	M_ENQUEUE_OWNER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20011115
3	M_QUEUE_SETTINGS	Static Attribute	Private	☐	Type reference (TYPE)	SWEQADM		Administration Data for Event Queue	20000629
4	M_SINGLETON	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_EVT_QUEUE_MANAGER		Event Queue Manager	20000608

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_HANDLER_TO_VALUES	Instance method	Public	Method	Converts a handler to internal values	20000630
2	CONVERT_VALUES_TO_HANDLER	Instance method	Public	Method	Converts the internal values to a handler	20000630
3	DEQUEUE	Instance method	Public	Method	Sets the DEQUEUE lock	20011115
4	ENQUEUE	Instance method	Public	Method	Sets the ENQUEUE lock	20011115
5	GET_QUEUE_SETTINGS	Instance method	Public	Method	Gets the setting of the queue	20000629
6	IS_LOCKED	Instance method	Public	Method	Displays whether the enqueue lock was set LOCALLY	20011115
7	SET_HANDLER_TO_QUEUE	Instance method	Public	Method	Adds a handler to the queue	20000630
8	SET_VALUES_TO_QUEUE	Instance method	Public	Method	Adds the values of a handler to the queue	20000630
9	SINGLETON	Static method	Public	Method	Singleton	20000608
10	VALIDATE_QUEUE_VALUES	Instance method	Public	Method	Checks whether the current data has been changed	20011115

Events

Class CL_SWF_EVT_QUEUE_MANAGER has no event.

Types

Class CL_SWF_EVT_QUEUE_MANAGER has no local type.

Method Signatures

Method CONVERT_HANDLER_TO_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_VALUES	Call by reference	☐	Type reference (TYPE)	SWEQUEUE		Eintrag für Eventqueue	20000630
2	Exporting	EX_XML_CONTAINER	Call by reference	☐	Type reference (TYPE)	SWFREVTXML_TAB		Ereigniscontainer (XML-Strom)	20010213
3	Exporting	EX_XML_SIZE	Call by reference	☐	Type reference (TYPE)	SWF_XMLSIZ		Größe in Byte	20010213
4	Importing	IM_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_EVT_EVENT_HANDLER		Ereignisbehandler zur Laufzeit	20000630
5	Importing	IM_OPTIONS	Call by reference	☑	Type reference (TYPE)	SWEQOPTS		Ereignis-Queue: Optionen	20010326
6	Importing	IM_STATUS	Call by reference	☐	Type reference (TYPE)	SWE_EVTSTA	SWFEV_EVT_STATUS_READY	Status in der Queue	20000817

Method CONVERT_HANDLER_TO_VALUES on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method CONVERT_VALUES_TO_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_EVT_EVENT_HANDLER		Ereignisbehandler zur Laufzeit	20000810
2	Importing	IM_CONTAINER_IS_COMPLETE	Call by reference	☐	Type reference (TYPE)	XFELD	SPACE	Container ist vollständig	20000811
3	Importing	IM_VALUES	Call by reference	☐	Type reference (TYPE)	SWEQUEUE		Daten aus der Eventqueue	20000810
4	Importing	IM_XML_CONTAINER	Call by reference	☐	Type reference (TYPE)	SWFREVTXML_TAB		Tabelle für XML-Strom des Ereigniscontainers	20010213
5	Importing	IM_XML_SIZE	Call by reference	☑	Type reference (TYPE)	SWF_XMLSIZ		Größe in Byte	20010213

Method CONVERT_VALUES_TO_HANDLER on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method DEQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_OWNER	Call by reference	☑	Type reference (TYPE)	STRING			20011115

Method DEQUEUE on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_OWNER	Call by reference	☑	Type reference (TYPE)	STRING			20011115

#	Exception	Resumable	Description	Created on
1	CX_SWF_EVT_EXCEPTION	☐	Ausnahme im Ereignismanager	20011115

Method GET_QUEUE_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_SETTINGS	Value transfer	☐	Type reference (TYPE)	SWEQADM		Administrationsdaten für Ereignis-Queue	20000629

Method GET_QUEUE_SETTINGS on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method IS_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_LOCKED	Value transfer	☐	Type reference (TYPE)	XFELD			20011115

Method IS_LOCKED on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method SET_HANDLER_TO_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_EVT_EVENT_HANDLER		Ereignisbehandler zur Laufzeit	20000630
2	Importing	IM_OPTIONS	Call by reference	☑	Type reference (TYPE)	SWEQOPTS		Ereignis-Queue: Optionen	20010326
3	Importing	IM_STATUS	Call by reference	☐	Type reference (TYPE)	SWE_EVTSTA	0	Ereignis-Queue: Status eines Ereignisses in der Queue	20000808

Method SET_HANDLER_TO_QUEUE on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method SET_VALUES_TO_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STATUS	Call by reference	☐	Type reference (TYPE)	SWE_EVTSTA	0	Ereignis-Queue: Status eines Ereignisses in der Queue	20000808
2	Importing	IM_VALUES	Call by reference	☐	Type reference (TYPE)	SWEQUEUE		Werte für Eventqueue	20000630
3	Importing	IM_XML_CONTAINER	Call by reference	☐	Type reference (TYPE)	SWFREVTXML_TAB		Tabelle für Ereigniscontainer (XML)	20010213
4	Importing	IM_XML_SIZE	Call by reference	☑	Type reference (TYPE)	SWF_XMLSIZ		Größe in Byte	20010213

Method SET_VALUES_TO_QUEUE on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method SINGLETON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_QUEUE_MANAGER	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_EVT_QUEUE_MANAGER		Ereignis-Queue-Manager	20000608

Method SINGLETON on class CL_SWF_EVT_QUEUE_MANAGER has no exception.

Method VALIDATE_QUEUE_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_VALUES	Call by reference	☐	Type reference (TYPE)	SWETQUEUE			20011115

#	Exception	Resumable	Description	Created on
1	CX_SWF_EVT_EXCEPTION	☐		20011115

History

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