SAP ABAP Class CL_ALERT_RECIPIENT (Alerts: Recipient)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-GBT-ALM (Application Component) Alert Framework
     ⤷ SALERT_CORE (Package) Central Alert Server

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_OS_STATE	State Management for a 'Managed Object'	20010206

Properties

Class	CL_ALERT_RECIPIENT
Short Description	Alerts: Recipient
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	10	Persistent Class
Package	SALERT_CORE	Central Alert Server
Created	20010206	SAP
Last change	20041208	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_OS_SYSTEM	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_OS_STATE	☐	☐	State Management for a 'Managed Object'	20010206

Friends

#	Friend	Modeled only	Created on	Description
1	CB_ALERT_RECIPIENT	☐	20040914	Base Agent Alerts: Recipient

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADDRNUMBER	Instance attribute	Private	☐	Type reference (TYPE)	AD_ADDRNUM		Address Number	20010320
2	ALERT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ALERT		Globally Unique Identifier	20010206
3	ALREAD	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDREAD		Indicator: Recipient Has Read Alert in Alert Inbox	20010206
4	ESCAL	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDRCPE		Indicator: Recipient Is Escalation Recipient	20010206
5	FORWARDED	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDRDPF		Indicator: Alert Forwarded To Recipient	20010206
6	MSGID	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDMSGC		Different Message Class: Reasons for Alert Delivery	20010319
7	MSGV1	Instance attribute	Protected	☐	Type reference (TYPE)	SYMSGV		Messages, Message Variables	20010206
8	MSGV2	Instance attribute	Protected	☐	Type reference (TYPE)	SYMSGV		Messages, Message Variables	20010206
9	MSGV3	Instance attribute	Protected	☐	Type reference (TYPE)	SYMSGV		Messages, Message Variables	20010206
10	MSGV4	Instance attribute	Protected	☐	Type reference (TYPE)	SYMSGV		Messages, Message Variables	20010206
11	PERSNUMBER	Instance attribute	Private	☐	Type reference (TYPE)	AD_PERSNUM		Person Number	20010320
12	PROCESS_STATE	Instance attribute	Protected	☐	Type reference (TYPE)	SALERTDPROCESS		ALM: Processing Status of an Alert	20040914
13	QUIT	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDQUIT		Indicator Showing That the Recipient Has Confirmed the Alert	20010206
14	REASON	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDREAS		Reason for Delivering Alert To Recipient	20010206
15	UNAME	Instance attribute	Protected	☐	Type reference (TYPE)	SALRTDRCPT		Alert Recipient	20010206

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_FROM_DATA	Static method	Public	Method	Creates Object from Receiver Data	20030117
2	DELETE	Instance method	Public	Method	Delete Recipient	20010207
3	FILL_USER_ADDRESS	Instance method	Private	Method	Buffer Recipient's Address	20010320
4	GET_ADDRNUMBER	Instance method	Private	Get-method of a virtual attribute	Reads the Attribute ADDRNUMBER	20010320
5	GET_ALERT	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute ALERT	20010206
6	GET_ALREAD	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute ALREAD	20010206
7	GET_ESCAL	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute ESCAL	20010206
8	GET_FORWARDED	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute FORWARDED	20010206
9	GET_MSGID	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute MSGID	20010319
10	GET_MSGV1	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute MSGV1	20010206
11	GET_MSGV2	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute MSGV2	20010206
12	GET_MSGV3	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute MSGV3	20010206
13	GET_MSGV4	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute MSGV4	20010206
14	GET_PERSNUMBER	Instance method	Private	Get-method of a virtual attribute	Reads the Attribute PERSNUMBER	20010320
15	GET_PROCESS_STATE	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute PROCESS_STATE	20040914
16	GET_QUIT	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute QUIT	20010206
17	GET_REASON	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute REASON	20010206
18	GET_UNAME	Instance method	Public	Get-method of a virtual attribute	Reads the Attribute UNAME	20010206
19	READ_NAME	Instance method	Public	Method	Read Recipient's Name	20010320
20	READ_USER_ADDRESS	Instance method	Public	Method	Read Recipient's Address	20010320
21	SET_ADDRNUMBER	Instance method	Private	Set-method of a virtual attribute	Sets the Attribute ADDRNUMBER	20010320
22	SET_ALERT	Instance method	Public	Set-method of a virtual attribute	Set the Attribute ALERT	20010206
23	SET_ALREAD	Instance method	Public	Set-method of a virtual attribute	Set the Attribute ALREAD	20010206
24	SET_ESCAL	Instance method	Public	Set-method of a virtual attribute	Set the Attribute ESCAL	20010206
25	SET_FORWARDED	Instance method	Public	Set-method of a virtual attribute	Set the Attribute FORWARDED	20010206
26	SET_MSGID	Instance method	Public	Set-method of a virtual attribute	Set the Attribute MSGID	20010319
27	SET_MSGV1	Instance method	Public	Set-method of a virtual attribute	Set the Attribute MSGV1	20010206
28	SET_MSGV2	Instance method	Public	Set-method of a virtual attribute	Set the Attribute MSGV2	20010206
29	SET_MSGV3	Instance method	Public	Set-method of a virtual attribute	Set the Attribute MSGV3	20010206
30	SET_MSGV4	Instance method	Public	Set-method of a virtual attribute	Set the Attribute MSGV4	20010206
31	SET_PERSNUMBER	Instance method	Private	Set-method of a virtual attribute	Sets the Attribute PERSNUMBER	20010320
32	SET_PROCESS_STATE	Instance method	Public	Set-method of a virtual attribute	Sets the Attribute PROCESS_STATE	20040914
33	SET_QUIT	Instance method	Public	Set-method of a virtual attribute	Sets the Attribute QUIT	20010206
34	SET_REASON	Instance method	Public	Set-method of a virtual attribute	Set the Attribute REASON	20010206
35	SET_UNAME	Instance method	Public	Set-method of a virtual attribute	Set the Attribute UNAME	20010606

