SAP ABAP Class CL_EQ_GWI_HELPER (Helper Class for Gateway Integration)
Hierarchy
SAP_BW (Software Component) SAP Business Warehouse
   BW-BEX-OT-BICS-EQ (Application Component) BICS Easy Query
     BW_BICS_EQ (Package) Easy Query
Properties
Class CL_EQ_GWI_HELPER  
Short Description Helper Class for Gateway Integration    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package BW_BICS_EQ   Easy Query 
Created 20110527   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
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_EQ_BICS_RUNTIME Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_BICS_MD_CHARACTERISTIC Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_EQ_GWI_HELPER has no interface implemented.
Friends
Class CL_EQ_GWI_HELPER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 N_FUNCTION_MODULE_NAME Instance attribute Public Type reference (TYPE) RS38L_FNAM Name of Function Module 20110527
2 N_INFO_PROV Instance attribute Public Type reference (TYPE) RSINFOCUBE InfoCube 20110527
3 N_QUERY_NAME Instance attribute Public Type reference (TYPE) RSZCOMPID Name (ID) of a Reporting Component 20110527
4 N_R_MESSAGE_MANAGER Instance attribute Public Object reference (TYPE REF TO) IF_BICS_MESSAGE_MANAGER Message Manager in BW BICS 20110527
5 N_R_QUERY_VIEW Instance attribute Public Object reference (TYPE REF TO) IF_BICS_QV Query View 20110527
6 N_S_QUERY_MD Instance attribute Public Type reference (TYPE) RSEQ_S_QUERY_MD Query Metadata 20110527
7 N_S_STATISTICS Instance attribute Public Type reference (TYPE) TN_S_STATISTICS Runtime Statistics in Microseconds 20110527
8 N_T_COLUMN_DESCRIPTION Instance attribute Public Type reference (TYPE) RSEQ_T_COLUMN_DESCRIPTION Column Description for the Generated Easy Query 20110527
9 N_T_QUERY_VARIABLES_INP Instance attribute Public Type reference (TYPE) RSEQ_T_SELECT_OPTION2 Query Variables 20110527
10 N_T_QUERY_VARIABLES_MAND Instance attribute Public Type reference (TYPE) RSEQ_T_SELECT_OPTION2 Mandatory Query Variables 20110531
11 N_T_QUERY_VARIABLES_MD Instance attribute Public Type reference (TYPE) CL_EQ_BICS_RUNTIME=>TN_T_VARIABLE_GW Query Variables MD 20110531
12 N_T_ROW_DESCRIPTION Instance attribute Public Type reference (TYPE) RSEQ_T_ROW_DESCRIPTION Metadata Rows for Grid of Generated Easy Query 20111111
13 P_NUM_OF_CHAR_ON_ROWS_AXIS Instance attribute Private Type reference (TYPE) I Characteristics in the Drildown in the Rows 20110527
14 P_R_BICS_RUNTIME Instance attribute Private Object reference (TYPE REF TO) CL_EQ_BICS_RUNTIME BICS Accesses for Easy Query Generation 20110527
15 P_R_COLUMN_DESCRIPTION Instance attribute Private Object reference (TYPE REF TO) RSEQ_T_COLUMN_DESCRIPTION Column description 20110527
16 P_R_MESSAGE_LOG Instance attribute Private Object reference (TYPE REF TO) BAPIRETTAB Table with BAPI Return Information 20110527
17 P_R_ROW_DESCRIPTION Instance attribute Private Object reference (TYPE REF TO) RSEQ_T_ROW_DESCRIPTION Description of Lines 20110527
18 P_T_EXPORT_PARAMETER Instance attribute Public See coding 20110527
19 P_T_HTML Instance attribute Private Type reference (TYPE) TN_T_HTML Rendered HTML Rows 20110527
20 P_T_IMPORT_PARAMETER Instance attribute Public See coding 20110527
21 P_T_TABLES_PARAMETER Instance attribute Public See coding 20110527
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ROWDESCRIPTION_DATA Instance method Public Method Insert Additional Info from Row Description 20111118
2 BUILD_KEY_FOR_CHAR_VALUE Instance method Public Method GW ROWID Part of the Characteristic Values 20110610
3 BUILD_KEY_FOR_QVARIABLES Instance method Public Method GW ROWID Part of the Query Variables 20110610
4 BUILD_RS_STRUCTURE Static method Public Method Build RS Structure 20110610
5 CLOSE Instance method Public Method End and Clean Up Instances 20120606
6 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20110527
7 DECODE_KEYS Instance method Public Method Decode GW Row ID: Determine Variables and Char. Values 20110617
8 GET_DESIGNTIME Instance method Public Method EQ-FB: Read Metadata 20110527
9 GET_RUNTIME Instance method Public Method EQ-FB: Read RS 20110527
10 GET_VALUE_HELP Instance method Public Method Read Input Help for a Variable 20110615
11 GET_VAR_ARBITRARY_DEFAULTS Instance method Public Method Find Random Values for Query Variables 20110527
12 SET_FIELD_SELECTION Instance method Public Method Set Field Selections 20120529
13 SET_FILTER_SELECTION Instance method Public Method Set Filter selection 20120706
14 SET_VARIABLES_AND_SUBMIT Instance method Public Method Set Values of Query Variables 20110614
15 _CHECK_FOR_COMPOUNDED_CHAR Instance method Private Method check character and character values 20120718
16 _CHECK_LAST2DIGIT Instance method Private Method Find Last Two Characters of a Field 20111111
17 _CHECK_UNIT_TYPE Instance method Private Method Check Uniqueness of Characteristic 20111111
18 _ENHANCE_CHAR_PRESENTATIONS Instance method Private Method Check and Enhance Display Types for Characteristic 20120120
19 _EXECUTE_FUNCTION_MODULE Instance method Private Method Execute FuMo 20110527
20 _GET_ADD_COLUMN_FOR_HIERARCHY Instance method Private Method Additional Columns on Hierarchies for Paren, Level&Drill St. 20111118
21 _GET_CHAR_MD_DATA Instance method Private Method Read Metadata from a Characteristic 20111111
22 _GET_CHAR_MEMEBER_COMP_VALUE Instance method Private Method get character value with pres. KEY for value with KEY_NC 20120718
23 _GET_COLUMN_NAME_EXTERNAL Instance method Private Method Find External Column Name for a Column 20111202
24 _GET_MORE_VARIABLES_DATA Instance method Private Method Find Further Variables Data 20111111
25 _GET_RELATED_KEYFIGURE Instance method Private Method Ermitteln der zugehörigen Kennzahl zu einer Strukturmember 20120731
26 _GET_VARIABLES Instance method Private Method Read Query Variables (Names) 20110527
27 _GET_VARIABLE_VALUES Instance method Private Method Read Any Values for Variables 20110527
28 _INITIALIZE Instance method Private Method Initialize Query 20110527
29 _READ_FUMOD_SIGNATURE Instance method Private Method Read Function Module Signature 20110527
30 _TRANSFORM_MESSAGES Instance method Private Method Transform Messages 20110527
Events
Class CL_EQ_GWI_HELPER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TN_S_CHAR_MD Public See coding Characteristic for Metadata 20111216 BEGIN OF tn_s_char_md, mixed_mode type abap_bool, text_mode TYPE abap_bool, s_char_md type if_bics_md_characteristic=>tn_s_md_characteristic, is_compounded type abap_bool, hierarchy_is_active type abap_bool, compounded_parent type if_bics_object=>tn_name, END OF tn_s_char_md
2 TN_S_HTML Public See coding HTML Row 20110527 BEGIN OF tn_s_html, html_line TYPE c LENGTH 255 , END OF tn_s_html
3 TN_S_STATISTICS Public See coding Runtime Statistics in Microseconds 20110527 begin of TN_s_STATISTICS, fumod_execution_time type i, rendering_time type i, end of TN_s_STATISTICS
4 TN_T_FIELDS Public See coding 20120529 tn_t_fields TYPE TABLE OF RSFIELDSEL
5 TN_T_HTML Public See coding HTML Rows 20110527 tn_t_html TYPE STANDARD TABLE OF tn_s_html WITH NON-UNIQUE KEY html_line
6 TN_T_STRING Public See coding Table of Strings 20120529 tn_t_string type standard table of string with default key
Method Signatures

