SAP ABAP Interface IF_SWN_MESSAGE (WF Notif: Handler for Message Content)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BMT-WFM (Application Component) SAP Business Workflow
     ⤷ SWN (Package) Business Workflow: E-Mail Notifications for Work Items

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SWN_MESSAGE_BASE	WF Notif: Base Class for Message Handler	20030919

Properties

Interface	IF_SWN_MESSAGE
Short Description	WF Notif: Handler for Message Content

General Data

Package	SWN	Business Workflow: E-Mail Notifications for Work Items
Created	20030827	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_SWN_MESSAGE has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SERIALIZABLE_OBJECT	☐	☐	Serializable Object	20031002

Friends

Interface IF_SWN_MESSAGE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BODY	Instance attribute	Public	☐	Type reference (TYPE)	STRING		Message Core	20030917
2	BSP_URL	Instance attribute	Public	☐	Type reference (TYPE)	SWN_BSPURL		URL of BSP application that generates the core	20030919
3	ID	Instance attribute	Public	☐	Type reference (TYPE)	SWN_MSGTEMPLID		Handler ID	20030919

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NOTIFICATIONS	Instance method	Public	Method	Add Notifications	20030921
2	BUILD	Instance method	Public	Method	Creates a message	20030921
3	GET_ATTACHMENT_CONTENT	Instance method	Public	Method	Content of Specific Attachment from the List	20030919
4	GET_ATTACHMENT_LIST	Instance method	Public	Method	List of Attachments (Only Header Data)	20030919
5	GET_DELIVERY_TYPE_REF	Instance method	Public	Method	Returns the reference to the quality of service	20030924
6	GET_DELIVER_ASAP	Instance method	Public	Method	Deliver message immediately?	20031013
7	GET_GRANULARITY	Instance method	Public	Method	Returns the granularity of the message	20030924
8	GET_NOTIFICATIONS	Instance method	Public	Method	Returns the references to the notifications	20030924
9	GET_PRIORITY	Instance method	Public	Method	Returns the priority of the entire message	20031013
10	GET_RECIPIENT_REF	Instance method	Public	Method	Returns the reference to the receiver	20030924
11	GET_RELIABILITY	Instance method	Public	Method	Returns the reliability for the message dispatch	20030929
12	GET_REPLY_ADDRESS	Instance method	Public	Method	Determine Individual Reply Addresses	20030918
13	GET_SUBJECT	Instance method	Public	Method	Returns the subject line of the message	20031001
14	SEND	Instance method	Public	Method	Send warning	20030929
15	SET_DELIVERY_TYPE_REF	Instance method	Public	Method	Sets a reference to a quality of service	20030924
16	SET_GRANULARITY	Instance method	Public	Method	Sets the granularity of the message	20030924
17	SET_RECIPIENT_REF	Instance method	Public	Method	Sets a reference to the receiver	20030924
18	SET_RELIABILITY	Instance method	Public	Method	Sets the reliability for the message dispatch	20030929
19	SET_SENT_TIME	Instance method	Public	Method	Set the Time Stamp for the Send Log	20031001
20	SET_SUBJECT	Instance method	Public	Method	Sets the subject line of the message	20031006

Events

Interface IF_SWN_MESSAGE has no event.

Types

Interface IF_SWN_MESSAGE has no local type.

Method Signatures

Method ADD_NOTIFICATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NOTIFICATIONS	Call by reference	☐	Type reference (TYPE)	SWNTNOTIF3		Tabelle mit Notifications	20030921

Method ADD_NOTIFICATIONS on Interface IF_SWN_MESSAGE has no exception.

Method BUILD Signature

Method BUILD on Interface IF_SWN_MESSAGE has no parameter.

#	Exception	Resumable	Description	Created on
1	BUILD_MESSAGE_FAILED	☐	Nachricht konnte nicht erstellt werden	20030930
2	NOT_IMPLEMENTED	☐	Nicht implementiert	20030921

Method GET_ATTACHMENT_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTENT_AS_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Inhalt als STRING	20030919
2	Exporting	CONTENT_AS_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		Inhalt als XSTRING	20030919
3	Importing	INDEX	Value transfer	☐	Type reference (TYPE)	SWN_ATTACHINDEX		Index der gewünschten Anlage	20030919

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Der Index ist ungültig	20030919

Method GET_ATTACHMENT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ATTACHMENTS	Value transfer	☐	Type reference (TYPE)	SWNTATTACH2		Liste der Anlagen	20030919

Method GET_ATTACHMENT_LIST on Interface IF_SWN_MESSAGE has no exception.

