SAP ABAP Interface IF_ALERT_CATEGORY_API (ALM API: Alert Category)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-GBT-ALM (Application Component) Alert Framework
     ⤷ SALERT_CUST_API (Package) API for Reading and Writing Customizing
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_ALERT_CAT Alerts: Alert Category 20040708
Properties
Interface IF_ALERT_CATEGORY_API  
Short Description ALM API: Alert Category    
General Data
Package SALERT_CUST_API   API for Reading and Writing Customizing 
Created 20040705   SAP 
Last changed 20060207   SAP 
Unicode checks active    
Forward declarations
Interface IF_ALERT_CATEGORY_API has no forward declaration.
Interfaces
Interface IF_ALERT_CATEGORY_API has no interface.
Friends
Interface IF_ALERT_CATEGORY_API has no friend.
Attributes
Interface IF_ALERT_CATEGORY_API has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CREATE_ACTIVITY Instance method Public Method Generates a New Follow-On Activity 20040705
2 CREATE_ALERT_RECIPIENT Instance method Public Method Generates a New Alert Recipient 20040705
3 DELETE_ACTIVITY Instance method Public Method Deletes a Follow-On Activity 20040705
4 DELETE_ALERT_RECIPIENT Instance method Public Method Deletes an Alert Recipient 20040705
5 GET_ACTIVITIES Instance method Public Method Returns all follow-on activities 20040705
6 GET_ACTIVITY Instance method Public Method Returns a Follow-On Activity for a Key 20040816
7 GET_ALERT_RECIPIENT Instance method Public Method Returns an Alert Recipient for a Key 20040816
8 GET_ALERT_RECIPIENTS Instance method Public Method Returns all Alert Recipients 20040705
9 GET_ALIAS Instance method Public Method Returns the Alias of the Category 20041202
10 GET_AS_STRUCTURE Instance method Public Method Returns Object Data as a Structure 20040812
11 GET_CLASSIFICATION Instance method Public Method Returns Alert Classification of the Category 20040705
12 GET_DESCRIPTION Instance method Public Method Returns Description of the Category 20040705
13 GET_DEVCLASS Instance method Public Method Returns the application package of the category 20051116
14 GET_ESCALATION Instance method Public Method Returns Escalation Mechanism 20040705
15 GET_EXPIRY_TIME Instance method Public Method Returns Expiry Time for the Alerts of the Category 20040705
16 GET_MAX_DELIVERY Instance method Public Method Returns Maximum Number of Delivery Attempts 20040705
17 GET_ORIGLANG Instance method Public Method Returns the original language of the category 20051116
18 GET_PRIORITY Instance method Public Method Returns Priority of the Category 20040705
19 GET_STATIC_TEXTS Instance method Public Method Returns the Used Static Texts 20040705
20 GET_TECHNICAL_NAME Instance method Public Method Returns Technical Name of the Category 20040705
21 GET_USE_DYNAMIC_TEXT Instance method Public Method Returns Flag for Use of Dynamic Text 20040705
22 GET_WORKFLOW_CONTAINER Instance method Public Method Returns Workflow Container 20040827
23 SET_ALIAS Instance method Public Method Sets Alias of the Category 20041202
24 SET_AS_STRUCTURE Instance method Public Method Sets Object Data from a Structure 20040812
25 SET_CLASSIFICATION Instance method Public Method Sets Alert Classification of the Category 20040705
26 SET_DESCRIPTION Instance method Public Method Sets Description of the Category 20040705
27 SET_DEVCLASS Instance method Public Method Sets the application package of the category 20051116
28 SET_EXPIRY_TIME Instance method Public Method Sets Expiry Time for the Alerts of the Category 20040705
29 SET_MAX_DELIVERY Instance method Public Method Sets Maximum Number of Delivery Attempts 20040705
30 SET_ORIGLANG Instance method Public Method Sets the original language of the category 20051116
31 SET_PRIORITY Instance method Public Method Sets Priority of the Category 20040705
32 SET_USE_DYNAMIC_TEXT Instance method Public Method Sets Flag for the Use of Dynamic Text 20040705
33 SET_WORKFLOW_CONTAINER Instance method Public Method Sets Workflow Container 20040827
Events
Interface IF_ALERT_CATEGORY_API has no event.
Types
Interface IF_ALERT_CATEGORY_API has no local type.
Method Signatures

