SAP ABAP Interface IF_SWN_NOTIF (WF Notif: Notification)
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_NOTIF_BASE | WF Notif: Base Class for Notification Handler | 20030903 |
Properties
| Interface | IF_SWN_NOTIF | |
| Short Description | WF Notif: Notification |
General Data
| Package | SWN | Business Workflow: E-Mail Notifications for Work Items |
| Created | 20030825 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_SWN_NOTIF has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SERIALIZABLE_OBJECT | Serializable Object | 20031002 |
Friends
Interface IF_SWN_NOTIF has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APP_KEY | Instance attribute | Public | Type reference (TYPE) | SWN_APPKEY | Key from Application | 20030825 | ||
| 2 | APP_STATUS | Instance attribute | Public | Type reference (TYPE) | SWN_APPSTAT | Status of Application Object | 20050108 | ||
| 3 | APP_TYPE | Instance attribute | Public | Type reference (TYPE) | SWN_APPTYPE | Origin of Key (for Example, Scenario) | 20030903 | ||
| 4 | CATEGORY_ID | Instance attribute | Public | Type reference (TYPE) | SWN_CATID | Category | 20030825 | ||
| 5 | CL_NOTIF | Instance attribute | Public | Type reference (TYPE) | SWN_CLNOTIF | Class Name of Notification Handler | 20030905 | ||
| 6 | CL_USER | Instance attribute | Public | Type reference (TYPE) | SWN_USRCLASS | Class Name of User Handler | 20030905 | ||
| 7 | CONTAINER_REF | Instance attribute | Public | Type reference (TYPE) | SWN_SIBFLPOR | Reference to Container | 20030825 | ||
| 8 | DELIVER_ASAP | Instance attribute | Public | Type reference (TYPE) | SWN_DELIVERASAP | Deliver as Soon as Possible | 20030825 | ||
| 9 | ID | Instance attribute | Public | Type reference (TYPE) | SWN_NOTIFGUID | ID (GUID) | 20030825 | ||
| 10 | LANGUAGE | Instance attribute | Public | Type reference (TYPE) | SWW_LANG | Language | 20130204 | ||
| 11 | LAST_MODIFIED | Instance attribute | Public | Type reference (TYPE) | SWN_LMODTST | Last Changed on | 20030825 | ||
| 12 | LAST_MODIFIED_BY | Instance attribute | Public | Type reference (TYPE) | SWN_LMODUSR | Last Changed By | 20030825 | ||
| 13 | LAST_SENT_TIME | Instance attribute | Public | Type reference (TYPE) | SWN_LSENTTST | Time of Last Dispatch | 20030825 | ||
| 14 | MSGTMPL_ID | Instance attribute | Public | Type reference (TYPE) | SWN_MSGTEMPLID | Message Template | 20031110 | ||
| 15 | OP_ADD | Constant | Public | Type reference (TYPE) | SWN_NOTIFOP | 'A' | Operation: Add | 20030825 | |
| 16 | OP_DELETE | Constant | Public | Type reference (TYPE) | SWN_NOTIFOP | 'D' | Operation: Delete | 20030825 | |
| 17 | OP_MODIFY | Constant | Public | Type reference (TYPE) | SWN_NOTIFOP | 'M' | Operation: Change | 20030825 | |
| 18 | OP_REASSIGN | Constant | Public | Type reference (TYPE) | SWN_NOTIFOP | 'R' | Operation: Change Receiver | 20030831 | |
| 19 | PRIORITY | Instance attribute | Public | Type reference (TYPE) | SWN_NOTIFPRIO | Priority | 20031013 | ||
| 20 | RECIPIENT_HASH | Instance attribute | Public | Type reference (TYPE) | SWN_HASH | Hash Code Determined from Receiver ID | 20030903 | ||
| 21 | RECIPIENT_ID | Instance attribute | Public | Type reference (TYPE) | SWN_RECID | Recipient address | 20030825 | ||
| 22 | RECIPIENT_TYPE | Instance attribute | Public | Type reference (TYPE) | SWN_RECTYPE | Recipient Type | 20030825 | ||
| 23 | RECPTYPE_SMS | Constant | Public | Type reference (TYPE) | SWN_RECTYPE | 'PAG' | Receiver Type: SMS or Pager | 20030929 | |
| 24 | RECPTYPE_SMTP | Constant | Public | Type reference (TYPE) | SWN_RECTYPE | 'INT' | Receiver Type: E-Mail Address | 20030826 | |
| 25 | RECPTYPE_USER | Constant | Public | Type reference (TYPE) | SWN_RECTYPE | 'RML' | Receiver Type: SAP User | 20030826 | |
| 26 | RELIABILITY | Instance attribute | Public | Type reference (TYPE) | SWN_RELIABILITY | Requested Reliability | 20030825 | ||
| 27 | SAP_RELEASE | Instance attribute | Public | Type reference (TYPE) | SYSAPRL | SAP Release | 20030825 | ||
| 28 | SCENARIO_ID | Instance attribute | Public | Type reference (TYPE) | SWN_SCENID | Business Scenario | 20030825 | ||
| 29 | SENT_COUNT | Instance attribute | Public | Type reference (TYPE) | SWN_SENTCOUNT | Number of Dispatches Sent | 20030825 | ||
| 30 | STATUS | Instance attribute | Public | Type reference (TYPE) | SWN_NOTIFSTAT | Notification Status | 20030903 | ||
| 31 | STATUS_DELETED | Constant | Public | Type reference (TYPE) | SWN_NOTIFSTAT | 'L' | Status: Logically Deleted | 20030825 | |
| 32 | STATUS_DELIVERED | Constant | Public | Type reference (TYPE) | SWN_NOTIFSTAT | 'D' | Status: Sent | 20030825 | |
| 33 | STATUS_NEW | Constant | Public | Type reference (TYPE) | SWN_NOTIFSTAT | ' ' | Status: Unprocessed | 20030825 | |
| 34 | STATUS_PENDING | Constant | Public | Type reference (TYPE) | SWN_NOTIFSTAT | 'P' | Status: In Process | 20030825 | |
| 35 | STATUS_SAVED | Constant | Public | Type reference (TYPE) | SWN_NOTIFSTAT | 'S' | Status: Saved | 20030825 | |
| 36 | SUBSCRIPTION_ID | Instance attribute | Public | Type reference (TYPE) | SWN_SUBSCRID | Subscription | 20030825 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Content of Attachments | 20030825 | |
| 2 | Instance method | Public | Method | List of Attachments (Only Header Data) | 20030919 | |
| 3 | Instance method | Public | Method | Core for Message | 20030825 | |
| 4 | Instance method | Public | Method | Reference to Category | 20030825 | |
| 5 | Instance method | Public | Method | Does the notification have action attachments? | 20031014 | |
| 6 | Instance method | Public | Method | Checks if Message is Valid | 20070404 | |
| 7 | Instance method | Public | Method | Information on Last Send | 20030929 | |
| 8 | Instance method | Public | Method | List of URLs | 20030905 | |
| 9 | Instance method | Public | Method | Reference to Scenario | 20030825 | |
| 10 | Instance method | Public | Method | Message Subject | 20030825 | |
| 11 | Instance method | Public | Method | Determine Reference to Subscription | 20030903 | |
| 12 | Instance method | Public | Method | Determine Reference to User | 20030902 | |
| 13 | Instance method | Public | Method | 20130204 | ||
| 14 | Instance method | Public | Method | Set Information on Last Send | 20030929 | |
| 15 | Instance method | Public | Method | Sets the status 'deleted' | 20031010 | |
| 16 | Instance method | Public | Method | Sets the status 'sent' | 20031010 | |
| 17 | Instance method | Public | Method | Set Reference to Subscription | 20030903 | |
| 18 | Instance method | Public | Method | Set Reference to User | 20030902 |
Events
Interface IF_SWN_NOTIF has no event.
Types
Interface IF_SWN_NOTIF has no local type.
Method Signatures
Method GET_ATTACHMENT_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTENT_AS_STRING | Call by reference | Type reference (TYPE) | STRING | Inhalt als STRING | 20030919 | |||
| 2 | CONTENT_AS_TABLE | Call by reference | Type reference (TYPE) | SOLI_TAB | Inhalt als SO-Tabelle | 20031010 | |||
| 3 | CONTENT_AS_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | Inhalt als XSTRING | 20030919 | |||
| 4 | ID | Value transfer | Type reference (TYPE) | SWN_ATTACHID | ID der gewünschten Anlage | 20031009 | |||
| 5 | INDEX | Value transfer | Type reference (TYPE) | SWN_ATTACHINDEX | Index der gewünschten Anlage | 20030919 |
Method GET_ATTACHMENT_CONTENT on Interface IF_SWN_NOTIF has no exception.
Method GET_ATTACHMENT_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_ATTACHMENTS | Value transfer | Type reference (TYPE) | SWNTATTACH | Liste der Anlagen | 20030919 |
Method GET_ATTACHMENT_LIST on Interface IF_SWN_NOTIF has no exception.
Method GET_BODY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_LINE_WIDTH | Call by reference | Type reference (TYPE) | TDLINESIZE | Zeilenbreite (hin und zurück!) | 20030908 | |||
| 2 | E_TEXT_STRING | Call by reference | Type reference (TYPE) | STRING | Text als String mit CR/LF | 20030908 | |||
| 3 | E_TEXT_TABLE | Call by reference | Type reference (TYPE) | SWNTTEXTLINE | Text als Tabelle im SAPscript-Format | 20030908 | |||
| 4 | I_DELIVERY_TYPE | Call by reference | Type reference (TYPE) | SWN_DELTYPEID | Zustellungsart | 20030926 | |||
| 5 | I_HTML_ESCAPE_FORMAT | Call by reference | Type reference (TYPE) | STRING | html-ESCAPE-Format | 20121204 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Keine Abonnement zugewiesen | 20030902 | ||
| 2 | Anwendungsobjekt zu ang. Schlüssel existiert nicht | 20030907 |
Method GET_CATEGORY_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_CATEGORY | Value transfer | Object reference (TYPE REF TO) | IF_SWN_CATEGORY | Referenz | 20030903 |
Method GET_CATEGORY_REF on Interface IF_SWN_NOTIF has no exception.
Method GET_HAS_ACTION_ATTACHMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_HAS | Value transfer | Type reference (TYPE) | XFELD | hat sie? | 20031014 |
Method GET_HAS_ACTION_ATTACHMENT on Interface IF_SWN_NOTIF has no exception.
Method GET_IS_VALID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_VALID | Value transfer | Type reference (TYPE) | XFELD | Benachrichtigung ist gültig | 20070404 |
Method GET_IS_VALID on Interface IF_SWN_NOTIF has no exception.
Method GET_LAST_SENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DELIVERY_TYPE | Call by reference | Type reference (TYPE) | SWN_DELTYPEID | Zustellungsart | 20030929 | |||
| 2 | R_LAST_SENT_DATA | Call by reference | Type reference (TYPE) | SWNSNOTIFTSTMP | Info über letztes Senden | 20030929 |
Method GET_LAST_SENT on Interface IF_SWN_NOTIF has no exception.
Method GET_LINKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_LINKS | Value transfer | Type reference (TYPE) | SWNTLINKS | Tabelle von Links | 20030905 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Keine Abonnement zugewiesen | 20030905 |
Method GET_SCENARIO_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_SCENARIO | Value transfer | Object reference (TYPE REF TO) | IF_SWN_SCENARIO | Referenz | 20030903 |
Method GET_SCENARIO_REF on Interface IF_SWN_NOTIF has no exception.
Method GET_SUBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DELIVERY_TYPE | Call by reference | Type reference (TYPE) | SWN_DELTYPEID | Zustellungsart | 20030926 | |||
| 2 | R_TEXT | Value transfer | Type reference (TYPE) | STRING | Text | 20030905 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Kein Abonnement zugewiesen | 20030902 | ||
| 2 | Anwendungsobjekt zu ang. Schlüssel existiert nicht | 20030907 |
Method GET_SUBSCRIPTION_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_SUBSCRIPTION | Value transfer | Object reference (TYPE REF TO) | IF_SWN_SUBSCRIPTION | Abonnement | 20030903 |
Method GET_SUBSCRIPTION_REF on Interface IF_SWN_NOTIF has no exception.
Method GET_USER_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_USER | Value transfer | Object reference (TYPE REF TO) | IF_SWN_USER | Benutzer | 20030902 |
Method GET_USER_REF on Interface IF_SWN_NOTIF has no exception.
Method SET_LANGUAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_RECIPIENT | Call by reference | Object reference (TYPE REF TO) | IF_SWN_USER | 20130204 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130204 |
Method SET_LAST_SENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DELIVERY_TYPE | Call by reference | Type reference (TYPE) | SWN_DELTYPEID | Zustellungsart | 20030929 | |||
| 2 | I_LAST_SENT_TIME | Call by reference | Type reference (TYPE) | SWN_LSENTTST | Letzte Sendung | 20030929 |
Method SET_LAST_SENT on Interface IF_SWN_NOTIF has no exception.
Method SET_STATUS_DELETED Signature
Method SET_STATUS_DELETED on Interface IF_SWN_NOTIF has no parameter.
Method SET_STATUS_DELETED on Interface IF_SWN_NOTIF has no exception.
Method SET_STATUS_DELIVERED Signature
Method SET_STATUS_DELIVERED on Interface IF_SWN_NOTIF has no parameter.
Method SET_STATUS_DELIVERED on Interface IF_SWN_NOTIF has no exception.
Method SET_SUBSCRIPTION_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_SUBSCRIPTION | Call by reference | Object reference (TYPE REF TO) | IF_SWN_SUBSCRIPTION | Abonnement | 20030903 |
Method SET_SUBSCRIPTION_REF on Interface IF_SWN_NOTIF has no exception.
Method SET_USER_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_USER | Value transfer | Object reference (TYPE REF TO) | IF_SWN_USER | Benutzer | 20030903 |
Method SET_USER_REF on Interface IF_SWN_NOTIF has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 640 |