SAP ABAP Interface IF_FPM_MESSAGE_MANAGER (FPM message manager public use)
Hierarchy
SAP_UI (Software Component) User Interface Technology
   BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     APB_FPM_CORE (Package) Floorplan Manager (Framework)
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_FPM_MESSAGE_MANAGER FPM message manager with life cycle methods 20070513
2 Interface implementation (CLASS c. INTERFACES i_ref)  TD_BS_FPM_MESSAGE_MANAGER Test Double for IF_FPM_MESSAGE_MANAGER 20120531
Properties
Interface IF_FPM_MESSAGE_MANAGER  
Short Description FPM message manager public use    
General Data
Package APB_FPM_CORE   Floorplan Manager (Framework) 
Created 20070513   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_FPM_MESSAGE_MANAGER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Interface IF_FPM_MESSAGE_MANAGER has no interface.
Friends
Interface IF_FPM_MESSAGE_MANAGER has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_DEFAULT_FPM_DIALOG_VIEW Constant Public Type reference (TYPE) STRING 'FPM_DIALOG_WINDOW' View in which FPM messages will be reported in dialogs 20090130
2 GC_DEFAULT_FPM_VIEW Constant Public Type reference (TYPE) STRING 'FPM_WINDOW' View in which FPM messages will be reported 20080321
3 GC_LIFE_VISIBILITY_AUTOMATIC Constant Public Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY 'AUTOMATIC' Lifetime and Visibility controlled automatically by FPM 20070614
4 GC_LIFE_VISIBILITY_AUT_POPUP Constant Public Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY 'AUT_POPUP' Life time and visibility of a pop up 20070614
5 GC_LIFE_VISIBILITY_MANU_APPL Constant Public Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY 'MANU_APPL' Manual handLing, Visible always, manual deletion 20070614
6 GC_LIFE_VISIBILITY_MANU_CONT Constant Public Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY 'MANU_CONT' Manual handling, visible until controller, manual deletion 20070614
7 GC_LIFE_VISIBILITY_MANU_VIEW Constant Public Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY 'MANU_VIEW' Manual handling, visible if view is visible, manual deletion 20070614
8 GC_LOGPOINT_RAISE_EXCEPTION Constant Public Type reference (TYPE) CHAR15 'RAISE_EXCEPTION' Constant for logpoint subkey, exception 20070614
9 GC_LOGPOINT_REPORT_MESSAGE Constant Public Type reference (TYPE) CHAR14 'REPORT_MESSAGE' Constant for logpoint subkey, exception 20070614
10 GC_MSGID_NULL Constant Public Type reference (TYPE) FPM_MSGMAP_ID_NULL ' ' Blank Msg id for Message Mapper 20091013
11 GC_MSGNO_NULL Constant Public Type reference (TYPE) FPM_MSGMAP_NO_NULL 000 Blank Msg no for Message Mapper 20091013
12 GC_NAVIGATE_ERROR Constant Public Type reference (TYPE) STRING 'REPORT_IN_VIEW' Message remains in the view passed 20090616
13 GC_REPORT_IN_ALV Constant Public Type reference (TYPE) STRING 'REPORT_IN_ALV' Reporting a message immediately 20090505
14 GC_SEVERITY_ERROR Constant Public Type reference (TYPE) FPM_MESSAGE_SEVERITY 'ERR' Reporting a message with the severity "Error" 20070612
15 GC_SEVERITY_SUCCESS Constant Public Type reference (TYPE) FPM_MESSAGE_SEVERITY 'SUC' Reporting a message with the severity "Success" 20070612
16 GC_SEVERITY_WARNING Constant Public Type reference (TYPE) FPM_MESSAGE_SEVERITY 'WRN' Reporting a message with the severity "Warning" 20070612
Methods
# Method Level Visibility Method type Description Created on
1 CLEAR_MESSAGES Instance method Public Method Clear messages (whose life time is manaully maintained) 20070513
2 CONTAINS_MESSAGES Instance method Public Method Check if there are message of a given severity 20121012
3 RAISE_BAPIRET2_EXCEPTION Instance method Public Method Raise an exception using the BAPIRET2 structure 20070513
4 RAISE_CX_ROOT_EXCEPTION Instance method Public Method Raise an exception with a CX_ROOT or wtih its sub classes 20070513
5 RAISE_EXCEPTION Instance method Public Method Raise an exception with free text message 20070513
6 RAISE_T100_EXCEPTION Instance method Public Method Raise an exception with T100 text 20070513
7 REPORT_BAPIRET2_MESSAGE Instance method Public Method Report an error of the type BAPIRET2 20070513
8 REPORT_MESSAGE Instance method Public Method Report error, warning or success message 20070513
9 REPORT_OBJECT_MESSAGE Instance method Public Method Report messages based on Exception Objects 20080728
10 REPORT_T100_MESSAGE Instance method Public Method Report error, warning or success message of type T100 20070513
Events
Interface IF_FPM_MESSAGE_MANAGER has no event.
Types
Interface IF_FPM_MESSAGE_MANAGER has no local type.
Method Signatures