Method CREATE_ACTIVITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RI_ACTIVITY Value transfer Object reference (TYPE REF TO) IF_ALERT_ACTIVITY_API ALM-API: Folgeaktivitäten 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728
2 CX_ALERT_CUST_OBJ_EXISTS_API Alert: Objekt existiert bereits 20040728

Method CREATE_ALERT_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_ROLE_NAME Call by reference Type reference (TYPE) SALERTDROLENAME ALM-API: Name einer Rolle (Typ 'R' und 'S') 20040705
2 Importing IP_TYPE Call by reference Type reference (TYPE) SALERTDRECTYPE Typ des Alert-Empfängers 20040705
3 Importing IP_USER_NAME Call by reference Type reference (TYPE) SALRTDRCPT Alert-Empfänger (Typ 'I') 20040705
4 Returning RI_RECIPIENT Value transfer Object reference (TYPE REF TO) IF_ALERT_RECIPIENT_API ALM-API: Empfänger 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728
2 CX_ALERT_CUST_OBJ_EXISTS_API Alert: Objekt existiert bereits 20040728

Method DELETE_ACTIVITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_ACTIVITY Call by reference Object reference (TYPE REF TO) IF_ALERT_ACTIVITY_API ALM-API: Folgeaktivitäten 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728
2 CX_ALERT_CUST_OBJ_UNKNOWN_API Alert: Angegebenes Objekt existiert nicht 20040728

Method DELETE_ALERT_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_RECIPIENT Call by reference Object reference (TYPE REF TO) IF_ALERT_RECIPIENT_API ALM-API: Empfänger 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728
2 CX_ALERT_CUST_OBJ_UNKNOWN_API Alert: Angegebenes Objekt existiert nicht 20040728

Method GET_ACTIVITIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_ACTIVITIES Value transfer Type reference (TYPE) SALERTTIFACTIVITY Liste mit Referenzen auf die Folgeaktivitäten 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_ACTIVITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_LINK_NUMBER Call by reference Type reference (TYPE) SALRTDFLNO Laufende Nummer der Folgeaktivität 20040816
2 Returning RI_ACTIVITY Value transfer Object reference (TYPE REF TO) IF_ALERT_ACTIVITY_API ALM-API: Folgeaktivitäten - Link 20040816
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040816
2 CX_ALERT_CUST_OBJ_UNKNOWN_API Alert: Angegebenes Objekt existiert nicht 20040816

Method GET_ALERT_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_ROLE_NAME Call by reference Type reference (TYPE) SALERTDROLENAME ALM-API: Name einer Rolle (Typ 'R' und 'S') 20040816
2 Importing IP_TYPE Call by reference Type reference (TYPE) SALERTDRECTYPE ALM-API: Typ des Empfängers 20040816
3 Importing IP_USER_NAME Call by reference Type reference (TYPE) SALRTDRCPT Alert-Empfänger (Typ 'I') 20040816
4 Returning RI_RECIPIENT Value transfer Object reference (TYPE REF TO) IF_ALERT_RECIPIENT_API ALM-API: Empfänger 20040816
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040816
2 CX_ALERT_CUST_OBJ_UNKNOWN_API Alert: Angegebenes Objekt existiert nicht 20040816

Method GET_ALERT_RECIPIENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_TYPE Call by reference Type reference (TYPE) SALERTDRECTYPE SPACE: Alle 20040715
2 Returning RT_RECIPIENTS Value transfer Type reference (TYPE) SALERTTIFRECIPIENT Liste mit Referenzen auf Empfänger 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_ALIAS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_ALIAS Value transfer Type reference (TYPE) SALERTDALIAS ALM: Langer Name einer Alert-Kategorie 20041202
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20041202

Method GET_AS_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_LANGUAGE Call by reference Type reference (TYPE) SYLANGU SY-LANGU Sprachenschlüssel der aktuellen Textumgebung 20040812
2 Returning RP_CATEGORY_STRUCTURE Value transfer Type reference (TYPE) SALERTSCATEGORY ALM-API: Alert-Kategorie ohne Texte und Empfänger 20040812
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040812

Method GET_CLASSIFICATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RI_CLASSIFICATION Value transfer Object reference (TYPE REF TO) IF_ALERT_CLASSIFICATION_API Alert-Klassifikation 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_LANGUAGE Call by reference Type reference (TYPE) SYLANGU SY-LANGU Sprache der Beschreibung 20040705
2 Returning RP_DESCRIPTION Value transfer Type reference (TYPE) SALRTDCATD Beschreibung der Alert-Kategorie 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_DEVCLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_DEVCLASS Value transfer Type reference (TYPE) SALRTDDEVCLASS Anwendungspaket der Alert-Kategorie 20051116
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20051116

