SAP ABAP Class CL_SWF_UTL_ALERT (Workflow: Service class to trigger an alert)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	BI_OBJECT	Business Instance	20030707
2	Interface implementation (CLASS c. INTERFACES i_ref)	BI_PERSISTENT	Persistent Business Instance	20030707
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WORKFLOW	Business Workflow	20030707

Properties

Class	CL_SWF_UTL_ALERT
Short Description	Workflow: Service class to trigger an alert
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SWF_UTL	Workflow: Tools
Created	20030704	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SWF_UTL_ALERT has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	BI_OBJECT	☐	☐	Business Instance	20030707
2	BI_PERSISTENT	☐	☐	Persistent Business Instance	20030707
3	IF_WORKFLOW	☐	☐	Business Workflow	20030707

Friends

Class CL_SWF_UTL_ALERT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DEFAULT_CATEGORY	Constant	Protected	☐	Type reference (TYPE)	SALRTDCAT	'PROCESS ALERT'	Default	20030704
2	MT_CATEGORIES	Static Attribute	Protected	☐	Type reference (TYPE)	SALRTTCATV		Buffer	20030710
3	M_LAST_CLASS	Static Attribute	Protected	☐	Type reference (TYPE)	SALRTDCATC		Last Buffered Class	20030710

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	EXIST_CATEGORY	Static method	Public	Method	Checks whether a category exists	20030709
2	GET_CATEGORIES	Static method	Public	Method	Reads all Categories	20030709
3	RAISE	Static method	Public	Method	Synchronous Triggering of Alert	20030704
4	RAISE_ALERT	Static method	Public	Method	Synchronous Triggering of an ALERT	20051024
5	RAISE_ALERT_WITH_WI_CONTAINER	Static method	Public	Method	Synchronous Triggering of an ALERT with Transfer of WI Cont.	20070904
6	RAISE_PROCESS_ALERT	Static method	Public	Method	Syncronous Triggering of a PROCESS ALERT	20030704

Events

Class CL_SWF_UTL_ALERT has no event.

Types

Class CL_SWF_UTL_ALERT has no local type.

Method Signatures

Method EXIST_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATEGORY	Value transfer	☐	Type reference (TYPE)	SALRTDCAT		Name der Kategorie	20030709
2	Importing	CLASS	Call by reference	☑	Type reference (TYPE)	SALRTDCATC		Name der Klasse (optional)	20030709
3	Returning	EXIST	Value transfer	☐	Type reference (TYPE)	XFLAG		existiert	20030709
4	Importing	USE_BUFFER	Call by reference	☑	Type reference (TYPE)	XFLAG		gepufferter Zugriff	20030710

Method EXIST_CATEGORY on class CL_SWF_UTL_ALERT has no exception.

Method GET_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CATEGORIES	Value transfer	☐	Type reference (TYPE)	SALRTTCATV		Kategorien	20030709
2	Importing	CLASS	Value transfer	☑	Type reference (TYPE)	SALRTDCATC		Name der Klasse	20030709
3	Importing	USE_BUFFER	Call by reference	☐	Type reference (TYPE)	XFLAG	SPACE	gepufferter Zugriff	20030710

Method GET_CATEGORIES on class CL_SWF_UTL_ALERT has no exception.

Method RAISE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ALERT_ID	Value transfer	☐	Type reference (TYPE)	SALRTEXTID		Alert ID	20030704
2	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT		Name der Kategorie	20030704
3	Importing	CONTAINER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		Container (optional)	20030704

Method RAISE on class CL_SWF_UTL_ALERT has no exception.

Method RAISE_ALERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ALERT_ID	Value transfer	☐	Type reference (TYPE)	SALRTEXTID			20051024
2	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT	SPACE	Kategorie (space = PROCESS ALERT )	20051024
3	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	SWC_VALUE		Beschreibungstext (Langtext)	20051024
4	Importing	DYNAMIC_TEXT	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'	Dynamischer Text, kein Zugriff auf Workitem-Container	20070903
5	Importing	SHORTTEXT	Call by reference	☐	Type reference (TYPE)	SWC_VALUE	SPACE	Kurztext (SMS, EMail-Betreff)	20051024
6	Importing	WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID	0	Workitem ID (FlowItem)	20051024

Method RAISE_ALERT on class CL_SWF_UTL_ALERT has no exception.

Method RAISE_ALERT_WITH_WI_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ALERT_ID	Value transfer	☐	Type reference (TYPE)	SALRTEXTID			20070904
2	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT	SPACE	Kategorie (space = PROCESS ALERT )	20070904
3	Importing	WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID	0	Workitem (Aufrufer-Workitem, falls initial)	20070904

#	Exception	Resumable	Description	Created on
1	CX_SWF_IFS_EXCEPTION	☐	Workflow Ausnahme	20070904

Method RAISE_PROCESS_ALERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ALERT_ID	Value transfer	☐	Type reference (TYPE)	SALRTEXTID			20030704
2	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT	SPACE	Kategorie (space = PROCESS ALERT )	20030704
3	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	SWC_VALUE		Beschreibungstext (Langtext)	20030704
4	Importing	SHORTTEXT	Call by reference	☐	Type reference (TYPE)	SWC_VALUE	SPACE	Kurztext (SMS, EMail-Betreff)	20030708
5	Importing	WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID	0	Workitem ID (FlowItem)	20030704

Method RAISE_PROCESS_ALERT on class CL_SWF_UTL_ALERT has no exception.

History

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