SAP ABAP Class /BCV/CL_UIF_QVIEW_ASSIST (Assistance Class for /BCV/WDC_UIF_FORM_QVIEW)
Hierarchy
SAP_BS_FND (Software Component) SAP Business Suite Foundation
   CA-EPT-BCV (Application Component) Business Context Viewer
     /BCV/UIF (Package) BCV User Interface Layer
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_WD_COMPONENT_ASSISTANCE Basis for a Web Dynpro assistance class 20090916
Properties
Class /BCV/CL_UIF_QVIEW_ASSIST  
Short Description Assistance Class for /BCV/WDC_UIF_FORM_QVIEW    
Super Class CL_WD_COMPONENT_ASSISTANCE Basis for a Web Dynpro assistance class 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package /BCV/UIF   BCV User Interface Layer 
Created 20090916   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /BCV/IF_UIF_REPR_TECHNOLOGY Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
2 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
3 IF_SALV_BS Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class /BCV/CL_UIF_QVIEW_ASSIST has no interface implemented.
Friends
Class /BCV/CL_UIF_QVIEW_ASSIST has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_DEFAULT_FILE_NAME Constant Public Type reference (TYPE) STRING 'Chart.gif' Default name of a screenshot file 20091020
2 CO_IDX_COLUMN_NAME Constant Public Type reference (TYPE) STRING '/BCV/QVIEW_RESULT_IDX' Name for the manually added index column in query output 20090917
3 CO_MAX_CAT_HORIZONTAL Constant Public Type reference (TYPE) I 10 Maximal number of horizontal category labels 20091015
4 CO_MAX_PERS_NO Constant Public Type reference (TYPE) I 10 Max allowed No of personalizations 20090917
5 CO_POPUP_HEIGHT Constant Public Type reference (TYPE) STRING '100px' Default height of a popup window 20090917
6 CO_POPUP_WIDTH Constant Public Type reference (TYPE) STRING '400px' Default width of a popup window 20090917
7 CO_QVIEW_RESULT_NODE Constant Public Type reference (TYPE) STRING 'QVIEW_RESULT' Name of the node with qview results 20090917
8 CO_SIDEPANEL_REPR_ID Constant Public Type reference (TYPE) /BCV/UIF_REPR_ID '$PERS' ID of a personalized view in side panel 20120404
9 CS_DIMENSION Constant Public See coding Window default dimensions 20091002
10 CS_OUTPUT_TYPE Constant Public See coding 20090917
11 CS_SYNCHR_ACTION Constant Public See coding Possible synchonozation actions 20090917
12 CS_TABLE_DIMENSION Constant Public See coding Table relevant dimensions 20091007
13 CS_ZOOM Constant Public See coding Zoom relevant parameters 20090917
14 GF_DISP_PARAM_SET Instance attribute Public Type reference (TYPE) WDY_BOOLEAN Flag is set when the display parameters are set 20090917
15 GF_FILL_RESULT_NODE Instance attribute Public Type reference (TYPE) WDY_BOOLEAN Fill results node with new data 20090917
16 GF_NEW_QUERY Instance attribute Public Type reference (TYPE) WDY_BOOLEAN A new query in a query view is requested 20100412
17 GF_RENDER_MAIN Instance attribute Public Type reference (TYPE) WDY_BOOLEAN Rerender the main screen 20090917
18 GF_REPR_LOAD_SETTINGS Instance attribute Public Type reference (TYPE) WDY_BOOLEAN Load representation into the settings dialogue 20091026
19 GF_SET_DIMENSION Instance attribute Public Type reference (TYPE) WDY_BOOLEAN Set display dimension 20091217
20 GO_CURR_REPR Instance attribute Public Object reference (TYPE REF TO) /BCV/IF_UIF_REPR_TECHNOLOGY Settings for the currently displayed representation 20090917
21 GO_PERS_MANAGER Instance attribute Public Object reference (TYPE REF TO) IF_WD_PERSONALIZATION Reference to WD personalization manager 20090917
22 GT_FIELD Instance attribute Public Type reference (TYPE) SALV_WD_T_FIELD_REF Synchronization data (sort and filter) 20100104
23 GT_QUERY_ID Instance attribute Public Type reference (TYPE) WDR_CONTEXT_ATTR_VALUE_LIST Query ID table 20090929
24 GT_QVIEW_RES_DATA Instance attribute Public Type reference (TYPE) TT_QVIEW_RES_DATA Table of qview result relevant data 20100408
25 GT_REPR_ID_VALUE Instance attribute Public Type reference (TYPE) WDR_CONTEXT_ATTR_VALUE_LIST List of dropdown values for representation IDs 20090917
26 GV_CONTEXT_KEY Instance attribute Public Type reference (TYPE) /BCV/FND_CONTEXT_KEY Context Key 20090917
27 GV_OUTPUT_TYPE Instance attribute Public Type reference (TYPE) /BCV/UIF_OUTPUT_TYPE Current output type 20090917
28 GV_QUERY_ID Instance attribute Public Type reference (TYPE) /BCV/QRM_QUERY_ID Current query id 20091112
29 GV_QVIEW_ID Instance attribute Public Type reference (TYPE) /BCV/UIF_QVIEW_ID Current qview id 20091112
Methods
# Method Level Visibility Method type Description Created on
1 ADD_PERSONALIZED_REPR Instance method Public Method Add a personalized representation 20090917
2 CREATE_OUTPUT_FORMAT Instance method Public Method Create output format instance 20091210
3 DEFINE_SETTINGS_LINK Instance method Public Method Determine how the settings link should be displayed 20100831
4 DETERMINE_TOOLTIP Instance method Public Method Determine the tooltip 20110304
5 ERASE_PERS_REPR Instance method Public Method Erase a personalized representation 20090917
6 EXT_SYNCHR_INBOUND Instance method Public Method Standard synchronizations for every representation 20090917
7 FILL_GENERIC_PARAMS Instance method Public Method Fill the table of queries metadata and display dimensions 20100408
8 GET_ALL_MEANINGS Instance method Public Method Determine meanings corresponding to selected screen element 20091005
9 GET_DISP_PARAM Instance method Public Method Get display parameters 20090917
10 GET_METADATA Instance method Public Method Return the metadata table 20120330
11 GET_ORIGINAL_VALUE Instance method Public Method Get not converted value of a query output attribute 20090917
12 GET_PERS_KEY Instance method Public Method Create a key for a personalized representation 20090917
13 GET_SAP_THEME Instance method Public Method Get current SAP Theme 20130528
14 IS_DISP_PARAM_SET Instance method Public Method Are display parameters already set? 20090917
15 MODIFYVIEW_SETTINGS Instance method Public Method WDDOMODIFYVIEW on settings screen 20090917
16 PREPARE_OUTPUT_TAB Instance method Public Method Prepare output table (data conversion, synchronization etc) 20090917
17 REPR_CHOSEN Instance method Public Method Representation is chosen in the dropdown list 20090917
18 SAVE_SIDEPANEL_PERS Instance method Public Method Save the personalized side panel representation 20120404
19 SET_DISP_DATA Instance method Public Method Set data to display 20090917
20 SET_DISP_DIMENSION Instance method Public Method Set display dimension 20091217
21 SET_DISP_PARAM Instance method Public Method Set display parameters 20100408
22 TOGGLE_SETTINGS Instance method Public Method Toggle settings dialogue on/off 20090917
Events
Class /BCV/CL_UIF_QVIEW_ASSIST has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TT_AGGREGATED_LINES Public See coding 20100215 tt_aggregated_lines TYPE STANDARD TABLE OF ty_aggregated_lines
2 TT_QVIEW_RES_DATA Public See coding 20100408 tt_qview_res_data TYPE STANDARD TABLE OF ty_qview_res_data
3 TT_TABIX Public See coding Indices of selected table entries 20091005 tt_tabix TYPE STANDARD TABLE OF sytabix WITH KEY table_line
4 TY_AGGREGATED_LINES Public See coding 20100215 BEGIN OF ty_aggregated_lines, event_id TYPE i, lines TYPE tt_tabix, END OF ty_aggregated_lines
5 TY_QVIEW_RES_DATA Public See coding 20100408 BEGIN OF ty_qview_res_data, query_id TYPE /bcv/qrm_query_id, result TYPE REF TO data, metadata TYPE /bcv/t_qrm_query_res_attr_ext, settings TYPE /bcv/t_uif_repr_technology, END OF ty_qview_res_data
6 TY_S_ALV_FIELD_TAB Public See coding 20120201 BEGIN OF ty_s_alv_field_tab, query_id TYPE /bcv/qrm_query_id, alv_field_tab TYPE salv_wd_t_field_ref, END OF ty_s_alv_field_tab
7 TY_S_OUTPUT_PROP Public See coding Output Properties of Result Field 20091211 BEGIN OF ty_s_output_prop, attribute_id TYPE /bcv/qrm_res_attr_id, convexit TYPE /bcv/fnd_convexit, outlen TYPE i, END OF ty_s_output_prop
8 TY_T_ALV_FIELD_TAB Public See coding 20120201 ty_t_alv_field_tab TYPE STANDARD TABLE OF ty_s_alv_field_tab
9 TY_T_OUTPUT_PROP Public See coding Output Properties of Result Fields 20091211 ty_t_output_prop TYPE SORTED TABLE OF ty_s_output_prop WITH NON-UNIQUE KEY attribute_id
Method Signatures