Method CLEAR_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT Call by reference Object reference (TYPE REF TO) OBJECT Ideally the WD component, exceptional cases any object 20070615
2 Importing IV_EXCLUDE_ERROR Call by reference Type reference (TYPE) BOOLE_D ABAP_FALSE Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070513
3 Importing IV_EXCLUDE_SUCCESS Call by reference Type reference (TYPE) BOOLE_D ABAP_FALSE Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070513
4 Importing IV_EXCLUDE_WARNING Call by reference Type reference (TYPE) BOOLE_D ABAP_FALSE Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070513

Method CLEAR_MESSAGES on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method CONTAINS_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SEVERITY Call by reference Type reference (TYPE) FPM_MESSAGE_SEVERITY IF_FPM_MESSAGE_MANAGER=>GC_SEVERITY_ERROR Message Severity 20121012
2 Returning RV_RESULT Value transfer Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20121012

Method CONTAINS_MESSAGES on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method RAISE_BAPIRET2_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_BAPIRET2 Call by reference Type reference (TYPE) BAPIRET2 Return Parameter from BAPI 20070523

Method RAISE_BAPIRET2_EXCEPTION on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method RAISE_CX_ROOT_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EXCEPTION Call by reference Object reference (TYPE REF TO) CX_ROOT Abstract Superclass for All Global Exceptions 20070523
2 Importing IV_ADDITIONAL_TEXT Call by reference Type reference (TYPE) STRING 20070523

Method RAISE_CX_ROOT_EXCEPTION on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method RAISE_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TEXT Call by reference Type reference (TYPE) STRING 20070523

Method RAISE_EXCEPTION on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method RAISE_T100_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MSGID Call by reference Type reference (TYPE) SYST-MSGID Message Class 20070523
2 Importing IV_MSGNO Call by reference Type reference (TYPE) SYST-MSGNO Message Number 20070523
3 Importing IV_PARAMETER_1 Call by reference Type reference (TYPE) SYST-MSGV1 Message Variable 20070523
4 Importing IV_PARAMETER_2 Call by reference Type reference (TYPE) SYST-MSGV2 Message Variable 20070523
5 Importing IV_PARAMETER_3 Call by reference Type reference (TYPE) SYST-MSGV3 Message Variable 20070523
6 Importing IV_PARAMETER_4 Call by reference Type reference (TYPE) SYST-MSGV4 Message Variable 20070523

Method RAISE_T100_EXCEPTION on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method REPORT_BAPIRET2_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT Call by reference Object reference (TYPE REF TO) OBJECT Ideally the WD component, exceptional cases any object 20070615
2 Importing IO_CONTROLLER Call by reference Object reference (TYPE REF TO) IF_WD_CONTROLLER Web Dynpro: Controller Interface 20070615
3 Importing IO_ELEMENT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_ELEMENT Web Dynpro: Interface for Node Element 20070615
4 Importing IR_MESSAGE_USER_DATA Call by reference Object reference (TYPE REF TO) DATA 20070615
5 Importing IS_BAPIRET2 Call by reference Type reference (TYPE) BAPIRET2 Return Parameter from BAPI 20070523
6 Importing IS_ENABLE_MESSAGE_NAVIGATION Call by reference Type reference (TYPE) ABAP_BOOL To enable message navigation 20100420
7 Importing IS_NAVIGATION_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Applicable only for GAF. Enable step navigation on E message 20080314
8 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) STRING_TABLE Attributes of the element mapped to the message 20080728
9 Importing IT_CUSTOMIZING_PARAMETERS Call by reference Type reference (TYPE) STRING_TABLE Customizing Parameters 20090505
10 Importing IV_ATTRIBUTE_NAME Call by reference Type reference (TYPE) STRING 20070523
11 Importing IV_CATEGORY Call by reference Type reference (TYPE) FPM_S_MSG_MAPPER-MSG_CATEGORY Message Category 20090918
12 Importing IV_CONTEXT Call by reference Type reference (TYPE) FPM_S_MSG_MAPPER-MSG_CONTEXT Name of Application Context 20090918
13 Importing IV_GENERALIZATION Call by reference Type reference (TYPE) FPM_MSG_GENERALIZE Message Mapper: To Specify Generalization Type 20090918
14 Importing IV_IS_VALIDATION_INDEPENDENT Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070523
15 Importing IV_LIFETIME Call by reference Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY GC_LIFE_VISIBILITY_AUTOMATIC Life time and visibility of Messages in FPM 20070523
16 Importing IV_MESSAGE_INDEX Call by reference Type reference (TYPE) I 20070523
17 Importing IV_VIEW Call by reference Type reference (TYPE) STRING GC_DEFAULT_FPM_VIEW Default view in which messages are reported 20080321

