SAP ABAP Class CL_VBI_MESSAGE_COLLECTOR (Object for collecting messages)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-VBZ (Application Component) Visual Business -> please use CA-GTF-VBZ
⤷
VBI_CORE_IMPL (Package) Visual Business Core Object Implementations
⤷
⤷
Properties
| Class | CL_VBI_MESSAGE_COLLECTOR | |
| Short Description | Object for collecting messages | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | VBI_CORE_IMPL | Visual Business Core Object Implementations |
| Created | 20130418 | SAP |
| Last change | 20131127 | 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
Class CL_VBI_MESSAGE_COLLECTOR has no interface implemented.
Friends
Class CL_VBI_MESSAGE_COLLECTOR has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_VBI_MESSAGE_COLLECTOR | Object for collecting messages | 20130418 | |||
| 2 | Instance attribute | Private | Type reference (TYPE) | VBI_T_MESSAGES | Message table | 20130418 | |||
| 3 | Static Attribute | Public | Type reference (TYPE) | STRING | Text for next SY Message | 20130418 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add a message | 20130418 | |
| 2 | Instance method | Public | Method | Add last message tfrom SY fields | 20130418 | |
| 3 | Static method | Public | Method | Returns the instance of the active collector | 20130418 | |
| 4 | Instance method | Public | Method | Returns the last added message | 20130418 | |
| 5 | Instance method | Public | Method | Returns messages respecting type filter | 20130418 | |
| 6 | Instance method | Public | Method | Checks if messages exist | 20130418 | |
| 7 | Static method | Public | Method | Starts a new message collection | 20130418 |
Events
Class CL_VBI_MESSAGE_COLLECTOR has no event.
Types
Class CL_VBI_MESSAGE_COLLECTOR has no local type.
Method Signatures
Method ADD_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MSG_ID | Call by reference | Type reference (TYPE) | SYMSGID | 20130418 | ||||
| 2 | IV_MSG_NO | Call by reference | Type reference (TYPE) | SYMSGNO | 20130418 | ||||
| 3 | IV_MSG_TEXT | Call by reference | Type reference (TYPE) | STRING | Provide text for messages not known in the system | 20130418 | |||
| 4 | IV_MSG_TYPE | Call by reference | Type reference (TYPE) | SYMSGTY | 'S' | 20130418 | |||
| 5 | IV_MSG_V1 | Call by reference | Type reference (TYPE) | SYMSGV | 20130418 | ||||
| 6 | IV_MSG_V2 | Call by reference | Type reference (TYPE) | SYMSGV | 20130418 | ||||
| 7 | IV_MSG_V3 | Call by reference | Type reference (TYPE) | SYMSGV | 20130418 | ||||
| 8 | IV_MSG_V4 | Call by reference | Type reference (TYPE) | SYMSGV | 20130418 |
Method ADD_MESSAGE on class CL_VBI_MESSAGE_COLLECTOR has no exception.
Method ADD_SY_MESSAGE Signature
Method ADD_SY_MESSAGE on class CL_VBI_MESSAGE_COLLECTOR has no parameter.
Method ADD_SY_MESSAGE on class CL_VBI_MESSAGE_COLLECTOR has no exception.
Method GET_CURRENT_COLLECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_RESULT | Value transfer | Object reference (TYPE REF TO) | CL_VBI_MESSAGE_COLLECTOR | Object for collecting messages | 20130418 |
Method GET_CURRENT_COLLECTOR on class CL_VBI_MESSAGE_COLLECTOR has no exception.
Method GET_LAST_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_RESULT | Value transfer | Type reference (TYPE) | VBI_S_MESSAGE | Message structure | 20130418 |
Method GET_LAST_MESSAGE on class CL_VBI_MESSAGE_COLLECTOR has no exception.
Method GET_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MSG_TYPE | Call by reference | Type reference (TYPE) | SYMSGTY | Message Type Filter | 20130418 | |||
| 2 | RT_RESULT | Value transfer | Type reference (TYPE) | VBI_T_MESSAGES | Message table | 20130418 |
Method GET_MESSAGES on class CL_VBI_MESSAGE_COLLECTOR has no exception.
Method HAS_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20130418 |
Method HAS_MESSAGES on class CL_VBI_MESSAGE_COLLECTOR has no exception.
Method START_NEW_COLLECTION Signature
Method START_NEW_COLLECTION on class CL_VBI_MESSAGE_COLLECTOR has no parameter.
Method START_NEW_COLLECTION on class CL_VBI_MESSAGE_COLLECTOR has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 100 |