Method GET_DELIVERY_TYPE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_DELIVERY_TYPE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWN_DELIVERY_TYPE		Referenz auf eine Zustellungsart	20030924

Method GET_DELIVERY_TYPE_REF on Interface IF_SWN_MESSAGE has no exception.

Method GET_DELIVER_ASAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ASAP	Value transfer	☐	Type reference (TYPE)	XFELD		Nachricht sofort zustellen	20031013

Method GET_DELIVER_ASAP on Interface IF_SWN_MESSAGE has no exception.

Method GET_GRANULARITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_GRANULARITY	Value transfer	☐	Type reference (TYPE)	SWN_GRANUL		Granularität der Nachricht	20030924

Method GET_GRANULARITY on Interface IF_SWN_MESSAGE has no exception.

Method GET_NOTIFICATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_NOTIFICATIONS	Value transfer	☐	Type reference (TYPE)	SWNTNOTIF3		Referenzen auf Notifications	20030924

Method GET_NOTIFICATIONS on Interface IF_SWN_MESSAGE has no exception.

Method GET_PRIORITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_PRIORITY	Value transfer	☐	Type reference (TYPE)	SWN_NOTIFPRIO		Priorität (1=hoch, 9=niedrig)	20031013

Method GET_PRIORITY on Interface IF_SWN_MESSAGE has no exception.

Method GET_RECIPIENT_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RECIPIENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWN_USER		Empfänger	20030924

Method GET_RECIPIENT_REF on Interface IF_SWN_MESSAGE has no exception.

Method GET_RELIABILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RELIABILITY	Value transfer	☐	Type reference (TYPE)	SWN_RELIABILITY		Zuverlässigkeit	20030929

Method GET_RELIABILITY on Interface IF_SWN_MESSAGE has no exception.

Method GET_REPLY_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ADDRESS	Call by reference	☐	Type reference (TYPE)	SWN_RECID		Adresse	20031013
2	Exporting	E_ADDRESS_TYPE	Call by reference	☐	Type reference (TYPE)	SWN_COMMTYPE		Adresstyp	20031013
3	Exporting	E_DISPLAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Anzeigename	20031013
4	Importing	I_ADDRESS_TYPE	Call by reference	☐	Type reference (TYPE)	SWN_COMMTYPE		Adresstyp	20031013

#	Exception	Resumable	Description	Created on
1	NOT_AVAILABLE	☐	Für diese Nachricht nicht vorhanden	20030918
2	NOT_IMPLEMENTED	☐	Nicht implementiert	20030918

Method GET_SUBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SUBJECT	Value transfer	☐	Type reference (TYPE)	STRING		Betreff	20031001

Method GET_SUBJECT on Interface IF_SWN_MESSAGE has no exception.

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DELIVERER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWN_DELIVERER		Zusteller	20030929

#	Exception	Resumable	Description	Created on
1	DELIVERY_FAILED	☐	Nachricht konnte nicht gesendet werden	20030929

Method SET_DELIVERY_TYPE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DELIVERY_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWN_DELIVERY_TYPE		Referenz auf eine Zustellungsart	20030924

Method SET_DELIVERY_TYPE_REF on Interface IF_SWN_MESSAGE has no exception.

Method SET_GRANULARITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GRANULARITY	Call by reference	☐	Type reference (TYPE)	SWN_GRANUL		Granularität der Nachricht	20030924

Method SET_GRANULARITY on Interface IF_SWN_MESSAGE has no exception.

Method SET_RECIPIENT_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RECIPIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWN_USER		Empfänger der Nachricht	20030924

Method SET_RECIPIENT_REF on Interface IF_SWN_MESSAGE has no exception.

Method SET_RELIABILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RELIABILITY	Call by reference	☐	Type reference (TYPE)	SWN_RELIABILITY		Zuverlässigkeit	20030929

Method SET_RELIABILITY on Interface IF_SWN_MESSAGE has no exception.

Method SET_SENT_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SENT_TIME	Call by reference	☐	Type reference (TYPE)	SWN_TIMESTAMPL		Sendezeitpunkt	20031001

#	Exception	Resumable	Description	Created on
1	DOCUMENT_KEY_NOT_FILLED	☐	Dokumentschlüssel der Nachricht ist nicht gefüllt	20031001
2	INSERT_FAILED	☐	Protokolleintrag konnte nicht in die Tab. eingefügt werden	20031001

Method SET_SUBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SUBJECT	Value transfer	☐	Type reference (TYPE)	STRING		Betreffzeile	20031006

Method SET_SUBJECT on Interface IF_SWN_MESSAGE has no exception.

History

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