Method ADD_ROWDESCRIPTION_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_T_RS_GW Call by reference Type reference (TYPE) TABLE Resultset im Gateway-format 20111118

Method ADD_ROWDESCRIPTION_DATA on class CL_EQ_GWI_HELPER has no exception.

Method BUILD_KEY_FOR_CHAR_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_QVAR_KEY Call by reference Type reference (TYPE) STRING 20120529
2 Importing I_QVAR_LEN Call by reference Type reference (TYPE) STRING 20120529
3 Returning R_T_KEY Value transfer Type reference (TYPE) TN_T_STRING Tabelle von Strings 20120529

Method BUILD_KEY_FOR_CHAR_VALUE on class CL_EQ_GWI_HELPER has no exception.

Method BUILD_KEY_FOR_QVARIABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_QVAR_KEY Call by reference Type reference (TYPE) STRING Schlüsselanteil der Query Variablen 20110610
2 Exporting E_QVAR_LEN Call by reference Type reference (TYPE) STRING Schlüssellänge Beschreibung 20110610
3 Importing I_T_QUERY_VAR_INP Call by reference Type reference (TYPE) RSEQ_T_GWI_SELECT_OPTION Selektionsoptionen mit Variable und Query 20110610
4 Importing I_T_QUERY_VAR_MD Call by reference Type reference (TYPE) RSEQ_T_GWI_QVAR Queryvariablen Metadaten für GateWayIntegration 20110610

