SAP ABAP Interface IF_FDT_WD_ISLAND_MESSAGE (FDT WD Island: Message)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
⤷
SFDT_WD_ISLAND_INFRASTRUCTURE (Package) BRFplus: Island Infrastructure
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules⤷
SFDT_WD_ISLAND_INFRASTRUCTURE (Package) BRFplus: Island Infrastructure
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_FDT_WD_ISLAND_MSG_ACTION | FDT WD Island: (User-)Action | 20111103 |
| 2 | Interface composition (i COMPRISING i_ref) | IF_FDT_WD_ISLAND_MSG_CREATE | FDT WD Island: Message for creating new objects | 20100810 |
| 3 | Interface composition (i COMPRISING i_ref) | IF_FDT_WD_ISLAND_MSG_INIT | FDT WD Island: Interface for Initialize Contorl Message | 20120601 |
| 4 | Interface composition (i COMPRISING i_ref) | IF_FDT_WD_ISLAND_MSG_NAVIGATE | FDT WD Island: Interface for Navigate Message | 20100810 |
| 5 | Interface composition (i COMPRISING i_ref) | IF_FDT_WD_ISLAND_MSG_QUERY | FDT WD Island: Message for querying objects | 20120316 |
| 6 | Interface composition (i COMPRISING i_ref) | IF_FDT_WD_ISLAND_MSG_SYNC | FDT WD Island: Sync Message | 20111014 |
| 7 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FDT_WD_ISLAND_MESSAGE | FDT WD Island: Message | 20100623 |
Properties
| Interface | IF_FDT_WD_ISLAND_MESSAGE | |
| Short Description | FDT WD Island: Message |
General Data
| Package | SFDT_WD_ISLAND_INFRASTRUCTURE | BRFplus: Island Infrastructure |
| Created | 20100619 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | IF_FDT_TYPES | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Interface IF_FDT_WD_ISLAND_MESSAGE has no interface.
Friends
Interface IF_FDT_WD_ISLAND_MESSAGE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ACTION_CREATE_OBJECT | Constant | Public | Type reference (TYPE) | STRING | 'create_object' | 20110427 | ||
| 2 | GC_ACTION_INIT_CONTROL | Constant | Public | Type reference (TYPE) | STRING | 'initial' | Init Control Action | 20110629 | |
| 3 | GC_ACTION_NAVIGATE_TO_OBJECT | Constant | Public | Type reference (TYPE) | STRING | 'navigate_to_object' | 20110427 | ||
| 4 | GC_ACTION_QUERY_OBJECT | Constant | Public | Type reference (TYPE) | STRING | 'query_object' | Query Object | 20120312 | |
| 5 | GC_ACTION_SYNCHRONIZE | Constant | Public | Type reference (TYPE) | STRING | 'synchronize' | 20101109 | ||
| 6 | GC_ACTION_USER_ACTION | Constant | Public | Type reference (TYPE) | STRING | 'user_action' | 20111109 | ||
| 7 | GC_MESSAGE_ORIGIN_ABAP | Constant | Public | Type reference (TYPE) | STRING | 'ABAP' | Origin is ABAP Backend | 20110309 | |
| 8 | GC_MESSAGE_ORIGIN_ISLAND | Constant | Public | Type reference (TYPE) | STRING | 'ISLAND' | Origin is Island(Silverlight) | 20110309 | |
| 9 | GC_MESSAGE_STATE_CANCEL | Constant | Public | Type reference (TYPE) | MESSAGE_STATE | 2 | 20110420 | ||
| 10 | GC_MESSAGE_STATE_ERROR | Constant | Public | Type reference (TYPE) | MESSAGE_STATE | 1 | 20110506 | ||
| 11 | GC_MESSAGE_STATE_SUCCESS | Constant | Public | Type reference (TYPE) | MESSAGE_STATE | 0 | 20110420 | ||
| 12 | GC_MESSAGE_TYPE_REQUEST | Constant | Public | Type reference (TYPE) | STRING | 'request' | 20100624 | ||
| 13 | GC_MESSAGE_TYPE_RESPONSE | Constant | Public | Type reference (TYPE) | STRING | 'response' | 20100624 | ||
| 14 | MO_PARENT_CONTENT | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FDT_WD_ISLAND_MESSAGE | Parent Content | 20111109 | ||
| 15 | MO_PARENT_MESSAGE | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FDT_WD_ISLAND_MESSAGE | Parent Message | 20111110 | ||
| 16 | MO_PREVIOUS_REQUEST | Instance attribute | Public | Object reference (TYPE REF TO) | IF_FDT_WD_ISLAND_MESSAGE | Previous request | 20111111 | ||
| 17 | MS_MESSAGE_STATE | Instance attribute | Public | Type reference (TYPE) | S_MESSAGE_STATE | 20110420 | |||
| 18 | MV_CONTROL_NAME | Instance attribute | Public | Type reference (TYPE) | STRING | Control Name | 20110620 | ||
| 19 | MV_ID | Instance attribute | Public | Type reference (TYPE) | IF_FDT_TYPES=>ID | ID of object | 20111130 | ||
| 20 | MV_IS_ROOT_CONTROL | Instance attribute | Public | Type reference (TYPE) | BOOLE_D | True: is root control | 20111216 | ||
| 21 | MV_MESSAGE_ACTION | Instance attribute | Public | Type reference (TYPE) | STRING | Message Action | 20110304 | ||
| 22 | MV_MESSAGE_ID | Instance attribute | Public | Type reference (TYPE) | MESSAGE_ID | Message Id | 20110628 | ||
| 23 | MV_MESSAGE_ORIGIN | Instance attribute | Public | Type reference (TYPE) | STRING | Origin of Message | 20110304 | ||
| 24 | MV_MESSAGE_TYPE | Instance attribute | Public | Type reference (TYPE) | STRING | Message Type | 20110304 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_RESPONSE_CANCEL |
Instance method | Public | Method | Creates the response message to be sent with cancel state | 20121001 |
| 2 | CREATE_RESPONSE_ERROR |
Instance method | Public | Method | Creates the response message to be sent with error state | 20121001 |
| 3 | CREATE_RESPONSE_SUCCESS |
Instance method | Public | Method | Creates the response message to be sent with success state | 20121001 |
| 4 | GET_XML_READER |
Instance method | Public | Method | Returns the xml reader to read content | 20110412 |
| 5 | GET_XML_WRITER |
Instance method | Public | Method | Returns the xml writer to write content | 20110411 |
| 6 | IS_RESPONSE_NEEDED |
Instance method | Public | Method | Returns if a response has to be send | 20120601 |
Events
Interface IF_FDT_WD_ISLAND_MESSAGE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | MESSAGE_ID | Public | Type reference (TYPE) | SYSUUID_C | UUID in character form | 20110628 | |
| 2 | MESSAGE_STATE | Public | Type reference (TYPE) | I | 20110420 | |
|
| 3 | S_MESSAGE_STATE | Public | See coding | 20110420 | BEGIN OF s_message_state,
state TYPE message_state,
exception TYPE REF TO cx_fdt_wd, "Exception is present only when it is from the abap stack
suppress_message TYPE abap_bool, "true: suppress the display of the message of the exception
END OF s_message_state
|
Method Signatures
Method CREATE_RESPONSE_CANCEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RO_RESPONSE | Value transfer | Object reference (TYPE REF TO) | IF_FDT_WD_ISLAND_MESSAGE | FDT WD Island: Message | 20121001 |
Method CREATE_RESPONSE_CANCEL on Interface IF_FDT_WD_ISLAND_MESSAGE has no exception.
Method CREATE_RESPONSE_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_SUPPRESS_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20121001 | ||
| 2 | Importing |
IX_ERROR | Call by reference | Object reference (TYPE REF TO) | CX_FDT_WD | FDT WD: Root Exception Class for WD UI | 20121001 | ||
| 3 | Returning |
RO_RESPONSE | Value transfer | Object reference (TYPE REF TO) | IF_FDT_WD_ISLAND_MESSAGE | FDT WD Island: Message | 20121001 |
Method CREATE_RESPONSE_ERROR on Interface IF_FDT_WD_ISLAND_MESSAGE has no exception.
Method CREATE_RESPONSE_SUCCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_RESPONSE | Value transfer | Object reference (TYPE REF TO) | IF_FDT_WD_ISLAND_MESSAGE | FDT WD Island: Message | 20121001 |
Method CREATE_RESPONSE_SUCCESS on Interface IF_FDT_WD_ISLAND_MESSAGE has no exception.
Method GET_XML_READER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_XML_READER | Value transfer | Object reference (TYPE REF TO) | IF_SXML_READER | SXML Reader Interface | 20110412 |
Method GET_XML_READER on Interface IF_FDT_WD_ISLAND_MESSAGE has no exception.
Method GET_XML_WRITER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_XML_WRITER | Value transfer | Object reference (TYPE REF TO) | IF_SXML_WRITER | SXML Writer Interface | 20110411 |
Method GET_XML_WRITER on Interface IF_FDT_WD_ISLAND_MESSAGE has no exception.
Method IS_RESPONSE_NEEDED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_RESPONSE_NEEDED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20120601 |
Method IS_RESPONSE_NEEDED on Interface IF_FDT_WD_ISLAND_MESSAGE has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 703 |
