SAP ABAP Class CL_ALERT_CONF_MANAGER_API (ALM API: API for Reading and Changing the Alert Landscape)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-GBT-ALM (Application Component) Alert Framework
⤷
SALERT_CONF_API (Package) API for Reading and Writing Landscape Configuration
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ALERT_CENTRAL_SERVER_API | ALM API: Central Alert Server Settings | 20040809 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ALERT_EXTERNAL_SYSTEM_API | ALM API: External Alert System Settings | 20040809 |
Properties
| Class | CL_ALERT_CONF_MANAGER_API | |
| Short Description | ALM API: API for Reading and Changing the Alert Landscape | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SALERT_CONF_API | API for Reading and Writing Landscape Configuration |
| Created | 20040809 | SAP |
| Last change | 20040930 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ALERT_CENTRAL_SERVER_API | ALM API: Central Alert Server Settings | 20040809 | ||
| 2 | IF_ALERT_EXTERNAL_SYSTEM_API | ALM API: External Alert System Settings | 20040809 |
Friends
Class CL_ALERT_CONF_MANAGER_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | SALERTDPROCESSING | 'H' | External Alert System (Forwarding using HTTP) | 20040810 | ||
| 2 | Constant | Public | Type reference (TYPE) | SALERTDPROCESSING | 'S' | External Alert System (Forwarding using SMTP) | 20040810 | ||
| 3 | Constant | Public | Type reference (TYPE) | SALERTDPROCESSING | 'I' | Internal Alert Processing | 20040810 | ||
| 4 | Static Attribute | Protected | Object reference (TYPE REF TO) | CL_ALERT_CONF_MANAGER_API | Singleton | 20040809 | |||
| 5 | Instance attribute | Protected | Type reference (TYPE) | SALRTSCONF | Alerts: Configuration Structure | 20040809 | |||
| 6 | Instance attribute | Protected | Type reference (TYPE) | SALRTDRFCD | RFC Destination of the Alert Server | 20040809 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | CONSTRUCTOR | 20040809 | |
| 2 | Instance method | Public | Method | Returns a Reference to the Central Alert Server | 20040809 | |
| 3 | Instance method | Public | Method | Returns RFC Destination for the Central Alert Server | 20040809 | |
| 4 | Static method | Public | Method | Returns an Instance of the Manager Class | 20040809 | |
| 5 | Instance method | Public | Method | Checks whether current system is the Central Alert Server | 20040809 | |
| 6 | Instance method | Public | Method | Sets the RFC destination for the Central Alert Server | 20040809 |
Events
Class CL_ALERT_CONF_MANAGER_API has no event.
Types
Class CL_ALERT_CONF_MANAGER_API has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_RFC_DESTINATION | Call by reference | Type reference (TYPE) | SALRTDRFCD | RFC Destination des Alert-Servers | 20040810 | |||
| 2 | IS_CENTRAL_CONFIGURATION | Call by reference | Type reference (TYPE) | SALRTSCONF | Alerts: Konfiguration | 20040810 |
Method CONSTRUCTOR on class CL_ALERT_CONF_MANAGER_API has no exception.
Method GET_CENTRAL_SERVER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RI_CENTRAL_SERVER | Value transfer | Object reference (TYPE REF TO) | IF_ALERT_CENTRAL_SERVER_API | ALM-API: Einstellungen des zentralen Alert-Servers | 20040809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ALM-API: Allgemeiner Fehler | 20040810 |
Method GET_CENTRAL_SERVER_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_CENTRAL_SERVER_DESTINATION | Value transfer | Type reference (TYPE) | SALRTDRFCD | RFC Destination des Alert-Servers | 20040809 |
Method GET_CENTRAL_SERVER_DESTINATION on class CL_ALERT_CONF_MANAGER_API has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_CONF_MANAGER | Value transfer | Object reference (TYPE REF TO) | CL_ALERT_CONF_MANAGER_API | ALM-API: API zum Lesen und Ändern der Alert-Landschaft | 20040809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ALM-API: Allgemeiner Fehler | 20040810 |
Method IS_CENTRAL_SERVER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_IS_CENTRAL_SERVER | Value transfer | Type reference (TYPE) | SALERTDISCENTRAL | ALM-API: Prüfkennzeichen für den zentralen Alert-Server | 20040809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ALM-API: Allgemeiner Fehler | 20040810 |
Method SET_CENTRAL_SERVER_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_CENTRAL_SERVER_DESTINATION | Call by reference | Type reference (TYPE) | SALRTDRFCD | RFC Destination des Alert-Servers | 20040809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ALM-API: Allgemeiner Fehler | 20040810 |
History
| Last changed by/on | SAP | 20040930 |
| SAP Release Created in | 700 |