SAP ABAP Interface IF_FPM (Interface for accessing FPM functionality)
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 This is an internal class and must not be accessed!!!!!!!!!! 20070404
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_FPM_TEST_DOUBLE Test double for IF_FPM 20110830
Properties
Interface IF_FPM  
Short Description Interface for accessing FPM functionality    
General Data
Package APB_FPM_CORE   Floorplan Manager (Framework) 
Created 20070404   SAP 
Last changed 20141120    
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 CL_FPM_EVENT Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_FPM Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Interface IF_FPM has no interface.
Friends
Interface IF_FPM has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MO_ADAPTATION_MANAGER Instance attribute Public Object reference (TYPE REF TO) IF_FPM_ADAPT_MANAGER Adaptation manager 20100705
2 MO_APP_PARAMETER Instance attribute Public Object reference (TYPE REF TO) IF_FPM_PARAMETER Application Parameter 20070425
3 MO_CONF_COMP_USAGE Instance attribute Public Object reference (TYPE REF TO) IF_FPM_UIBB_CONF_COMP_USAGE Configurable component usages for UIBBs 20090826
4 MO_MESSAGE_MANAGER Instance attribute Public Object reference (TYPE REF TO) IF_FPM_MESSAGE_MANAGER FPM message manager public use 20070514
5 MV_EDIT_MODE_SUPPORTED Instance attribute Public Type reference (TYPE) ABAP_BOOL 20110321
6 MV_IS_DIALOG_MODE Instance attribute Public Type reference (TYPE) FPM_DIALOG_STATE Indicate if the UIBBs are running in a dialog box 20090121
Methods
# Method Level Visibility Method type Description Created on
1 ATTACH_COMPONENT_TO_USAGE Instance method Public Method Binds the component to the usage and creates it if needed 20070411
2 DISABLE_COMMIT Instance method Public Method Disables COMMIT WORK executed by FPM 20090812
3 DISPLAY_ERROR_PAGE Instance method Public Method Displays Error page. Ends the event loop. Pass error data. 20081016
4 GET_INSTANCE_ID Instance method Public Method Returns the Instance id of the UIBB 20100706
5 GET_MAXIMIZED_UIBB Instance method Public Method Returns the currently maximized UIBB 20131219
6 GET_NAVIGATE_TO Instance method Public Method Get access to navigation API without Launchpad customizing 20080108
7 GET_NAVIGATION Instance method Public Method Get access to navigation API via ID 20070601
8 GET_RUNTIME_INFO Instance method Public Method get's runtime information about the running application 20070612
9 GET_SERVICE Instance method Public Method Get a service API to dynamically modify the generic FPM UI 20070521
10 GET_UIBB_EDIT_MODE Instance method Public Method Returns the edit mode state of a UIBB 20100831
11 OPEN_DIALOG_BOX Instance method Public Method Open a dialog window supported by the framework 20090129
12 RAISE_EVENT Instance method Public Method Triggers the FPM event loop for the given event 20070410
13 RAISE_EVENT_BY_ID Instance method Public Method Triggers the FPM event loop for the given event ID 20070410
14 READ_EVENT_QUEUE Instance method Public Method Read-only access to FPM event queue 20090804
15 REGISTER_ASYNCHRONOUS_EVENT Instance method Public Method 20121016
16 RESUME_EVENT_PROCESSING Instance method Public Method Continues event processing after PROCESS_EVENT was DEFERRED 20070423
17 SET_APPLICATION_TITLE Instance method Public Method Sets the application title in explorer window 20100412
18 SET_DIALOG_BUTTON_STATUS Instance method Public Method Sets the Dialog Button Status 20100630
Events
Interface IF_FPM has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_S_EVENT_QUEUE_ENTRY Public See coding 20090804 begin of TY_S_EVENT_QUEUE_ENTRY, id type fpm_event_id, parameter type APB_LPD_T_PARAMS, state type FPM_EVENT_STATE, end of TY_S_EVENT_QUEUE_ENTRY
2 TY_T_EVENT_QUEUE Public See coding 20090804 ty_t_event_queue type standard table of ty_s_event_queue_entry
Method Signatures

Method ATTACH_COMPONENT_TO_USAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT_USAGE Call by reference Object reference (TYPE REF TO) IF_WD_COMPONENT_USAGE Web Dynpro: Component Usage 20070418
2 Importing IS_CONFIG_KEY Call by reference Type reference (TYPE) WDY_CONFIG_KEY Web Dynpro: Key Components of Configuration Tables 20070427
3 Importing IV_COMPONENT_NAME Call by reference Type reference (TYPE) STRING Web Dynpro: Component Name 20070411
4 Importing IV_INSTANCE_ID Call by reference Type reference (TYPE) FPM_INSTANCE_ID Instance ID 20100706

Method ATTACH_COMPONENT_TO_USAGE on Interface IF_FPM has no exception.

Method DISABLE_COMMIT Signature

Method DISABLE_COMMIT on Interface IF_FPM has no parameter.
Method DISABLE_COMMIT on Interface IF_FPM has no exception.

Method DISPLAY_ERROR_PAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_ERROR_DETAILS Call by reference Object reference (TYPE REF TO) IF_FPM_ERROR_DETAILS Key Value class for getting error details from application 20081106

Method DISPLAY_ERROR_PAGE on Interface IF_FPM has no exception.