Method REPORT_BAPIRET2_MESSAGE on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method REPORT_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT Call by reference Object reference (TYPE REF TO) OBJECT Ideally the WD component, exceptional cases any object 20070615
2 Importing IO_CONTROLLER Call by reference Object reference (TYPE REF TO) IF_WD_CONTROLLER Web Dynpro: Controller Interface 20070615
3 Importing IO_ELEMENT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_ELEMENT If the message needs to be mapped to a context element 20070615
4 Importing IR_MESSAGE_USER_DATA Call by reference Object reference (TYPE REF TO) DATA Additional data, will not be displayed in message. 20070615
5 Importing IS_ENABLE_MESSAGE_NAVIGATION Call by reference Type reference (TYPE) ABAP_BOOL To enable message navigation 20100419
6 Importing IS_NAVIGATION_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Applicable only for GAF. Enable step navigation on E message 20080314
7 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) STRING_TABLE Attributes of the element mapped to the message 20080728
8 Importing IT_CUSTOMIZING_PARAMETERS Call by reference Type reference (TYPE) STRING_TABLE Customizing Parameters 20090505
9 Importing IV_ATTRIBUTE_NAME Call by reference Type reference (TYPE) STRING Name of attribute in the element mapped to the message 20070513
10 Importing IV_IS_VALIDATION_INDEPENDENT Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070513
11 Importing IV_LIFETIME Call by reference Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY GC_LIFE_VISIBILITY_AUTOMATIC How long should the message be displayed 20070513
12 Importing IV_MESSAGE_INDEX Call by reference Type reference (TYPE) I Position while displaying more than one message 20070513
13 Importing IV_MESSAGE_TEXT Call by reference Type reference (TYPE) CSEQUENCE Message text to be reported 20070513
14 Importing IV_PARAMETERS Call by reference Type reference (TYPE) WDR_NAME_VALUE_LIST Optional name - value pair parameters 20070513
15 Importing IV_SEVERITY Call by reference Type reference (TYPE) FPM_MESSAGE_SEVERITY GC_SEVERITY_ERROR Report the severity of the message 20070513
16 Importing IV_VIEW Call by reference Type reference (TYPE) STRING GC_DEFAULT_FPM_VIEW Default view in which messages are reported 20080321

Method REPORT_MESSAGE on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method REPORT_OBJECT_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT Call by reference Object reference (TYPE REF TO) OBJECT Ideally the WD component, exceptional cases any object 20080728
2 Importing IO_CONTROLLER Call by reference Object reference (TYPE REF TO) IF_WD_CONTROLLER Web Dynpro: Controller Interface 20080728
3 Importing IO_ELEMENT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_ELEMENT If the message needs to be mapped to a context element 20080728
4 Importing IR_MESSAGE_OBJECT Call by reference Object reference (TYPE REF TO) IF_MESSAGE Exception Object providing access to message long text 20080728
5 Importing IR_MESSAGE_USER_DATA Call by reference Object reference (TYPE REF TO) DATA Additional data, will not be displayed in message. 20080728
6 Importing IS_ENABLE_MESSAGE_NAVIGATION Call by reference Type reference (TYPE) ABAP_BOOL To enable message navigation 20100420
7 Importing IS_NAVIGATION_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Applicable only for GAF. Enable step navigation on E message 20080728
8 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) STRING_TABLE Attributes of the element mapped to the message 20080728
9 Importing IT_CUSTOMIZING_PARAMETERS Call by reference Type reference (TYPE) STRING_TABLE Customizing Parameters 20090505
10 Importing IV_ATTRIBUTE_NAME Call by reference Type reference (TYPE) STRING Name of attribute in the element mapped to the message 20080728
11 Importing IV_IS_VALIDATION_INDEPENDENT Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20080728
12 Importing IV_LIFETIME Call by reference Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY GC_LIFE_VISIBILITY_AUTOMATIC How long should the message be displayed 20080728
13 Importing IV_MESSAGE_INDEX Call by reference Type reference (TYPE) I Position while displaying more than one message 20080728
14 Importing IV_PARAMETERS Call by reference Type reference (TYPE) WDR_NAME_VALUE_LIST Optional name - value pair parameters 20080728
15 Importing IV_SEVERITY Call by reference Type reference (TYPE) FPM_MESSAGE_SEVERITY GC_SEVERITY_ERROR Report the severity of the message 20080728
16 Importing IV_VIEW Call by reference Type reference (TYPE) STRING GC_DEFAULT_FPM_VIEW Default view in which messages are reported 20080728

