SAP ABAP Interface IF_FPM_OIF (Interface for Communication FPM App CC)

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_OIF	Communication Floorplan <-> AppCC	20070502

Properties

Interface	IF_FPM_OIF
Short Description	Interface for Communication FPM App CC

General Data

Package	APB_FPM_CORE	Floorplan Manager (Framework)
Created	20070502	SAP
Last changed	20110908	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_OIF	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FPM_WIRE_MODEL	☐	☐	Interface for Communication FPM App CC. Wire Model	20090122

Friends

Interface IF_FPM_OIF has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_EVENT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		Currently processed FPM event	20070502

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MAINVIEW	Instance method	Public	Method	Adds a mainview dynamically at runtime	20070608
2	ADD_SUBVIEW	Instance method	Public	Method	Adds a subview dynamically at runtime	20070606
3	ADD_UIBB	Instance method	Public	Method	Adding a UIBB to a subview	20070604
4	ADD_WIRE	Instance method	Public	Method		20090122
5	CANCEL_EVENT	Instance method	Public	Method	Stop FPM Event Loop	20070502
6	GET_ACA_API	Instance method	Public	Method	Returns the Additional Content Area API	20070814
7	GET_CURRENT_STATE	Instance method	Public	Method	get's the current navigation state	20070601
8	GET_MAINVIEWS	Instance method	Public	Method	returns a list of mainviews for a given variant	20070604
9	GET_SUBVIEWS	Instance method	Public	Method	returns a list of mainviews for a given variant	20070604
10	GET_UIBB_KEYS	Instance method	Public	Method	Returns a list of all UIBBs for a specified subview	20070604
11	GET_UIBB_KEYS_FOR_CONF_STEP	Instance method	Public	Method	Returns a list of all UIBBs for a specified subview	20070604
12	GET_UIBB_KEYS_FOR_INIT_SCREEN	Instance method	Public	Method	Returns a list of all UIBBs for a specified subview	20070604
13	GET_VARIANTS	Instance method	Public	Method	get a list of available variants	20070601
14	GET_WIRES	Instance method	Public	Method		20090122
15	REMOVE_MAINVIEW	Instance method	Public	Method	Removes a mainview	20070608
16	REMOVE_SUBVIEW	Instance method	Public	Method	Removes a subview	20070608
17	REMOVE_UIBB	Instance method	Public	Method	Removes UIBB from a subview	20070605
18	REMOVE_WIRE	Instance method	Public	Method		20090122
19	RENAME_MAINVIEW	Instance method	Public	Method		20070608
20	RENAME_SUBVIEW	Instance method	Public	Method		20070608
21	SET_HIDDEN_MAINVIEW	Instance method	Public	Method	Removes a mainview	20080805
22	SET_HIDDEN_SUBVIEW	Instance method	Public	Method	Removes a subview	20080805
23	SET_HIDDEN_UIBB	Instance method	Public	Method	Removes UIBB from a subview	20080805
24	SET_SELECTED_SUBVIEW	Instance method	Public	Method	Select next active subview	20070502
25	SET_VARIANT	Instance method	Public	Method	Select Variant	20070502
26	UPDATE_CONF_STEP	Instance method	Public	Method	Adds or replaces a confirmation step dynamically at runtime	20090721

Events

Interface IF_FPM_OIF has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_MAINVIEW	Public	See coding		OIF Mainview	20070604	BEGIN OF ty_s_mainview, variant TYPE string, id TYPE string, name TYPE string, hidden TYPE fpm_hidden, END OF ty_s_mainview
2	TY_S_STATE	Public	See coding		Runtime state of OIF	20070601	BEGIN OF ty_s_state, floorplan_state TYPE fpm_floorplan_state, variant TYPE string, mainview TYPE string, subview TYPE string, END OF ty_s_state
3	TY_S_SUBVIEW	Public	See coding		OIF Subview	20070604	BEGIN OF ty_s_subview, variant TYPE string, mainview TYPE string, id TYPE string, name TYPE string, hidden TYPE fpm_hidden, layout_type TYPE fpm_layout_type, explanation_text type fpm_text, explanation_document_name type doku_obj, END OF ty_s_subview
4	TY_S_UIBB	Public	See coding		Key of a UIBB	20070604	BEGIN OF ty_s_uibb, component TYPE string, interface_view TYPE string, config_id TYPE wdy_config_id, config_type TYPE wdy_config_type, config_var TYPE wdy_config_var, needs_stretching TYPE fpm_needs_stretching, location TYPE fpm_location, index TYPE fpm_index, instance_id TYPE fpm_instance_id, END OF ty_s_uibb
5	TY_S_UIBB_EXT	Public	See coding		Key of UIBB (with location in OIF)	20070606	BEGIN OF ty_s_uibb_ext, variant TYPE string, mainview TYPE string, subview TYPE string. INCLUDE TYPE ty_s_uibb. TYPES: hidden TYPE fpm_hidden, END OF ty_s_uibb_ext
6	TY_S_VARIANT	Public	See coding		OIF Variant	20070601	BEGIN OF ty_s_variant, id TYPE string, name TYPE string, conf_step_layout type FPM_LAYOUT_TYPE, END OF ty_s_variant
7	TY_T_MAINVIEW	Public	See coding		Table of OIF Mainviews	20070604	ty_t_mainview TYPE STANDARD TABLE OF ty_s_mainview
8	TY_T_SUBVIEW	Public	See coding		Table of OIF Subviews	20070604	ty_t_subview TYPE STANDARD TABLE OF ty_s_subview
9	TY_T_UIBB	Public	See coding		Table of UIBB keys	20070604	ty_t_uibb TYPE STANDARD TABLE OF ty_s_uibb
10	TY_T_UIBB_EXT	Public	See coding		Table of UIBB keys (with location in OIF)	20070606	ty_t_uibb_ext TYPE STANDARD TABLE OF ty_s_uibb_ext
11	TY_T_VARIANT	Public	See coding		Table of OIF Variants	20070601	ty_t_variant TYPE STANDARD TABLE OF ty_s_variant