Method GET_INSTANCE_ID 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) IF_WD_COMPONENT Web Dynpro: Component 20100706
2 Returning RV_INSTANCE_ID Value transfer Type reference (TYPE) FPM_INSTANCE_ID Returns the instance id based on Component 20100720

Method GET_INSTANCE_ID on Interface IF_FPM has no exception.

Method GET_MAXIMIZED_UIBB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_UIBB_KEY Value transfer Type reference (TYPE) CL_FPM_EVENT=>TY_S_UIBB_KEY Key of the currently maximized UIBB 20140121

Method GET_MAXIMIZED_UIBB on Interface IF_FPM has no exception.

Method GET_NAVIGATE_TO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INSTANCE Call by reference Type reference (TYPE) APB_LPD_INSTANCE Instance 20120710
2 Importing IV_INSTANCE_SHARING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Allows instance sharing (singleton) 20080108
3 Importing IV_OBN_USE_USER_SET_OF_ROLES Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Set the resolving mode to USER_SET_OF_ROLES 20101109
4 Importing IV_ROLE Call by reference Type reference (TYPE) APB_LPD_ROLE Role 20120710
5 Returning RO_NAVIGATE_TO Value transfer Object reference (TYPE REF TO) IF_FPM_NAVIGATE_TO Navigation API without Launchpad customizing 20080108

Method GET_NAVIGATE_TO on Interface IF_FPM has no exception.

Method GET_NAVIGATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_KEY Call by reference Type reference (TYPE) FPM_S_NAVIGATION_KEY ID 20070601
2 Importing IV_INSTANCE_SHARING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Allows instance sharing (singleton) 20070601
3 Returning RO_NAVIGATION Value transfer Object reference (TYPE REF TO) IF_FPM_NAVIGATION Navigation API 20070601

Method GET_NAVIGATION on Interface IF_FPM has no exception.

Method GET_RUNTIME_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_RUNTIME_INFO Value transfer Type reference (TYPE) FPM_S_RUNTIME_INFO Runtime Information 20070612

Method GET_RUNTIME_INFO on Interface IF_FPM has no exception.

Method GET_SERVICE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SERVICE_KEY Call by reference Type reference (TYPE) FPM_SERVICE_KEY Service key 20070521
2 Returning RR_SERVICE_INTERFACE Value transfer Object reference (TYPE REF TO) OBJECT Reference to service interface 20070521

Method GET_SERVICE on Interface IF_FPM has no exception.

Method GET_UIBB_EDIT_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_UIBB_INSTANCE_KEY Call by reference Type reference (TYPE) FPM_S_UIBB_INSTANCE_KEY 20100831
2 Importing IV_WINDOW_NAME Call by reference Type reference (TYPE) FPM_WINDOW_NAME 20100831
3 Returning RV_EDIT_MODE Value transfer Type reference (TYPE) FPM_EDIT_MODE 20100831

Method GET_UIBB_EDIT_MODE on Interface IF_FPM has no exception.

Method OPEN_DIALOG_BOX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT_DATA Call by reference Object reference (TYPE REF TO) IF_FPM_PARAMETER Event data for the dilaog box 20090130
2 Importing IS_DIALOG_BOX_PROPERTIES Call by reference Type reference (TYPE) FPM_S_DIALOG_BOX_PROPERTIES Dialog Box Properties 20090129
3 Importing IV_DIALOG_BOX_ID Call by reference Type reference (TYPE) FPM_DIALOG_WINDOW_ID FPM: ID of the dailog window 20090129
4 Importing IV_EVENT_ADAPTS_CONTEXT Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20110503

Method OPEN_DIALOG_BOX on Interface IF_FPM has no exception.

Method RAISE_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20070418

Method RAISE_EVENT on Interface IF_FPM has no exception.

Method RAISE_EVENT_BY_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT_DATA Call by reference Object reference (TYPE REF TO) IF_FPM_PARAMETER Property Bag 20090923
2 Importing IV_EVENT_ID Call by reference Type reference (TYPE) FPM_EVENT_ID This defines the ID of the FPM Event 20070410

Method RAISE_EVENT_BY_ID on Interface IF_FPM has no exception.

Method READ_EVENT_QUEUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_EVENT_QUEUE Call by reference Type reference (TYPE) IF_FPM=>TY_T_EVENT_QUEUE 20090804

Method READ_EVENT_QUEUE on Interface IF_FPM has no exception.

Method REGISTER_ASYNCHRONOUS_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20121016
2 Returning RV_NOTIFICATION_ID Value transfer Type reference (TYPE) WDR_NOTIFICATION_ID Unique ID of Registration 20121016

Method REGISTER_ASYNCHRONOUS_EVENT on Interface IF_FPM has no exception.

Method RESUME_EVENT_PROCESSING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MODE Call by reference Type reference (TYPE) FPM_EVENT_RESULT The deferred result of PROCESS_EVENT 20070424

Method RESUME_EVENT_PROCESSING on Interface IF_FPM has no exception.

Method SET_APPLICATION_TITLE Signature

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

Method SET_APPLICATION_TITLE on Interface IF_FPM has no exception.

Method SET_DIALOG_BUTTON_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BUTTON Call by reference Type reference (TYPE) WDR_POPUP_BUTTON Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20100701
2 Importing IV_STATUS Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20100630

Method SET_DIALOG_BUTTON_STATUS on Interface IF_FPM has no exception.
History
Last changed by/on SAP  20141120 
SAP Release Created in