SAP ABAP Class CL_ESH_FED_METADATA_HELPER (Helper for Metadata Retrieval)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_FEDERATION (Package) Federation
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_FEDERATION (Package) FederationProperties
| Class | CL_ESH_FED_METADATA_HELPER | |
| Short Description | Helper for Metadata Retrieval | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_FEDERATION | Federation |
| Created | 20080812 | SAP |
| Last change | 20140121 | 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) |
Interfaces
Class CL_ESH_FED_METADATA_HELPER has no interface implemented.
Friends
Class CL_ESH_FED_METADATA_HELPER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GV_TREX_VERSION |
Static Attribute | Private | Type reference (TYPE) | TREXS_TREX_VERSION_INFO2-VERSION | TREX version | 20100601 | ||
| 2 | ST_RFC_DEST_BUFFER |
Static Attribute | Private | Type reference (TYPE) | LTY_T_RFC_DEST_BUFFER | 20110805 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20100601 |
| 2 | GET_ADAPTER_BY_TEMPLATE_TYPE |
Static method | Public | Method | Get adapter class by template type | 20080820 |
| 3 | GET_ATTR_BACKEND_NAME |
Static method | Public | Method | Get back-end name | 20100810 |
| 4 | GET_BACKEND_NAME |
Static method | Public | Method | Get back-end name | 20100810 |
| 5 | GET_CONNECTIVITY |
Static method | Public | Method | Get connectivity of the connector | 20080812 |
| 6 | GET_CONNECTORS_BY_KEYWORD |
Static method | Public | Method | Get search connectors by keyword | 20090127 |
| 7 | GET_CONNECTORS_BY_TEMPLATE |
Static method | Public | Method | Get search connectors by template | 20080819 |
| 8 | GET_CONNECTOR_ICON |
Static method | Public | Method | Get icon of a connector | 20081204 |
| 9 | GET_CONN_MGR_BY_TEMPLATE_TYPE |
Static method | Public | Method | Get adapter class by template type | 20081110 |
| 10 | GET_INTERACTIVE_NAV_ATTRS |
Static method | Public | Method | Get attributes for interactive navigation | 20081119 |
| 11 | GET_NAV_INFOS_BY_CONNECTOR |
Static method | Public | Method | Get navigation information by connector | 20081009 |
| 12 | GET_RESPONSE_ATTRIBUTES |
Static method | Public | Method | Get response attributes of the connector | 20080812 |
| 13 | GET_RFC_DEST_BY_CONNECTOR |
Static method | Public | Method | Get RFC destination name by connector | 20081009 |
| 14 | GET_TEMPLATE |
Static method | Public | Method | Get template belonging to the connector | 20080812 |
| 15 | GET_TEMPLATE_TYPE |
Static method | Public | Method | Get template type of the connector | 20080812 |
Events
Class CL_ESH_FED_METADATA_HELPER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LTY_S_RFC_DEST_BUFFER | Private | See coding | 20110805 | BEGIN OF lty_s_rfc_dest_buffer,
connector_id TYPE esh_e_if_search_connector_id,
rfcdest_AUTH TYPE rfcdest,
rfcdest_EXTR TYPE rfcdest,
END OF lty_s_rfc_dest_buffer
|
||
| 2 | LTY_T_RFC_DEST_BUFFER | Private | See coding | 20110805 | lty_t_rfc_dest_buffer TYPE SORTED TABLE OF lty_s_rfc_dest_buffer WITH UNIQUE KEY connector_id
|
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_ESH_FED_METADATA_HELPER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_FED_METADATA_HELPER has no exception.
Method GET_ADAPTER_BY_TEMPLATE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_TEMPLATE_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20080820 | ||
| 2 |  Returning |
RV_CLASS_NAME | Value transfer | Type reference (TYPE) | SEOCLSNAME | Object Type Name | 20080820 |
Method GET_ADAPTER_BY_TEMPLATE_TYPE on class CL_ESH_FED_METADATA_HELPER has no exception.
Method GET_ATTR_BACKEND_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ATTRIBUTE_NAME | Call by reference | Type reference (TYPE) | ESH_E_IF_ATTRIBUTE_NAME | Attribute ID | 20100810 | ||
| 2 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20100810 | ||
| 3 | Returning |
RV_BACKEND_NAME | Value transfer | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20100810 |
Method GET_ATTR_BACKEND_NAME on class CL_ESH_FED_METADATA_HELPER has no exception.
Method GET_BACKEND_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20100810 | ||
| 2 | Importing |
IV_FROM_BUFFER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20100811 | ||
| 3 | Returning |
RV_BACKEND_NAME | Value transfer | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20100810 |
Method GET_BACKEND_NAME on class CL_ESH_FED_METADATA_HELPER has no exception.
Method GET_CONNECTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20080812 | ||
| 2 | Returning |
RV_CONNECTIVITY | Value transfer | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20080812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_CO_INVALID_PARAMETER |
Invalid Parameter | 20080820 | |
| 2 | CX_ESH_CO_NOT_FOUND |
Requested Data not Found | 20080820 |
Method GET_CONNECTORS_BY_KEYWORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_CONNECTOR_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_SEARCH_CONNECTORS2 | Search Connectors | 20090127 | ||
| 2 | Importing |
IV_KEYWORD | Call by reference | Type reference (TYPE) | ESH_E_IF_KEYWORD | Keyword | 20090127 | ||
| 3 | Importing |
IV_ONLY_SEARCHABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20090904 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090127 |
Method GET_CONNECTORS_BY_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_CONNECTOR_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_SEARCH_CONNECTORS2 | Search Connectors | 20080819 | ||
| 2 | Importing |
IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20080819 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20080819 |
Method GET_CONNECTOR_ICON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20081204 | ||
| 2 | Returning |
RV_ICON | Value transfer | Type reference (TYPE) | ESH_E_IF_WEB_ICON | Icon | 20081204 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20091016 |
Method GET_CONN_MGR_BY_TEMPLATE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TEMPLATE_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20081110 | ||
| 2 | Returning |
RV_CLASS_NAME | Value transfer | Type reference (TYPE) | SEOCLSNAME | Object Type Name | 20081110 |
Method GET_CONN_MGR_BY_TEMPLATE_TYPE on class CL_ESH_FED_METADATA_HELPER has no exception.
Method GET_INTERACTIVE_NAV_ATTRS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_INT_NAV_ATTRS | Call by reference | Type reference (TYPE) | ESH_T_IF_ATTR_NAMES | Table of Attribute Names | 20081119 | ||
| 2 | Exporting |
ET_INT_NAV_RANGE_ATTRS | Call by reference | Type reference (TYPE) | ESH_T_IF_ATTR_NAMES | Table of Attribute Names | 20100913 | ||
| 3 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20081119 | ||
| 4 | Importing |
IV_REQUEST_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_REQUEST_TYPE_ID | Request Type ID | 20091009 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090625 |
Method GET_NAV_INFOS_BY_CONNECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_UI_ACCESS_PARAMS | Call by reference | Type reference (TYPE) | ESH_S_ADM_RFC_UIP | ESH: UI Technology Parameters for ABAP Backend Systems | 20081126 | ||
| 2 | Exporting |
ET_NAVIGATION_INFOS | Call by reference | Type reference (TYPE) | ESH_T_FED_NAVIGATION_INFO | Navigation Information | 20081009 | ||
| 3 | Importing |
IT_UI_TECH | Call by reference | Type reference (TYPE) | ESH_T_IF_TARGET_UI_TYPES | Navigation Target UI Type list | 20130325 | ||
| 4 | Importing |
IV_BUILD_FOR_ALL_TECHS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20130325 | |||
| 5 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20081009 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_CO_INVALID_PARAMETER |
Invalid Parameter | 20081009 | |
| 2 | CX_ESH_CO_NOT_FOUND |
Requested Data not Found | 20081009 |
Method GET_RESPONSE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_RESPONSE_ATTRIBUTES | Call by reference | Type reference (TYPE) | ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ | Meta Data: Attribute Type Objects | 20080812 | ||
| 2 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20080812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20080814 |
Method GET_RFC_DEST_BY_CONNECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_RFC_DEST_AUTH | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20081014 | ||
| 2 | Exporting |
EV_RFC_DEST_EXTR | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20081014 | ||
| 3 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20081009 |
Method GET_RFC_DEST_BY_CONNECTOR on class CL_ESH_FED_METADATA_HELPER has no exception.
Method GET_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_NODE | Call by reference | Type reference (TYPE) | ESH_E_OM_NODE_NAME | Node Name | 20081008 | ||
| 2 | Exporting |
EV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20080812 | ||
| 3 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20080812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_CO_INVALID_PARAMETER |
Invalid Parameter | 20080814 | |
| 2 | CX_ESH_CO_NOT_FOUND |
Requested Data not Found | 20080814 |
Method GET_TEMPLATE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20080812 | ||
| 2 | Returning |
RV_TEMPLATE_TYPE | Value transfer | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20080812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_CO_ENGINE |
Common ESH Engine Exception | 20090112 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 712 |