Method ADD_PERSONALIZED_REPR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_REPR_ID Call by reference Type reference (TYPE) /BCV/UIF_REPR_ID Representation ID 20091029
2 Importing IV_REPR_NAME Call by reference Type reference (TYPE) /BCV/UIF_REPR_NAME Representation name 20090917
# Exception Resumable Description Created on
1 MAX_REACHED Maximum number of personalized charts has been reached 20091209
2 NAME_EXISTS Representation name already been used 20091209
3 SAVE_FAILED Saving representation failed 20100122

Method CREATE_OUTPUT_FORMAT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_STRUC_OUT Call by reference Object reference (TYPE REF TO) CL_ABAP_STRUCTDESCR Reference to output structure format instance 20091210
2 Exporting ET_OUTPUT_PROP Call by reference Type reference (TYPE) TY_T_OUTPUT_PROP Output Properties of Result Fields 20091211
# Exception Resumable Description Created on
1 CREATION_FAILED Creation of the structure failed 20100122

Method DEFINE_SETTINGS_LINK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VIEW Call by reference Object reference (TYPE REF TO) IF_WD_VIEW Web Dynpro: API of a View 20100831

Method DEFINE_SETTINGS_LINK on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method DETERMINE_TOOLTIP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ADD_UOM Call by reference Type reference (TYPE) BOOLE_D ABAP_FALSE Add UOM to tooltip 20130702
2 Importing IV_DATATYPE Call by reference Type reference (TYPE) /BCV/QRM_ATTRIBUTE_DATATYPE Data Type of Query Field 20110304
3 Importing IV_DECIMALS Call by reference Type reference (TYPE) /BCV/QRM_ATTRIBUTE_DECIMALS Decimals of Query Field 20110304
4 Importing IV_UOM Call by reference Type reference (TYPE) STRING Determined unit of measure 20110304
5 Importing IV_UOM_CEXIT Call by reference Type reference (TYPE) /BCV/FND_CONVEXIT Conversion exit of UOM 20130702
6 Importing IV_VALUE Call by reference Type reference (TYPE) ANY Original value 20110304
7 Returning RV_TOOLTIP Value transfer Type reference (TYPE) STRING String representation of results 20110304

