Interface: IF_FPM_GUIBB_QV_DATASET

Description of methods in the interface for a dataset quickview.

As with the implementation of the GUIBB interfaces, implement an empty method even if your application does not actually require the method (to avoid a system dump).

Table 1: Methods of IF_FPM_GUIBB_QV_DATASET Interface
GET_DEFINITION Allows the feeder to provide all necessary information for configuring a dataset quickview: the list of available fields and their properties and the list of actions (FPM events).
Parameter	Description
EO_FIELD_CATALOG	Is of type CL_ABAP_TABLEDESCR. The components of this object are the available fields. The simplest way to provide a field catalog is to create a table of a flat DDIC structure containing all fields and then get the field catalog via EO_FIELD_CATALOG ?= CL_ABAP_TABLEDESCR=>DESCRIBE_BY_NAME( <NAME> ) Note The dataset quickview supports only flat structures.When using deep structures, only the highest level fields are available.
ET_FIELD_DESCRIPTION	Here you can provide the additional information needed to create the dataset quickview, for example a link reference, LINK_REF.
EV_STATELESS_ENABLED	Set feeder to stateless, so that it can be used in stateless scenario (UI5).
ES_MESSAGE	A list of messages which shall be displayed in the message region.

INITIALIZE Called at runtime when the dataset quickview is created. It is the first feeder method which is called from FPM.
Parameter	Description
IT_PARAMETER	Contains a list of the feeder parameters and the values for them specified in the configuration.
IO_APP_PARAMETER	Application parameter
IV_COMPONENT_NAME	Web Dynpro: Component Name
IS_CONFIG_KEY	Key components of configuration tables
IV_INSTANCE_ID	Instance ID

FLUSH The first feeder method which is called during an event loop. Whenever an FPM event is triggered (this includes all round trips caused by the dataset quickview itself) this method is called. Use it to forward changed dataset quickview data to other components in the same application.
Parameter	Description
IT_CHANGE_LOG	Lists all changes made by the user.
IS_DATA	Is a structure containing the changed data.

PROCESS_EVENT Called within the FPM event loop, it forwards the FPM PROCESS_EVENT to the feeder class. Here the event processing can take place and this is where the event can be canceled or deferred.
Parameter	Description
IO_EVENT	The FPM event which is to be processed
IV_RAISED_BY_OWN_UI	ABAP_TRUE if the event is raised by own UI
EV_RESULT	The result of the event processing. There are 3 possible values: EV_RESULT = IF_FPM_CONSTANTS=>GC_EVENT_RESULT-OK EV_RESULT = IF_FPM_CONSTANTS=>GC_EVENT_RESULT-FAILED EV_RESULT = IF_FPM_CONSTANTS=>GC_EVENT_RESULT-DEFER
ET_MESSAGES	A list of messages which shall be displayed in the message region.

GET_DATA Called within the FPM event loop and forwards the FPM PROCESS_BEFORE_OUTPUT event to the feeder class. Here you specify the quickview data after the event has been processed.
Parameter	Description
IO_EVENT	The FPM event which is to be processed.
IT_SELECTED_FIELDS	The list of fields necessary for the quickview rendering. Provide only the data for the fields listed in this table; all other fields are neither visible at runtime nor used as reference for visible fields.
IV_RAISED_BY_OWN_UI	ABAP_TRUE if the event is raised by own UI.
IV_KEY	Serialized key for the quickview.
ET_MESSAGES	A list of messages which shall be displayed in the message area.
EV_DATA_CHANGED	For performance reasons, the GUIBB adjusts the data in the quickview only if the data has been changed. To indicate this, set this flag whenever you change the data to be displayed within this feeder.
CS_DATA	The quickview data to be changed.

GET_DEFAULT_CONFIG Call this if you want to have a default configuration. Use it to call pre-configured quickview configurations when a user starts the FPM configuration editor. This avoids the user, who uses a feeder class to create a quickview, having to create it from the beginning.
Parameter	Description
IO_CONFIG	Of type IF_FPM_GUIBB_QV_DATASET_CONFIG. This object provides the API to create a default configuration.

CHECK_CONFIG Call this if you want to make your own application-specific checks on the configuration in the FPM configuration editor immediately before saving.
Parameter	Description
IO_CONFIG	Of type IF_FPM_GUIBB_QV_DATASET_CONFIG. This object provides the API to read the configuration to be saved.
ET_MESSAGES	A list of messages which shall be displayed in the message region.