Method REPORT_OBJECT_MESSAGE on Interface IF_FPM_MESSAGE_MANAGER has no exception.

Method REPORT_T100_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT Call by reference Object reference (TYPE REF TO) OBJECT Ideally the WD component, exceptional cases any object 20070615
2 Importing IO_CONTROLLER Call by reference Object reference (TYPE REF TO) IF_WD_CONTROLLER Web Dynpro: Controller Interface 20070615
3 Importing IO_ELEMENT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_ELEMENT If the message needs to be mapped to a context element 20070615
4 Importing IR_MESSAGE_USER_DATA Call by reference Object reference (TYPE REF TO) DATA Additional data, will not be displayed in message. 20070615
5 Importing IS_ENABLE_MESSAGE_NAVIGATION Call by reference Type reference (TYPE) ABAP_BOOL To enable message navigation 20100419
6 Importing IS_NAVIGATION_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Applicable only for GAF. Enable step navigation on E message 20080314
7 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) STRING_TABLE Attributes of the element mapped to the message 20080728
8 Importing IT_CUSTOMIZING_PARAMETERS Call by reference Type reference (TYPE) STRING_TABLE Customizing Parameters 20090505
9 Importing IV_ATTRIBUTE_NAME Call by reference Type reference (TYPE) STRING Name of attribute in the element mapped to the message 20070513
10 Importing IV_CATEGORY Call by reference Type reference (TYPE) FPM_S_MSG_MAPPER-MSG_CATEGORY Message Category 20090909
11 Importing IV_CONTEXT Call by reference Type reference (TYPE) FPM_S_MSG_MAPPER-MSG_CONTEXT Name of Application Context 20090909
12 Importing IV_GENERALIZATION Call by reference Type reference (TYPE) FPM_MSG_GENERALIZE Message Mapper: To Specify Generalization Type 20090916
13 Importing IV_IS_VALIDATION_INDEPENDENT Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070513
14 Importing IV_LIFETIME Call by reference Type reference (TYPE) FPM_MSG_LIFETIME_VISIBILITY GC_LIFE_VISIBILITY_AUTOMATIC How long should the message be displayed 20070513
15 Importing IV_MESSAGE_INDEX Call by reference Type reference (TYPE) I Position while displaying more than one message 20070513
16 Importing IV_MSGID Call by reference Type reference (TYPE) SYST-MSGID Message indentification (Class) 20070513
17 Importing IV_MSGNO Call by reference Type reference (TYPE) SYST-MSGNO Message number 20070513
18 Importing IV_PARAMETER_1 Call by reference Type reference (TYPE) SYST-MSGV1 1st parameter 20070513
19 Importing IV_PARAMETER_2 Call by reference Type reference (TYPE) SYST-MSGV2 2nd parameter 20070513
20 Importing IV_PARAMETER_3 Call by reference Type reference (TYPE) SYST-MSGV3 3rd parameter 20070513
21 Importing IV_PARAMETER_4 Call by reference Type reference (TYPE) SYST-MSGV4 4th Parameter 20070513
22 Importing IV_SEVERITY Call by reference Type reference (TYPE) FPM_MESSAGE_SEVERITY GC_SEVERITY_ERROR Report the severity of the message 20070513
23 Importing IV_VIEW Call by reference Type reference (TYPE) STRING GC_DEFAULT_FPM_VIEW default view in which messages will be reported 20080321

Method REPORT_T100_MESSAGE on Interface IF_FPM_MESSAGE_MANAGER has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in