Method DETERMINE_TOOLTIP on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method ERASE_PERS_REPR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_NODE_PARAM Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE DISPLAY_PARAM node in the context 20090917
# Exception Resumable Description Created on
1 ERASE_FAILED Erasing a repr failed 20100122

Method EXT_SYNCHR_INBOUND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SYNC_ACTION Call by reference Type reference (TYPE) /BCV/T_UIF_SYNCHR Synchronization relevant data 20090917

Method EXT_SYNCHR_INBOUND on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method FILL_GENERIC_PARAMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_PARAMS_NODE Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Node with globally defined attributes 20100408
2 Importing IT_METADATA Call by reference Type reference (TYPE) /BCV/T_UIF_QVIEW_METADATA Table of query view metadata 20100408
3 Importing IV_OUTPUT_TYPE Call by reference Type reference (TYPE) /BCV/UIF_OUTPUT_TYPE Available Output Types 20100408
4 Importing IV_THEME_ID Call by reference Type reference (TYPE) STRING Theme ID 20130528
# Exception Resumable Description Created on
1 EMPTY_METADATA The query view metadata table is empty 20100408

Method GET_ALL_MEANINGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ALL_MEANING Call by reference Type reference (TYPE) /BCV/T_UIF_DRILLDOWN_INPUT All meanings together with values 20091005
2 Importing IT_INDEX Call by reference Type reference (TYPE) TT_TABIX Index table 20091005
3 Importing IT_SEL_ATTR Call by reference Type reference (TYPE) /BCV/IF_UIF_REPR_TECHNOLOGY=>TT_REPR_ATTRIBUTE Table of selected attributes 20091006

Method GET_ALL_MEANINGS on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method GET_DISP_PARAM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_DISP_PARAM Value transfer Object reference (TYPE REF TO) /BCV/IF_UIF_REPR_TECHNOLOGY Common interface for representation technologies in BCV 20090917
# Exception Resumable Description Created on
1 REPR_NOT_SET No active representation settings 20090917