Method Signatures

Method ADD_MAINVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_UIBB	Call by reference	☐	Type reference (TYPE)	TY_T_UIBB		Table of UIBB keys (at least one entry is required)	20070608
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I	9999	Index of new Mainview	20070608
3	Importing	IV_LAYOUT_TYPE	Call by reference	☑	Type reference (TYPE)	FPM_LAYOUT_TYPE		Layout Type	20090116
4	Importing	IV_MAINVIEW_ID	Call by reference	☐	Type reference (TYPE)	STRING		ID of the new Mainview	20070608
5	Importing	IV_MAINVIEW_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the new Mainview	20070608
6	Importing	IV_SUBVIEW_ID	Call by reference	☐	Type reference (TYPE)	STRING		ID of the first subview of the new mainview	20070608
7	Importing	IV_SUBVIEW_NAME	Call by reference	☐	Type reference (TYPE)	STRING		name of the first subview of the new mainview	20070608
8	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (default current variant)	20070608

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070608

Method ADD_SUBVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_UIBB	Call by reference	☐	Type reference (TYPE)	TY_T_UIBB		Table of UIBB keys (at least one entry is required)	20070606
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I	9999	Index of new subview (default is add at last place)	20070606
3	Importing	IV_LAYOUT_TYPE	Call by reference	☑	Type reference (TYPE)	FPM_LAYOUT_TYPE		Layout Type	20090116
4	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (default current mainview)	20070606
5	Importing	IV_SUBVIEW_ID	Call by reference	☐	Type reference (TYPE)	STRING		ID of new subview	20070606
6	Importing	IV_SUBVIEW_NAME	Call by reference	☐	Type reference (TYPE)	STRING		name of new subview	20070606
7	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (default current variant)	20070606

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070606

Method ADD_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UIBB_KEY	Call by reference	☐	Type reference (TYPE)	TY_S_UIBB_EXT		Key of UIBB to be added	20070605
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I	9999	Place for the Insertion	20070604
3	Importing	IV_LOCATION	Call by reference	☑	Type reference (TYPE)	FPM_LOCATION		Index in Layoutbox where UIBB is located	20090116

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070604

Method ADD_WIRE Signature

Method ADD_WIRE on Interface IF_FPM_OIF has no parameter.
Method ADD_WIRE on Interface IF_FPM_OIF has no exception.

Method CANCEL_EVENT Signature

Method CANCEL_EVENT on Interface IF_FPM_OIF has no parameter.
Method CANCEL_EVENT on Interface IF_FPM_OIF has no exception.

Method GET_ACA_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ACA_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_FPM_ACA		Additional Content Area API	20070814

Method GET_ACA_API on Interface IF_FPM_OIF has no exception.

Method GET_CURRENT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CURRENT_STATE	Call by reference	☐	Type reference (TYPE)	TY_S_STATE			20070601

Method GET_CURRENT_STATE on Interface IF_FPM_OIF has no exception.

Method GET_MAINVIEWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MAINVIEW	Call by reference	☐	Type reference (TYPE)	IF_FPM_OIF=>TY_T_MAINVIEW		List of mainviews	20070604
2	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070604

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070604

Method GET_SUBVIEWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUBVIEW	Call by reference	☐	Type reference (TYPE)	IF_FPM_OIF=>TY_T_SUBVIEW		List of mainviews	20070604
2	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview is used if skipped)	20070604
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070604

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070604