Method BUILD_KEY_FOR_QVARIABLES on class CL_EQ_GWI_HELPER has no exception.

Method BUILD_RS_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_T_QUERY_RS_STRUC Call by reference Type reference (TYPE) RSEQ_T_GWI_QUERY_STRUC Spalten Beschreibung für GateWayIntegration 20110610
2 Returning R_R_RS_TAB Value transfer Object reference (TYPE REF TO) CL_ABAP_TABLEDESCR Run Time Type Services 20110610

Method BUILD_RS_STRUCTURE on class CL_EQ_GWI_HELPER has no exception.

Method CLOSE Signature

Method CLOSE on class CL_EQ_GWI_HELPER has no parameter.
Method CLOSE on class CL_EQ_GWI_HELPER has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_FUNCTION_MODULE_NAME Call by reference Type reference (TYPE) RS38L_FNAM Name des Funktionsbausteins 20110527

Method CONSTRUCTOR on class CL_EQ_GWI_HELPER has no exception.

Method DECODE_KEYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_T_CHARACTERS Call by reference Type reference (TYPE) ANY TABLE 20110617
2 Exporting E_T_QUERY_VAR_INP Call by reference Type reference (TYPE) RSEQ_T_GWI_SELECT_OPTION Selektionsoptionen mit Variable und Query 20110617
3 Importing I_ROW_ID Call by reference Type reference (TYPE) STRING ROWID 20110617
4 Importing I_T_QUERY_VAR_MD Call by reference Type reference (TYPE) RSEQ_T_GWI_QVAR 20110617
# Exception Resumable Description Created on
1 CX_SY_CONVERSION_NO_NUMBER System-Exception bei Umwandlung in eine Zahl 20110804
2 CX_SY_RANGE_OUT_OF_BOUNDS System-Exceptions bei Teilfeldzugriff außerhalb der Grenzen 20110804

Method GET_DESIGNTIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_QUERY_DETAILS Call by reference Type reference (TYPE) RSEQ_S_GWI_QUERY_MD Query Meta Daten 20110527
2 Exporting E_T_COLUMN_DESCRIPTION Call by reference Type reference (TYPE) RSEQ_T_GWI_QUERY_STRUC Spalten Beschreibung für GateWayIntegration 20110527
3 Exporting E_T_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Tabelle mit BAPI Return Informationen 20110726
4 Exporting E_T_QUERY_VAR_MD Call by reference Type reference (TYPE) RSEQ_T_GWI_QVAR Queryvariablen Metadaten für GateWayIntegration 20110816

Method GET_DESIGNTIME on class CL_EQ_GWI_HELPER has no exception.

Method GET_RUNTIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_T_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Tabelle mit BAPI Return Informationen 20110726
2 Exporting E_T_RESULT_SET Call by reference Type reference (TYPE) DATA 20110527
3 Importing I_T_QUERY_VARIABLES Call by reference Type reference (TYPE) RSEQ_T_GWI_SELECT_OPTION Selektionsoptionen mit Variable und Query 20110527

Method GET_RUNTIME on class CL_EQ_GWI_HELPER has no exception.

Method GET_VALUE_HELP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning E_T_VALUE_HELP Value transfer Type reference (TYPE) RSEQ_T_VALUE_HELP Wertehilfe (F4) 20110615
2 Importing I_VAR_NAME Call by reference Type reference (TYPE) RSZVNAM Name (ID) einer Berichtsvariablen 20110615

Method GET_VALUE_HELP on class CL_EQ_GWI_HELPER has no exception.

Method GET_VAR_ARBITRARY_DEFAULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_S_MESSAGE Call by reference Type reference (TYPE) BAPIRET2 20110527
2 Exporting E_T_ARBITARY_VALUES Call by reference Type reference (TYPE) RSEQ_T_SELECT_OPTION2 Selektionsoptionen mit Variable und Query 20110527

Method GET_VAR_ARBITRARY_DEFAULTS on class CL_EQ_GWI_HELPER has no exception.

Method SET_FIELD_SELECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_T_FIELDS Call by reference Type reference (TYPE) TN_T_FIELDS Schnittstelle: Liste der angeforderten Felder 20120529
2 Returning R_T_MESSAGES Value transfer Type reference (TYPE) BAPIRETTAB Tabelle mit BAPI Return Informationen 20120529

Method SET_FIELD_SELECTION on class CL_EQ_GWI_HELPER has no exception.

Method SET_FILTER_SELECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_T_FILTER Call by reference Type reference (TYPE) RSEQ_T_GWI_SELECT_OPTION Selektionsoptionen mit Variable und Query 20120706
2 Returning R_T_MESSAGES Value transfer Type reference (TYPE) BAPIRETTAB Tabelle mit BAPI Return Informationen 20120706

Method SET_FILTER_SELECTION on class CL_EQ_GWI_HELPER has no exception.

Method SET_VARIABLES_AND_SUBMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_T_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Tabelle mit BAPI Return Informationen 20110614
2 Importing I_T_VARIABLES Call by reference Type reference (TYPE) RSEQ_T_GWI_SELECT_OPTION Selektionsoptionen mit Variable und Query 20110614

Method SET_VARIABLES_AND_SUBMIT on class CL_EQ_GWI_HELPER has no exception.

Method _CHECK_FOR_COMPOUNDED_CHAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_S_FILTER Call by reference Type reference (TYPE) CL_EQ_BICS_RUNTIME=>TN_S_SELECTION_VALUE Filterkriterium 20120718
2 Returning R_S_FILTER Value transfer Type reference (TYPE) CL_EQ_BICS_RUNTIME=>TN_S_SELECTION_VALUE Filterkriterium im BICS-format 20120718

Method _CHECK_FOR_COMPOUNDED_CHAR on class CL_EQ_GWI_HELPER has no exception.

Method _CHECK_LAST2DIGIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_FIELD Call by reference Type reference (TYPE) FIELDNAME Feldname 20111111
2 Returning R_LAST2DIGITS Value transfer Type reference (TYPE) CHAR2 20111111

Method _CHECK_LAST2DIGIT on class CL_EQ_GWI_HELPER has no exception.

Method _CHECK_UNIT_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CHAR_NAME Call by reference Type reference (TYPE) FIELDNAME 20111111
2 Returning R_UNIT_TYPE Value transfer Type reference (TYPE) CHAR1 Einstelliges Kennzeichen 20111111

Method _CHECK_UNIT_TYPE on class CL_EQ_GWI_HELPER has no exception.

Method _ENHANCE_CHAR_PRESENTATIONS Signature

Method _ENHANCE_CHAR_PRESENTATIONS on class CL_EQ_GWI_HELPER has no parameter.
Method _ENHANCE_CHAR_PRESENTATIONS on class CL_EQ_GWI_HELPER has no exception.

Method _EXECUTE_FUNCTION_MODULE Signature

Method _EXECUTE_FUNCTION_MODULE on class CL_EQ_GWI_HELPER has no parameter.
Method _EXECUTE_FUNCTION_MODULE on class CL_EQ_GWI_HELPER has no exception.

