SAP ABAP Class CL_RSBPC_EN_NOTIFICATION_API (POA SBC E&N Notification API)
Hierarchy
☛
SAP_BW (Software Component) SAP Business Warehouse
⤷
BW-PLA-BPC-INF (Application Component) BPC 'unified model' - Infrastructure
⤷
RSBPC_EN (Package) BPC IP Extension: Event & Notification
SAP_BW (Software Component) SAP Business Warehouse⤷
BW-PLA-BPC-INF (Application Component) BPC 'unified model' - Infrastructure⤷
RSBPC_EN (Package) BPC IP Extension: Event & NotificationProperties
| Class | CL_RSBPC_EN_NOTIFICATION_API | |
| Short Description | POA SBC E&N Notification API | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | RSBPC_EN | BPC IP Extension: Event & Notification |
| Created | 20130306 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  /POA/ |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 3 | BPCEN |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | POA |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_RSBPC_EN_NOTIFICATION_API has no interface implemented.
Friends
Class CL_RSBPC_EN_NOTIFICATION_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_DEFAULT_EVENT_TYPE |
Constant | Public | Type reference (TYPE) | RSBPC_EN_EVENT_TYPE | 'DEFAULT_TYPE' | POA SBC E&N Default Event Type | 20130306 | |
| 2 | C_EVENT_SOURCE_MAX_LENGTH |
Constant | Public | Type reference (TYPE) | I | 200 | 20130306 | ||
| 3 | C_EVENT_TYPE_DOMAIN |
Constant | Public | Type reference (TYPE) | DOM_REF | 'RSBPC_EN_EVENT_TYPE' | Domain used | 20130306 | |
| 4 | C_EVENT_TYPE_MAX_LENGTH |
Constant | Public | Type reference (TYPE) | I | 50 | 20130306 | ||
| 5 | C_MESSAGE_TYPE_DOMAIN |
Constant | Public | Type reference (TYPE) | DOM_REF | 'RSBPC_EN_MESSAGE_TYPE' | Domain used | 20130306 | |
| 6 | C_PRIORITY_DOMAIN |
Constant | Public | Type reference (TYPE) | DOM_REF | 'RSBPC_EN_PRIORITY' | Domain used | 20130306 | |
| 7 | C_RECIPIENT_INT |
Constant | Public | Type reference (TYPE) | RSBPC_EN_COMTYPE | 'INT' | Communication method | 20130306 | |
| 8 | C_RECIPIENT_ROLE |
Constant | Public | Type reference (TYPE) | RSBPC_EN_COMTYPE | 'ROL' | Communication method | 20130306 | |
| 9 | C_RECIPIENT_USR |
Constant | Public | Type reference (TYPE) | RSBPC_EN_COMTYPE | 'USR' | Communication method | 20130306 | |
| 10 | C_SOURCE_DOMAIN |
Constant | Public | Type reference (TYPE) | DOM_REF | 'RSBPC_EN_SOURCE' | Domain used | 20130306 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | PUBLISH |
Instance method | Public | Method | Publish Notification | 20130306 |
| 2 | PUBLISH_INTERNAL |
Instance method | Private | Method | Publish Notification Internal | 20130306 |
| 3 | VALIDATE_INPUT |
Instance method | Private | Method | Publish Notification Internal | 20130306 |
Events
Class CL_RSBPC_EN_NOTIFICATION_API has no event.
Types
Class CL_RSBPC_EN_NOTIFICATION_API has no local type.
Method Signatures
Method PUBLISH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_WARNINGS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_NOTIF_CHANNEL_WARN | POA SBC E&N warnings about failed notifcations | 20130306 | ||
| 2 |  Importing |
IS_TEMPLATE | Call by reference | Type reference (TYPE) | BPCEN_S_TEMPLATE | 20130306 | |||
| 3 | Importing |
IT_ATTACHMENTS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_ATTACHMENTS | E&N Attachment's | 20130306 | ||
| 4 | Importing |
IT_RECIPIENTS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_RECIPIENTS | Recipients(Users,Email,etc..) | 20130306 | ||
| 5 | Importing |
IV_EXPIRES_ON | Call by reference | Type reference (TYPE) | XSDDATE_D | Expiration Date in UTC | 20130306 | ||
| 6 | Importing |
IV_FROM_ADDRESS | Call by reference | Type reference (TYPE) | XUBNAME | From User | 20130306 | ||
| 7 | Importing |
IV_MESSAGE_TYPE | Call by reference | Type reference (TYPE) | RSBPC_EN_MESSAGE_TYPE | E&N Message Type | 20130306 | ||
| 8 | Importing |
IV_NOTIFICATION_TYPE | Call by reference | Type reference (TYPE) | RSBPC_EN_NOTIF_TYPE | 'DEFAULT_TYPE' | Notification Type | 20130306 | |
| 9 | Importing |
IV_PAYLOAD | Call by reference | Type reference (TYPE) | XSTRING | Payload, this has to be XML in conforming to the message XML | 20130306 | ||
| 10 | Importing |
IV_PRIORITY | Call by reference | Type reference (TYPE) | RSBPC_EN_PRIORITY | '3' | E&N Priority (Default=Medium) | 20130306 | |
| 11 | Importing |
IV_SOURCE_APP | Call by reference | Type reference (TYPE) | RSBPC_EN_SOURCE_APP | Notification Source Application | 20130306 | ||
| 12 | Importing |
IV_SOURCE_DOC | Call by reference | Type reference (TYPE) | RSBPC_EN_SOURCE | Notification Source Document | 20130306 | ||
| 13 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Time stamp, a null value is the current time on the server | 20130306 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_RSBPC_EN_INVAL_NOTIF_FAULT |
POA SNC E&N InvalidNotificationFault | 20130417 |
Method PUBLISH_INTERNAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_WARNINGS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_NOTIF_CHANNEL_WARN | POA SBC E&N warnings about failed notifcations | 20130306 | ||
| 2 | Importing |
IS_TEMPLATE | Call by reference | Type reference (TYPE) | BPCEN_S_TEMPLATE | 20130306 | |||
| 3 | Importing |
IT_ATTACHMENTS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_ATTACHMENTS | POA SBC E&N Attachment Uri's | 20130306 | ||
| 4 | Importing |
IT_RECIPIENTS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_RECIPIENTS | POA SBC E&N Recipients (SAP Users) | 20130306 | ||
| 5 | Importing |
IV_EVENT_TYPE_STR | Call by reference | Type reference (TYPE) | RSBPC_EN_EVENT_TYPE | The event type (determines the schema that is accepted ) | 20130306 | ||
| 6 | Importing |
IV_EXPIRES_ON | Call by reference | Type reference (TYPE) | TZNTSTMPS | 20130306 | |||
| 7 | Importing |
IV_MESSAGE_TYPE | Call by reference | Type reference (TYPE) | RSBPC_EN_MESSAGE_TYPE | POA SBC E&N Message Type | 20130306 | ||
| 8 | Importing |
IV_PAYLOAD | Call by reference | Type reference (TYPE) | XSTRING | Payload, this has to be XML in conforming to the message XML | 20130306 | ||
| 9 | Importing |
IV_PRIORITY | Call by reference | Type reference (TYPE) | RSBPC_EN_PRIORITY | POA SBC E&N Priority | 20130306 | ||
| 10 | Importing |
IV_SOURCE | Call by reference | Type reference (TYPE) | RSBPC_EN_SOURCE | The Notification Source | 20130306 | ||
| 11 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Time stamp, a null value is the current time on the server | 20130306 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_RSBPC_EN_INVAL_NOTIF_FAULT |
POA SNC E&N InvalidNotificationFault | 20130417 |
Method VALIDATE_INPUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_TEMPLATE | Call by reference | Type reference (TYPE) | BPCEN_S_TEMPLATE | 20130306 | |||
| 2 | Importing |
IT_ATTACHMENTS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_ATTACHMENTS | POA SBC E&N Attachments | 20130306 | ||
| 3 | Importing |
IT_RECIPIENTS | Call by reference | Type reference (TYPE) | RSBPC_EN_T_RECIPIENTS | POA SBC E&N Recipients (SAP Users) | 20130306 | ||
| 4 | Importing |
IV_EVENT_TYPE_STR | Call by reference | Type reference (TYPE) | RSBPC_EN_EVENT_TYPE | The event type (determines the schema that is accepted ) | 20130306 | ||
| 5 | Importing |
IV_EXPIRES_ON | Call by reference | Type reference (TYPE) | TZNTSTMPS | 20130306 | |||
| 6 | Importing |
IV_MESSAGE_TYPE | Call by reference | Type reference (TYPE) | RSBPC_EN_MESSAGE_TYPE | POA SBC E&N Message Type | 20130306 | ||
| 7 | Importing |
IV_PAYLOAD | Call by reference | Type reference (TYPE) | XSTRING | Payload, this has to be XML in conforming to the message XML | 20130306 | ||
| 8 | Importing |
IV_PRIORITY | Call by reference | Type reference (TYPE) | RSBPC_EN_PRIORITY | POA SBC E&N Priority | 20130306 | ||
| 9 | Importing |
IV_SOURCE | Call by reference | Type reference (TYPE) | RSBPC_EN_SOURCE | The Notification Source | 20130306 | ||
| 10 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Time stamp, a null value is the current time on the server | 20130306 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_RSBPC_EN_INVAL_NOTIF_FAULT |
POA SNC E&N InvalidNotificationFault | 20130417 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |
