SAP ABAP Class CL_AXT_MESSAGE_PUBLISHER (Service class for publishing messages)
Hierarchy
☛
WEBCUIF (Software Component) SAP Web UI Framework
⤷
CA-GTF-EEW (Application Component) Easy Enhancement Workbench
⤷
AXT_COMMON (Package) Common Extensibility objects
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_AXT_GEN_MESSAGE_PUBLISHER | Defines an event for publishing messages | 20080514 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_AXT_MESSAGE_PUBLISHER | Defines an event for publishing messages | 20080512 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_AXT_GEN_MESSAGE_PUBLISHER | Generation framework message publisher | 20080514 |
Properties
| Class | CL_AXT_MESSAGE_PUBLISHER | |
| Short Description | Service class for publishing messages | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | AXT_COMMON | Common Extensibility objects |
| Created | 20080512 | SAP |
| Last change | 20100303 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_AXT_GEN_MESSAGE_PUBLISHER | Defines an event for publishing messages | 20080514 | ||
| 2 | IF_AXT_MESSAGE_PUBLISHER | Defines an event for publishing messages | 20080512 |
Friends
Class CL_AXT_MESSAGE_PUBLISHER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Protected | Object reference (TYPE REF TO) | CL_AXT_CONSTANTS | Constants | 20080512 | |||
| 2 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_AXT_MESSAGE_PUBLISHER | Service class for publishing messages | 20080514 | |||
| 3 | Static Attribute | Protected | Object reference (TYPE REF TO) | CL_AXT_SERVICES | Service methods | 20080512 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20080512 | |
| 2 | Instance method | Public | Method | Free a listener from publisher's events | 20080514 | |
| 3 | Static method | Public | Method | Returns an instance | 20080512 | |
| 4 | Instance method | Public | Method | Raise the event IF_AXT_MESSAGE_PUBLISHER~CLEAR_MESSAGES | 20080514 | |
| 5 | Instance method | Public | Method | Publishes the messages from all parameters | 20080514 | |
| 6 | Instance method | Public | Method | Registers a listener to publisher's events | 20080514 |
Events
Class CL_AXT_MESSAGE_PUBLISHER has no event.
Types
Class CL_AXT_MESSAGE_PUBLISHER has no local type.
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_AXT_MESSAGE_PUBLISHER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_AXT_MESSAGE_PUBLISHER has no exception.
Method FREE_LISTENER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_LISTENER | Call by reference | Object reference (TYPE REF TO) | IF_AXT_MESSAGE_LISTENER | Interface for event handling method | 20080514 |
Method FREE_LISTENER on class CL_AXT_MESSAGE_PUBLISHER has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_INSTANCE | Value transfer | Object reference (TYPE REF TO) | CL_AXT_MESSAGE_PUBLISHER | Service class for publishing messages | 20080512 |
Method GET_INSTANCE on class CL_AXT_MESSAGE_PUBLISHER has no exception.
Method RAISE_CLEAR_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CLEAR_ERROR | Call by reference | Type reference (TYPE) | AXT_BOOLEAN | CL_AXT_CONSTANTS=>GC_TRUE | Clears error messages | 20080514 | ||
| 2 | IV_CLEAR_SUCCESS | Call by reference | Type reference (TYPE) | AXT_BOOLEAN | CL_AXT_CONSTANTS=>GC_TRUE | Clears sucess messages | 20080514 | ||
| 3 | IV_CLEAR_WARNING | Call by reference | Type reference (TYPE) | AXT_BOOLEAN | CL_AXT_CONSTANTS=>GC_TRUE | Clears warning messages | 20080514 |
Method RAISE_CLEAR_MESSAGES on class CL_AXT_MESSAGE_PUBLISHER has no exception.
Method RAISE_PUBLISH_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_MESSAGES | Call by reference | Type reference (TYPE) | AXTT_MSG | Messages table | 20080514 | |||
| 2 | IV_CATALOGUE | Call by reference | Type reference (TYPE) | AXT_CATALOGUE_ID | Catalog ID | 20080514 | |||
| 3 | IV_EXTENSION | Call by reference | Type reference (TYPE) | AXT_EXTENSION_ID | Extension ID | 20080514 | |||
| 4 | IV_MSGID | Call by reference | Type reference (TYPE) | SYMSGID | Message Class | 20080514 | |||
| 5 | IV_MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | Message Number | 20080514 | |||
| 6 | IV_MSGTY | Call by reference | Type reference (TYPE) | SYMSGTY | Message Type | 20080514 | |||
| 7 | IV_MSGV1 | Call by reference | Type reference (TYPE) | ANY | Message variable &1 | 20080514 | |||
| 8 | IV_MSGV2 | Call by reference | Type reference (TYPE) | ANY | Message variable &2 | 20080514 | |||
| 9 | IV_MSGV3 | Call by reference | Type reference (TYPE) | ANY | Message variable &3 | 20080514 | |||
| 10 | IV_MSGV4 | Call by reference | Type reference (TYPE) | ANY | Message variable &4 | 20080514 | |||
| 11 | IV_MSG_FROM_SY | Call by reference | Type reference (TYPE) | AXT_BOOLEAN | Read message from sy | 20081118 | |||
| 12 | IV_OBJECT | Call by reference | Type reference (TYPE) | AXT_GUID | Object ID | 20080514 |
Method RAISE_PUBLISH_MESSAGES on class CL_AXT_MESSAGE_PUBLISHER has no exception.
Method REGISTER_LISTENER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_LISTENER | Call by reference | Object reference (TYPE REF TO) | IF_AXT_MESSAGE_LISTENER | Interface for event handling method | 20080514 |
Method REGISTER_LISTENER on class CL_AXT_MESSAGE_PUBLISHER has no exception.
History
| Last changed by/on | SAP | 20100303 |
| SAP Release Created in | 700 |