SAP ABAP Class CL_ALERT_SERVICES_LOCAL (ALM API: Local Service Functions)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-GBT-ALM (Application Component) Alert Framework
     ⤷ SALERT_LOCAL (Package) Application Interface for Alert Framework

Properties

Class	CL_ALERT_SERVICES_LOCAL
Short Description	ALM API: Local Service Functions
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SALERT_LOCAL	Application Interface for Alert Framework
Created	20030404	SAP
Last change	20050214	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_ALERT_SERVICES_LOCAL has no interface implemented.

Friends

Class CL_ALERT_SERVICES_LOCAL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	RFCDEST	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST			20030616
2	UNIQUE_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ALERT_SERVICES_LOCAL			20030404

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONFIRM_ALERTS_BY_APPL_GUID	Instance method	Public	Method	API: Confirm Alerts for an Application GUID	20030616
2	DETERMINE_CATEGORY_KEY	Instance method	Public	Method	API: Triggers Alias of Alert Category	20050104
3	GET_ALERTS_BY_APPL_GUID	Instance method	Public	Method	t.b.d.API: Read Alerts for an Application GUID	20030616
4	GET_ALERT_CATEGORIES	Instance method	Public	Method	API: Determine Alert Categories With Selection Criteria	20030616
5	GET_ALIAS_OF_CATEGORY	Instance method	Public	Method	API: Returns Alias of an Alert Category	20050104
6	GET_CONTAINER_OF_CAT	Instance method	Public	Method	API: Read Container Definition for Category	20030616
7	GET_DEST_OF_CENTRAL_SERVER	Instance method	Public	Method	API: Read RFC Destination for Central Alert Server	20030616
8	GET_INSTANCE	Static method	Public	Method	API: Delivers the Singleton	20030404
9	GET_TEXT	Instance method	Public	Method	API: Read Title, Long Text or Short Text (with Variables)	20030411
10	GET_TEXT_OF_CAT	Instance method	Public	Method	API: Read Description of a Category	20030404

Events

Class CL_ALERT_SERVICES_LOCAL has no event.

Types

Class CL_ALERT_SERVICES_LOCAL has no local type.

Method Signatures

Method CONFIRM_ALERTS_BY_APPL_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_APPL_GUID	Call by reference	☐	Type reference (TYPE)	GUID_32		Anwendungs-GUID	20030616
2	Importing	IP_WAIT_ON_COMMIT	Call by reference	☐	Type reference (TYPE)	CHAR1		Auf COMMIT WORK warten	20030616
3	Importing	IT_APPL_GUID	Call by reference	☐	Type reference (TYPE)	SALRTTGUID		Tabelle mit Anwendungs-GUIDs	20030616

#	Exception	Resumable	Description	Created on
1	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20030616

Method DETERMINE_CATEGORY_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ALIAS	Call by reference	☑	Type reference (TYPE)	SALERTDALIAS		ALM: Langer Name einer Alert-Kategorie	20050104
2	Importing	IP_CATEGORY_KEY	Call by reference	☑	Type reference (TYPE)	SALRTDCAT		Alert-Kategorie	20050104
3	Returning	RP_CATEGORY_KEY	Value transfer	☐	Type reference (TYPE)	SALRTDCAT		Alert-Kategorie	20050104

#	Exception	Resumable	Description	Created on
1	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20050104

Method GET_ALERTS_BY_APPL_GUID Signature

Method GET_ALERTS_BY_APPL_GUID on class CL_ALERT_SERVICES_LOCAL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20030616

Method GET_ALERT_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTTCATV		Alerts: Tabelle von Alertkategorien mit Langtext	20030616
2	Importing	IP_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Sprache	20030616
3	Importing	IP_WITH_CLASSTEXT	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	Klassifizierungsinfo lesen	20030616
4	Importing	IT_CATEGORY	Call by reference	☑	Type reference (TYPE)	SALRTRTCT		Selektionstabelle für Alertkategorien	20030616
5	Importing	IT_CLASS	Call by reference	☑	Type reference (TYPE)	SALRTRTCL		Selektionstabelle für Klassifizierung	20030616

#	Exception	Resumable	Description	Created on
1	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20030616

Method GET_ALIAS_OF_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CATEGORY_KEY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT		Alert-Kategorie	20050104
2	Returning	RP_ALIAS	Value transfer	☐	Type reference (TYPE)	SALERTDALIAS		ALM: Langer Name einer Alert-Kategorie	20050104

#	Exception	Resumable	Description	Created on
1	CX_ALERT_CAT_UNKNOWN	☐	Alertkategorie nicht gefunden	20050104
2	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20050104

Method GET_CONTAINER_OF_CAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DEFINITION	Call by reference	☐	Type reference (TYPE)	SWBCONTTAB		Container-Definition	20030616
2	Exporting	ET_VALUES	Call by reference	☐	Type reference (TYPE)	SWCONTTAB		Container-Werte	20030616
3	Importing	IP_CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT		Alert-Kategorie	20030616

#	Exception	Resumable	Description	Created on
1	CX_ALERT	☐	Basisklasse aller Alert-Fehlermeldungen	20030616
2	CX_ALERT_CAT_NO_CONTAINER	☐	Alert-Kategorie hat keinen Container	20030616
3	CX_ALERT_CAT_UNKNOWN	☐	Alertkategorie nicht gefunden	20030616
4	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20030616

Method GET_DEST_OF_CENTRAL_SERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RFCDEST	Value transfer	☐	Type reference (TYPE)	SALRTDRFCD		RFC Destination	20030616

Method GET_DEST_OF_CENTRAL_SERVER on class CL_ALERT_SERVICES_LOCAL has no exception.

Method GET_INSTANCE Signature

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

#	Exception	Resumable	Description	Created on
1	CX_ALERT_NO_RFC_DEST	☐	Alerts: Fehlende RFC Destination zum zentralen Server	20030616

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_LONG_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Tabelle mit Langtext	20030908
2	Exporting	EP_SHORT_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Tabelle mit Kurztext	20030908
3	Exporting	EP_TITLE	Call by reference	☐	Type reference (TYPE)	STRING		Tabelle mit Titel	20030908
4	Importing	IP_CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT		Alert-Kategorie	20030616
5	Importing	IP_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Textsprache	20030616
6	Importing	IP_LONGTEXT	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Langtext lesen	20030616
7	Importing	IP_SHORTTEXT	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Kurztext lesen	20030616
8	Importing	IP_TITLE	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Titel lesen	20030616
9	Importing	IT_CONTAINER	Call by reference	☑	Type reference (TYPE)	SWCONTTAB		Container-Tabelle	20030616

#	Exception	Resumable	Description	Created on
1	CX_ALERT	☐	Basisklasse aller Alert-Fehlermeldungen	20030616
2	CX_ALERT_CAT_UNKNOWN	☐	Alertkategorie nicht gefunden	20030616
3	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20030616

Method GET_TEXT_OF_CAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_TEXT	Call by reference	☐	Type reference (TYPE)	SALRTDCATD		Text der Kategorie	20030404
2	Importing	IP_CATEGORY	Call by reference	☐	Type reference (TYPE)	SALRTDCAT		Alertkategorie	20030404
3	Importing	IP_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Sprache	20030404

#	Exception	Resumable	Description	Created on
1	CX_ALERT_COMMUNICATION_ERROR	☐	Basisklasse für Exceptions in Konfiguration	20030616

History

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