Method GET_ESCALATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RI_ESCALATION Value transfer Object reference (TYPE REF TO) IF_ALERT_ESCALATION_API Referenz zur Alert-Eskalation 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_EXPIRY_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_EXPIRY_TIME Value transfer Type reference (TYPE) SALRTDEXPI Verfallszeit in Minuten 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_MAX_DELIVERY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_MAX_DELIVERY Value transfer Type reference (TYPE) SALRTDMAXD Maximale Anzahl der Alert-Zustellung 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_ORIGLANG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_ORIGLANG Value transfer Type reference (TYPE) SALRTDORIGLANG Originalsprache der Alert-Kategorie 20051116
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20051116

Method GET_PRIORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_PRIORITY Value transfer Type reference (TYPE) SALRTDPRIO Priorität eines Alerts 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_STATIC_TEXTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RI_STATIC_TEXTS Value transfer Object reference (TYPE REF TO) IF_ALERT_TEXT_API Statische Texte der Kategorie 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_TECHNICAL_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_TECHNICAL_NAME Value transfer Type reference (TYPE) SALRTDCAT Alert-Kategorie 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_USE_DYNAMIC_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_USE_DYNAMIC_TEXT Value transfer Type reference (TYPE) SALRTDDYTX Verwende dynamische Texte? 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method GET_WORKFLOW_CONTAINER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RI_CUST_CONTAINER Value transfer Object reference (TYPE REF TO) IF_SWF_CNT_CONTAINER Referenz auf den Workflow-Container 20040827
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040827

Method SET_ALIAS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_ALIAS Call by reference Type reference (TYPE) SALERTDALIAS ALM: Langer Name einer Alert-Kategorie 20041202
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20041202
2 CX_ALERT_CUST_OBJ_EXISTS_API Alert: Objekt existiert bereits 20041202

Method SET_AS_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_LANGUAGE Call by reference Type reference (TYPE) SYLANGU SY-LANGU Sprachenschlüssel der aktuellen Textumgebung 20040812
2 Importing IS_CATEGORY_STRUCTURE Call by reference Type reference (TYPE) SALERTSCATEGORY ALM-API: Alert-Kategorie ohne Texte und Empfänger 20040812
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040812
2 CX_ALERT_CUST_OBJ_EXISTS_API Alert: Objekt existiert bereits 20041203

Method SET_CLASSIFICATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_CLASSIFICATION Call by reference Object reference (TYPE REF TO) IF_ALERT_CLASSIFICATION_API Alert-Klassifikation 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method SET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_DESCRIPTION Call by reference Type reference (TYPE) SALRTDCATD Beschreibung der Alert-Kategorie 20040705
2 Importing IP_LANGUAGE Call by reference Type reference (TYPE) SYLANGU SY-LANGU Sprache der Beschreibung 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method SET_DEVCLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_DEVCLASS Call by reference Type reference (TYPE) SALRTDDEVCLASS Anwendungspaket der Alert-Kategorie 20051116
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20051116

Method SET_EXPIRY_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_EXPIRY_TIME Call by reference Type reference (TYPE) SALRTDEXPI Verfallszeit in Minuten 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method SET_MAX_DELIVERY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_MAX_DELIVERY Call by reference Type reference (TYPE) SALRTDMAXD Maximale Anzahl der Alert-Zustellung 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method SET_ORIGLANG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_ORIGLANG Call by reference Type reference (TYPE) SALRTDORIGLANG Originalsprache der Alert-Kategorie 20051116
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20051116

Method SET_PRIORITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_PRIORITY Call by reference Type reference (TYPE) SALRTDPRIO Priorität eines Alerts 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method SET_USE_DYNAMIC_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_USE_DYNAMIC_TEXT Call by reference Type reference (TYPE) SALRTDDYTX Verwende dynamische Texte? 20040705
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040728

Method SET_WORKFLOW_CONTAINER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_CUST_CONTAINER Call by reference Object reference (TYPE REF TO) IF_SWF_CNT_CONTAINER Referenz auf den Workflow-Container 20040827
# Exception Resumable Description Created on
1 CX_ALERT_CUST_API ALM-API: Allgemeiner Fehler 20040827
History
Last changed by/on SAP  20060207 
SAP Release Created in 700