SAP ABAP Interface /BCV/IF_SIN_EQ (Easy Query Interface)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-EPT-BCV (Application Component) Business Context Viewer
⤷
/BCV/SIN (Package) BCV Search Integration Layer
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /BCV/CL_SIN_SEARCH_EQ_CALL | Easy Query Call Class | 20120724 |
Properties
| Interface | /BCV/IF_SIN_EQ | |
| Short Description | Easy Query Interface |
General Data
| Package | /BCV/SIN | BCV Search Integration Layer |
| Created | 20120724 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
Interface /BCV/IF_SIN_EQ has no forward declaration.
Interfaces
Interface /BCV/IF_SIN_EQ has no interface.
Friends
Interface /BCV/IF_SIN_EQ has no friend.
Attributes
Interface /BCV/IF_SIN_EQ has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Execute given query | 20120724 | |
| 2 | Static method | Public | Method | Get metadata of given InfoObject | 20120731 | |
| 3 | Static method | Public | Method | Get InfoProviders with queries accessible via Easy Query | 20120726 | |
| 4 | Static method | Public | Method | Get metadata of given query keyfigure | 20120810 | |
| 5 | Static method | Public | Method | Get queries accessible via Easy Query | 20120724 | |
| 6 | Static method | Public | Method | Get metadata of given query | 20120724 | |
| 7 | Static method | Public | Method | Is Easy Query interface available in given system | 20120823 | |
| 8 | Static method | Public | Method | Read data provider header from database | 20120730 |
Events
Interface /BCV/IF_SIN_EQ has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_CHANGE_DATE | Public | Type reference (TYPE) | /BCV/FND_DATE | Change date | 20120724 | |
| 2 | TY_CHANGE_TIME | Public | Type reference (TYPE) | /BCV/FND_TIME | Change time | 20120724 | |
| 3 | TY_CHANGE_USER | Public | Type reference (TYPE) | /BCV/FND_USER | Change user | 20120724 | |
| 4 | TY_COLUMN_DATATYPE | Public | Type reference (TYPE) | /BCV/SIN_CHAR010 | Column datatype | 20120724 | |
| 5 | TY_COLUMN_DESCR | Public | Type reference (TYPE) | SCRTEXT_L | Column description | 20120724 | |
| 6 | TY_COLUMN_NAME | Public | Type reference (TYPE) | FIELDNAME | Column name | 20120724 | |
| 7 | TY_COLUMN_NAME_EXT | Public | Type reference (TYPE) | CHAR255 | Column name (external) | 20120724 | |
| 8 | TY_CREATE_DATE | Public | Type reference (TYPE) | /BCV/FND_DATE | Creation date | 20120724 | |
| 9 | TY_CREATE_TIME | Public | Type reference (TYPE) | /BCV/FND_TIME | Creation time | 20120724 | |
| 10 | TY_CREATE_USER | Public | Type reference (TYPE) | /BCV/FND_USER | Creation user | 20120724 | |
| 11 | TY_DUE_DATE | Public | Type reference (TYPE) | RSBOLAP_DATE | Due date | 20120724 | |
| 12 | TY_ERROR_OCCURRED | Public | Type reference (TYPE) | RS_BOOL | Error occurred | 20120724 | |
| 13 | TY_FIELD_TYPE | Public | Type reference (TYPE) | /BCV/SIN_CHAR001 | Field type | 20120724 | |
| 14 | TY_HAS_VALUE_HELP | Public | Type reference (TYPE) | RS_BOOL | Has value help | 20120724 | |
| 15 | TY_INFOOBJECT | Public | Type reference (TYPE) | RSIOBJNM | InfoObject | 20120731 | |
| 16 | TY_IPROV_DESCR | Public | Type reference (TYPE) | RSBOLAP_OBJECT_TEXT | InfoProvider description | 20120724 | |
| 17 | TY_IPROV_NAME | Public | Type reference (TYPE) | RSBOLAP_OBJECT_NAME | InfoProvider name | 20120724 | |
| 18 | TY_IS_FILTERABLE | Public | Type reference (TYPE) | RS_BOOL | Is filterable | 20120724 | |
| 19 | TY_IS_KEY | Public | Type reference (TYPE) | RS_BOOL | Is key | 20120724 | |
| 20 | TY_IS_MANDATORY | Public | Type reference (TYPE) | RS_BOOL | Is mandatory | 20120724 | |
| 21 | TY_IS_TECHNICAL | Public | Type reference (TYPE) | RS_BOOL | Is technical | 20120724 | |
| 22 | TY_KEYFIGURE_NAME | Public | Type reference (TYPE) | RSKYFNM | Key figure | 20120810 | |
| 23 | TY_LENGTH | Public | Type reference (TYPE) | DDLEN | Length | 20120724 | |
| 24 | TY_MAX_ROWS | Public | Type reference (TYPE) | /BCV/FND_INT4 | Return x rows | 20120724 | |
| 25 | TY_QUERY_DESCR | Public | Type reference (TYPE) | RSTXTLG | Query description | 20120724 | |
| 26 | TY_QUERY_ID | Public | Type reference (TYPE) | RSZCOMPID | Query ID | 20120724 | |
| 27 | TY_QUERY_NAME | Public | Type reference (TYPE) | RSBOLAP_OBJECT_NAME | Query name | 20120724 | |
| 28 | TY_QUERY_NAME_EXT | Public | Type reference (TYPE) | CHAR255 | Query name (external) | 20120724 | |
| 29 | TY_QUERY_NAME_EXT_VERS | Public | Type reference (TYPE) | /BCV/SIN_NUMC4 | Query name version | 20120724 | |
| 30 | TY_QUERY_TEXT | Public | Type reference (TYPE) | RSBOLAP_OBJECT_TEXT | Query text | 20120724 | |
| 31 | TY_REFRESH_DATE | Public | Type reference (TYPE) | /BCV/FND_DATE | Refresh date | 20120724 | |
| 32 | TY_REFRESH_TIME | Public | Type reference (TYPE) | /BCV/FND_TIME | Refresh time | 20120724 | |
| 33 | TY_SELOPT_OPTION | Public | Type reference (TYPE) | RSZ_OPERATOR | Select option: option | 20120724 | |
| 34 | TY_SELOPT_SIGN | Public | Type reference (TYPE) | RALDB_SIGN | Select option: sign | 20120724 | |
| 35 | TY_SELOPT_VALUE | Public | Type reference (TYPE) | RSCHAVL | Select option: low/high value | 20120724 | |
| 36 | TY_SKIP_ROWS | Public | Type reference (TYPE) | /BCV/FND_INT4 | Skip first x rows | 20120724 | |
| 37 | TY_S_INFOPROVIDER | Public | See coding | InfoProvider structure | 20120726 | BEGIN OF ty_s_infoprovider,
infoprovider_name TYPE ty_iprov_name,
infoprovider_text TYPE ty_iprov_descr,
END OF ty_s_infoprovider
|
|
| 38 | TY_S_IOBJ_METADATA | Public | Type reference (TYPE) | /BCV/S_SIN_BAPI6108 | InfoObject metadata | 20120731 | |
| 39 | TY_S_KEYF_METADATA | Public | Type reference (TYPE) | /BCV/S_SIN_BAPI6110MES | Keyfigure metadata | 20120810 | |
| 40 | TY_S_QUERY | Public | See coding | Query structure | 20120724 | BEGIN OF ty_s_query,
query TYPE ty_query_id,
query_description TYPE ty_query_descr,
query_name_ext TYPE ty_query_name_ext,
query_name_ext_version TYPE ty_query_name_ext_vers,
END OF ty_s_query
|
|
| 41 | TY_S_QUERY_COLUMN | Public | See coding | Query column structure | 20120724 | BEGIN OF ty_s_query_column,
column_name TYPE ty_column_name,
column_name_ext TYPE ty_column_name_ext,
data_type TYPE ty_column_datatype,
column_description TYPE ty_column_descr,
length TYPE ty_length,
fieldtype TYPE ty_field_type,
reffield TYPE ty_column_name,
textfield TYPE ty_column_name,
unittype TYPE ty_unit_type,
is_key TYPE ty_is_key,
is_technical TYPE ty_is_technical,
is_filterable TYPE ty_is_filterable,
END OF ty_s_query_column
|
|
| 42 | TY_S_QUERY_METADATA | Public | See coding | Query metadata structure | 20120724 | BEGIN OF ty_s_query_metadata,
infoprovider_name TYPE ty_iprov_name,
infoprovider_text TYPE ty_iprov_descr,
duedate TYPE ty_due_date,
query_name TYPE ty_query_name,
query_text TYPE ty_query_text,
query_created_by TYPE ty_create_user,
query_creation_date TYPE ty_create_date,
query_creation_time TYPE ty_create_time,
query_changed_by TYPE ty_change_user,
query_change_date TYPE ty_change_date,
query_change_time TYPE ty_change_time,
data_refresh_date TYPE ty_refresh_date,
data_refresh_time TYPE ty_refresh_time,
query_name_ext TYPE ty_query_name_ext,
query_name_ext_version TYPE ty_query_name_ext_vers,
END OF ty_s_query_metadata
|
|
| 43 | TY_S_QUERY_VARIABLE | Public | See coding | Query variable structure | 20120724 | BEGIN OF ty_s_query_variable,
var_name TYPE ty_variable_name,
var_name_ext TYPE ty_variable_name_ext,
description TYPE ty_variable_descr,
mandatory TYPE ty_is_mandatory,
datatype TYPE ty_variable_datatype,
input_length TYPE ty_length,
var_type TYPE ty_variable_type,
ref_name TYPE ty_variable_refname,
value_help TYPE ty_has_value_help,
char_name TYPE ty_infoobject,
END OF ty_s_query_variable
|
|
| 44 | TY_S_SELECT_OPTION | Public | See coding | Select option structure | 20120724 | BEGIN OF ty_s_select_option,
var_name TYPE ty_variable_name,
sign TYPE ty_selopt_sign,
option TYPE ty_selopt_option,
low TYPE ty_selopt_value,
high TYPE ty_selopt_value,
END OF ty_s_select_option
|
|
| 45 | TY_T_COLUMN_SEL | Public | See coding | Column selection table | 20120725 | ty_t_column_sel TYPE STANDARD TABLE OF rsfieldsel
WITH NON-UNIQUE KEY fieldnm
|
|
| 46 | TY_T_INFOPROVIDER | Public | See coding | InfoProvider table | 20120726 | ty_t_infoprovider TYPE STANDARD TABLE OF ty_s_infoprovider
WITH NON-UNIQUE KEY infoprovider_name
|
|
| 47 | TY_T_MESSAGE | Public | Type reference (TYPE) | BAPIRETTAB | Message table | 20120724 | |
| 48 | TY_T_QUERY | Public | See coding | Query table | 20120724 | ty_t_query TYPE STANDARD TABLE OF ty_s_query
WITH NON-UNIQUE KEY query
|
|
| 49 | TY_T_QUERY_COLUMN | Public | See coding | Query column table | 20120724 | ty_t_query_column TYPE STANDARD TABLE OF ty_s_query_column
WITH NON-UNIQUE KEY column_name
|
|
| 50 | TY_T_QUERY_METADATA | Public | See coding | Query metadata table | 20120724 | ty_t_query_metadata TYPE STANDARD TABLE OF ty_s_query_metadata
WITH NON-UNIQUE KEY query_name
|
|
| 51 | TY_T_QUERY_VARIABLE | Public | See coding | Query variable table | 20120724 | ty_t_query_variable TYPE STANDARD TABLE OF ty_s_query_variable
WITH NON-UNIQUE KEY var_name
|
|
| 52 | TY_T_SELECT_OPTION | Public | See coding | Select option table | 20120724 | ty_t_select_option TYPE STANDARD TABLE OF ty_s_select_option
WITH NON-UNIQUE KEY var_name
|
|
| 53 | TY_UNIT_TYPE | Public | Type reference (TYPE) | /BCV/SIN_CHAR001 | Unit type | 20120724 | |
| 54 | TY_VARIABLE_DATATYPE | Public | Type reference (TYPE) | /BCV/SIN_CHAR001 | Variable datatype | 20120724 | |
| 55 | TY_VARIABLE_DESCR | Public | Type reference (TYPE) | /BCV/SIN_CHAR060 | Variable description | 20120724 | |
| 56 | TY_VARIABLE_NAME | Public | Type reference (TYPE) | RSZVNAM | Variable name | 20120724 | |
| 57 | TY_VARIABLE_NAME_EXT | Public | Type reference (TYPE) | CHAR255 | Variable name (external) | 20120724 | |
| 58 | TY_VARIABLE_REFNAME | Public | Type reference (TYPE) | /BCV/SIN_CHAR030 | Variable reference name | 20120724 | |
| 59 | TY_VARIABLE_TYPE | Public | Type reference (TYPE) | /BCV/SIN_CHAR001 | Variable type | 20120724 | |
Method Signatures
Method EXECUTE_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_RESULT_TAB | Call by reference | Object reference (TYPE REF TO) | DATA | Result data table (created by method) | 20120820 | |||
| 2 | ET_QUERY_COLUMN | Call by reference | Type reference (TYPE) | TY_T_QUERY_COLUMN | Query columns | 20120724 | |||
| 3 | IT_COLUMN_SELECTION | Call by reference | Type reference (TYPE) | TY_T_COLUMN_SEL | Column selection | 20120724 | |||
| 4 | IT_FILTER | Call by reference | Type reference (TYPE) | TY_T_SELECT_OPTION | Filter | 20120724 | |||
| 5 | IT_QUERY_VARIABLE | Call by reference | Type reference (TYPE) | TY_T_SELECT_OPTION | Variable Values | 20120724 | |||
| 6 | IV_MASTER_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120724 | |||
| 7 | IV_MAX_ROWS | Call by reference | Type reference (TYPE) | TY_MAX_ROWS | Return x rows | 20120724 | |||
| 8 | IV_QUERY_ID | Call by reference | Type reference (TYPE) | TY_QUERY_ID | Query ID | 20120724 | |||
| 9 | IV_SKIP_ROWS | Call by reference | Type reference (TYPE) | TY_SKIP_ROWS | Skip first x rows | 20120724 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class for SIN BI | 20120726 |
Method GET_INFOOBJECT_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_METADATA | Call by reference | Type reference (TYPE) | TY_S_IOBJ_METADATA | InfoObject metadata | 20120731 | |||
| 2 | IV_INFOOBJECT | Call by reference | Type reference (TYPE) | TY_INFOOBJECT | InfoObject | 20120731 | |||
| 3 | IV_MASTER_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120731 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class for SIN BI | 20120731 |
Method GET_INFOPROVIDERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_INFOPROVIDER | Call by reference | Type reference (TYPE) | TY_T_INFOPROVIDER | InfoProvider table | 20120726 | |||
| 2 | IV_MASTER_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120726 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class for SIN BI | 20120726 |
Method GET_KEYFIGURE_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_METADATA | Call by reference | Type reference (TYPE) | TY_S_KEYF_METADATA | Key figure metadata | 20120810 | |||
| 2 | IV_IPROVIDER_NAME | Call by reference | Type reference (TYPE) | TY_IPROV_NAME | InfoProvider name | 20120810 | |||
| 3 | IV_KEYFIGURE_NAME | Call by reference | Type reference (TYPE) | TY_KEYFIGURE_NAME | Key figure | 20120810 | |||
| 4 | IV_MASTER_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120810 | |||
| 5 | IV_QUERY_ID | Call by reference | Type reference (TYPE) | TY_QUERY_ID | Query ID | 20120810 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class for SIN BI | 20120810 |
Method GET_QUERIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_QUERY | Call by reference | Type reference (TYPE) | TY_T_QUERY | Query table | 20120724 | |||
| 2 | IV_INFOPROVIDER | Call by reference | Type reference (TYPE) | TY_IPROV_NAME | InfoProvider | 20120727 | |||
| 3 | IV_MASTER_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120724 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class for SIN BI | 20120726 |
Method GET_QUERY_METADATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_QUERY_METADATA | Call by reference | Type reference (TYPE) | TY_S_QUERY_METADATA | Query metadata | 20120724 | |||
| 2 | ET_QUERY_COLUMN | Call by reference | Type reference (TYPE) | TY_T_QUERY_COLUMN | Query columns | 20120724 | |||
| 3 | ET_QUERY_VARIABLE | Call by reference | Type reference (TYPE) | TY_T_QUERY_VARIABLE | Query variables | 20120724 | |||
| 4 | IV_MASTER_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120724 | |||
| 5 | IV_QUERY_ID | Call by reference | Type reference (TYPE) | TY_QUERY_ID | Query ID | 20120724 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class for SIN BI | 20120726 |
Method IS_EQ_INTERFACE_AVAILABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SYSTEM | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20120823 | |||
| 2 | RV_AVAILABLE | Value transfer | Type reference (TYPE) | BOOLE_D | Easy Query interface available | 20120823 |
Method IS_EQ_INTERFACE_AVAILABLE on Interface /BCV/IF_SIN_EQ has no exception.
Method SELECT_DSBI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_DSBI | Call by reference | Type reference (TYPE) | /BCV/C_DSBI | Data Provider BI Query | 20120730 | |||
| 2 | IV_SEARCH_ID | Call by reference | Type reference (TYPE) | /BCV/SIN_SEARCH_ID | Search Connector ID | 20120730 |
Method SELECT_DSBI on Interface /BCV/IF_SIN_EQ has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 747 |