Events

Class CL_ALERT_RECIPIENT has no event.

Types

Class CL_ALERT_RECIPIENT has no local type.

Method Signatures

Method CREATE_FROM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PERSISTENT	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	persistent oder transient	20030117
2	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	SALRTSRCP		Alerts: Übergabestruktur für Empfänger mit Grund	20030117
3	Returning	RO_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ALERT_RECIPIENT		Alerts: Empfänger	20030117

Method CREATE_FROM_DATA on class CL_ALERT_RECIPIENT has no exception.

Method DELETE Signature

Method DELETE on class CL_ALERT_RECIPIENT has no parameter.
Method DELETE on class CL_ALERT_RECIPIENT has no exception.

Method FILL_USER_ADDRESS Signature

Method FILL_USER_ADDRESS on class CL_ALERT_RECIPIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ALERT_RECIPIENT_UNKNOWN	☐	Alerts: Alertempfänger ist unbekannt	20010320

Method GET_ADDRNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	AD_ADDRNUM		Attributwert	20010320

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010320

Method GET_ALERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ALERT		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_ALREAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDREAD		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_ESCAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDRCPE		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_FORWARDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDRDPF		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_MSGID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDMSGC		Attributwert	20010319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010319

Method GET_MSGV1 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_MSGV2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_MSGV3 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_MSGV4 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_PERSNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	AD_PERSNUM		Attributwert	20010320

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010320

Method GET_PROCESS_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALERTDPROCESS		Attributwert	20040914

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040914

Method GET_QUIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDQUIT		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_REASON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDREAS		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method GET_UNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SALRTDRCPT		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method READ_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_NAME_TEXT	Value transfer	☐	Type reference (TYPE)	AD_NAMTEXT		Vollständiger Name der Person	20010320

#	Exception	Resumable	Description	Created on
1	CX_ALERT_RECIPIENT_UNKNOWN	☐	Alerts: Alertempfänger ist unbekannt	20010320

Method READ_USER_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_ADDRESS	Value transfer	☐	Type reference (TYPE)	ADDR_KEYNR		Adresse des Empfängers	20010320

#	Exception	Resumable	Description	Created on
1	CX_ALERT_RECIPIENT_UNKNOWN	☐	Alerts: Alertempfänger ist unbekannt	20010320

Method SET_ADDRNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ADDRNUMBER	Call by reference	☐	Type reference (TYPE)	AD_ADDRNUM		Attributwert	20010320

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010320

Method SET_ALERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ALERT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ALERT		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_ALREAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ALREAD	Call by reference	☐	Type reference (TYPE)	SALRTDREAD		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_ESCAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ESCAL	Call by reference	☐	Type reference (TYPE)	SALRTDRCPE		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_FORWARDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FORWARDED	Call by reference	☐	Type reference (TYPE)	SALRTDRDPF		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_MSGID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSGID	Call by reference	☐	Type reference (TYPE)	SALRTDMSGC		Attributwert	20010319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010319

Method SET_MSGV1 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSGV1	Call by reference	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_MSGV2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSGV2	Call by reference	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_MSGV3 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSGV3	Call by reference	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_MSGV4 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSGV4	Call by reference	☐	Type reference (TYPE)	SYMSGV		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_PERSNUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERSNUMBER	Call by reference	☐	Type reference (TYPE)	AD_PERSNUM		Attributwert	20010320

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010320

Method SET_PROCESS_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROCESS_STATE	Call by reference	☐	Type reference (TYPE)	SALERTDPROCESS		Attributwert	20040914

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040914

Method SET_QUIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUIT	Call by reference	☐	Type reference (TYPE)	SALRTDQUIT		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_REASON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REASON	Call by reference	☐	Type reference (TYPE)	SALRTDREAS		Attributwert	20010206

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010214

Method SET_UNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_UNAME	Call by reference	☐	Type reference (TYPE)	SALRTDRCPT		Attributwert	20010606

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010606

History

Last changed by/on	SAP	20041208
SAP Release Created in	300