Method GET_METADATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_METADATA Value transfer Type reference (TYPE) /BCV/T_UIF_QVIEW_METADATA Query View Result Metadata 20120330

Method GET_METADATA on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method GET_ORIGINAL_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ATTRIBUTE Call by reference Type reference (TYPE) /BCV/QRM_ATTRIBUTE_ID Representation attribute 20090917
2 Importing IV_IDX Call by reference Type reference (TYPE) I Table index 20090917
3 Returning RV_VALUE Value transfer Type reference (TYPE) STRING Attribute value 20090917

Method GET_ORIGINAL_VALUE on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method GET_PERS_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_CONFIG_KEY Call by reference Type reference (TYPE) WDY_CONFIG_KEY Key Components of Configuration Tables 20090917
2 Importing IV_CONFIG_VAR Call by reference Type reference (TYPE) STRING Representation id 20090917

Method GET_PERS_KEY on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method GET_SAP_THEME 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 20130528
2 Returning RV_THEME_ID Value transfer Type reference (TYPE) STRING Theme ID 20130528

Method GET_SAP_THEME on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method IS_DISP_PARAM_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RF_DISP_PARAM_SET Value transfer Type reference (TYPE) WDY_BOOLEAN Supplement for True Boolean Type: 'X' == True '' == False 20090917

Method IS_DISP_PARAM_SET on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method MODIFYVIEW_SETTINGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CURR_VIEW Call by reference Object reference (TYPE REF TO) IF_WD_VIEW Web Dynpro: API of a View 20090917
2 Importing IO_NODE_PARAM Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Parameters node 20091027

Method MODIFYVIEW_SETTINGS on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method PREPARE_OUTPUT_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ER_QUERY_RESULT Call by reference Object reference (TYPE REF TO) DATA Synchronized table of query results 20090917

Method PREPARE_OUTPUT_TAB on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method REPR_CHOSEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_REPR Call by reference Object reference (TYPE REF TO) /BCV/IF_UIF_REPR_TECHNOLOGY Settings instance 20091029
2 Exporting EV_REPR_NAME Call by reference Type reference (TYPE) /BCV/UIF_REPR_NAME Representation name 20090917
3 Importing IV_REPR_ID Call by reference Type reference (TYPE) /BCV/UIF_REPR_ID Representation ID 20090917

Method REPR_CHOSEN on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method SAVE_SIDEPANEL_PERS Signature

Method SAVE_SIDEPANEL_PERS on class /BCV/CL_UIF_QVIEW_ASSIST has no parameter.
Method SAVE_SIDEPANEL_PERS on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method SET_DISP_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_QVIEW_RESULT Call by reference Type reference (TYPE) /BCV/T_UIF_QVIEW_RESULT Query View Result Data 20091104
# Exception Resumable Description Created on
1 EMPTY_RESULT_TABLE Query result table is empty 20090917

Method SET_DISP_DIMENSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_PARAMS_NODE Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Context node containing display parameters 20091217
2 Importing IV_HEIGHT Call by reference Type reference (TYPE) I Display height 20091217
3 Importing IV_WIDTH Call by reference Type reference (TYPE) I Display width 20091217

Method SET_DISP_DIMENSION on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.

Method SET_DISP_PARAM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EF_GLOBAL Call by reference Type reference (TYPE) WDY_BOOLEAN Global or personalized representaiton 20100408
2 Exporting EV_REPR_NAME Call by reference Type reference (TYPE) /BCV/UIF_REPR_NAME Name of the personalized representation 20100408
3 Importing IO_PARAMS_NODE Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Display parameters context node in Web Dynpro 20100408
4 Importing IR_REPR_SETTING Call by reference Object reference (TYPE REF TO) /BCV/IF_UIF_REPR_TECHNOLOGY Common interface for representation technologies in BCV 20100408
5 Importing IV_DEFAULT_REPR_ID Call by reference Type reference (TYPE) /BCV/UIF_REPR_ID Id of the default representation 20100408
6 Importing IV_PERS_OFF Call by reference Type reference (TYPE) WDY_BOOLEAN Switch off the personalization 20100408
# Exception Resumable Description Created on
1 EMPTY_METADATA Empty metadata table 20100408
2 EMPTY_REPR_TABLE Empty representation table 20100408
3 WRONG_REPR_ID Wrong default representation id 20100408

Method TOGGLE_SETTINGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PARAM_NODE Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Web Dynpro: Interface for Context Nodes 20090917

Method TOGGLE_SETTINGS on class /BCV/CL_UIF_QVIEW_ASSIST has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 702