Method GET_UIBB_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_UIBB	Call by reference	☐	Type reference (TYPE)	IF_FPM_OIF=>TY_T_UIBB_EXT		List of UIBBs	20070604
2	Exporting	EV_LAYOUT_TYPE	Call by reference	☐	Type reference (TYPE)	FPM_LAYOUT_TYPE		Layout Type	20090120
3	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (uses current Mainview if skipped)	20070604
4	Importing	IV_SUBVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Subview ID (uses current Subview if skipped)	20070604
5	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (uses current Variant if skipped)	20070604

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070604

Method GET_UIBB_KEYS_FOR_CONF_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_UIBB	Call by reference	☐	Type reference (TYPE)	IF_FPM_OIF=>TY_T_UIBB_EXT		List of UIBBs	20070604
2	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (uses current Variant if skipped)	20070604

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070604

Method GET_UIBB_KEYS_FOR_INIT_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_UIBB	Call by reference	☐	Type reference (TYPE)	IF_FPM_OIF=>TY_T_UIBB_EXT		List of UIBBs	20070604

Method GET_UIBB_KEYS_FOR_INIT_SCREEN on Interface IF_FPM_OIF has no exception.

Method GET_VARIANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_VARIANT	Call by reference	☐	Type reference (TYPE)	TY_T_VARIANT			20070601

Method GET_VARIANTS on Interface IF_FPM_OIF has no exception.

Method GET_WIRES Signature

Method GET_WIRES on Interface IF_FPM_OIF has no parameter.
Method GET_WIRES on Interface IF_FPM_OIF has no exception.

Method REMOVE_MAINVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20070608
2	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070608

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070608

Method REMOVE_SUBVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20070608
2	Importing	IV_SUBVIEW_ID	Call by reference	☐	Type reference (TYPE)	STRING			20070608
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070608

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070608

Method REMOVE_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I	9999	Index of UIBB to be removed	20070605
2	Importing	IV_LOCATION	Call by reference	☑	Type reference (TYPE)	FPM_LOCATION		Index in Layoutbox where UIBB is located	20090116
3	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20070605
4	Importing	IV_SUBVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Subview ID (current subview if skipped)	20070605
5	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070605

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070605

Method REMOVE_WIRE Signature

Method REMOVE_WIRE on Interface IF_FPM_OIF has no parameter.
Method REMOVE_WIRE on Interface IF_FPM_OIF has no exception.

Method RENAME_MAINVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20070608
2	Importing	IV_NEW_NAME	Call by reference	☑	Type reference (TYPE)	STRING		New name of mainview	20070608
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070608

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070608

Method RENAME_SUBVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20070608
2	Importing	IV_NEW_NAME	Call by reference	☑	Type reference (TYPE)	STRING		New name of mainview	20070608
3	Importing	IV_SUBVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Subview ID (current subview if skipped)	20070608
4	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20070608

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070608

Method SET_HIDDEN_MAINVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HIDDEN	Call by reference	☐	Type reference (TYPE)	FPM_HIDDEN		Element is hidden by API-Call at runtime	20080805
2	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20080805
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20080805

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20080805

Method SET_HIDDEN_SUBVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HIDDEN	Call by reference	☐	Type reference (TYPE)	FPM_HIDDEN		Element is hidden by API-Call at runtime	20080805
2	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20080805
3	Importing	IV_SUBVIEW_ID	Call by reference	☐	Type reference (TYPE)	STRING			20080805
4	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20080805

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20080805

Method SET_HIDDEN_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HIDDEN	Call by reference	☐	Type reference (TYPE)	FPM_HIDDEN		Element is hidden by API-Call at runtime	20080805
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I	9999	Index of UIBB to be removed	20080805
3	Importing	IV_LOCATION	Call by reference	☑	Type reference (TYPE)	FPM_LOCATION		Index in Layoutbox where UIBB is located	20090120
4	Importing	IV_MAINVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Mainview ID (current mainview if skipped)	20080805
5	Importing	IV_SUBVIEW_ID	Call by reference	☑	Type reference (TYPE)	STRING		Subview ID (current subview if skipped)	20080805
6	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20080805

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20080805

Method SET_SELECTED_SUBVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SUBVIEW_ID	Call by reference	☐	Type reference (TYPE)	STRING		ID of new active Subview	20070502

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070514

Method SET_VARIANT Signature

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

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20070514

Method UPDATE_CONF_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_UIBB	Call by reference	☐	Type reference (TYPE)	TY_T_UIBB		Table of UIBB keys (at least one entry is required)	20090721
2	Importing	IV_LAYOUT_TYPE	Call by reference	☑	Type reference (TYPE)	FPM_LAYOUT_TYPE		Layout Type	20090721
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (default current variant)	20090721

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090721

History

Last changed by/on	SAP	20110908
SAP Release Created in