Method _GET_ADD_COLUMN_FOR_HIERARCHY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning E_T_HIER_COLUMN Value transfer Type reference (TYPE) RSEQ_T_GWI_QUERY_STRUC Spalten Beschreibung des ResultSets für GateWayIntegration 20111118
2 Importing I_S_COLUMN_DESCRIPTION Call by reference Type reference (TYPE) RSEQ_S_COLUMN_DESCRIPTION Spalten Beschreibung für den generierten Easy Query 20111118

Method _GET_ADD_COLUMN_FOR_HIERARCHY on class CL_EQ_GWI_HELPER has no exception.

Method _GET_CHAR_MD_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_S_CHAR_MD Call by reference Type reference (TYPE) TN_S_CHAR_MD 20120806
2 Importing I_CHAR_NAME Call by reference Type reference (TYPE) FIELDNAME Feldname 20111111

Method _GET_CHAR_MD_DATA on class CL_EQ_GWI_HELPER has no exception.

Method _GET_CHAR_MEMEBER_COMP_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_S_FILTER Call by reference Type reference (TYPE) CL_EQ_BICS_RUNTIME=>TN_S_SELECTION_VALUE Filterkriterium input-format 20120718
2 Returning R_S_FILTER Value transfer Type reference (TYPE) CL_EQ_BICS_RUNTIME=>TN_S_SELECTION_VALUE Filterkriterium BICS-format 20120718

Method _GET_CHAR_MEMEBER_COMP_VALUE on class CL_EQ_GWI_HELPER has no exception.

Method _GET_COLUMN_NAME_EXTERNAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_V_COLUMN_DESCRIPTION Call by reference Type reference (TYPE) CHAR255 char255 20111202
2 Importing I_V_COLUMN_NAME Call by reference Type reference (TYPE) FIELDNAME Feldname 20111202
3 Returning R_V_COLUMN_NAME_EXT Value transfer Type reference (TYPE) CHAR255 Feldname mit externer Darstellung 20111202

Method _GET_COLUMN_NAME_EXTERNAL on class CL_EQ_GWI_HELPER has no exception.

Method _GET_MORE_VARIABLES_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_S_METADATA Call by reference Type reference (TYPE) RSEQ_S_GWI_QVAR Queryvariablen Metadaten für GateWayIntegration 20111111
2 Importing I_VAR_NAME Call by reference Type reference (TYPE) RSZVNAM Name (ID) einer Berichtsvariablen 20111111

Method _GET_MORE_VARIABLES_DATA on class CL_EQ_GWI_HELPER has no exception.

Method _GET_RELATED_KEYFIGURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_STRUC_MEMBER Call by reference Type reference (TYPE) FIELDNAME Feldname 20120731
2 Returning R_MD_KEY_FIGURE Value transfer Object reference (TYPE REF TO) IF_BICS_MD_KEY_FIGURE Kennzahlen Metadaten 20120731

Method _GET_RELATED_KEYFIGURE on class CL_EQ_GWI_HELPER has no exception.

Method _GET_VARIABLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_T_QVARIABLES Value transfer Type reference (TYPE) RSEQ_T_QVARIABLE_MD Metadaten der verwendeten Query Variablen 20110527

Method _GET_VARIABLES on class CL_EQ_GWI_HELPER has no exception.

Method _GET_VARIABLE_VALUES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_S_SELECT_OPTION Call by reference Type reference (TYPE) RSEQ_S_SELECT_OPTION Selektionsoptionen 20110622
2 Importing I_PARAMETER Call by reference Type reference (TYPE) RSIMP Funktionsbibliothek: Import-Parameter 20110622

Method _GET_VARIABLE_VALUES on class CL_EQ_GWI_HELPER has no exception.

Method _INITIALIZE Signature

Method _INITIALIZE on class CL_EQ_GWI_HELPER has no parameter.
Method _INITIALIZE on class CL_EQ_GWI_HELPER has no exception.

Method _READ_FUMOD_SIGNATURE Signature

Method _READ_FUMOD_SIGNATURE on class CL_EQ_GWI_HELPER has no parameter.
Method _READ_FUMOD_SIGNATURE on class CL_EQ_GWI_HELPER has no exception.

Method _TRANSFORM_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_MESSAGES Value transfer Type reference (TYPE) ABAP_BOOL 20110527

Method _TRANSFORM_MESSAGES on class CL_EQ_GWI_HELPER has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 730