SAP ABAP Interface IF_ESH_IF_SEARCH_METADATA (Search Execution)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_SEARCH (Package) Search (internal)
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_IF_SEARCH_METADATA | ESH Search Metadata | 20070308 |
Properties
| Interface | IF_ESH_IF_SEARCH_METADATA | |
| Short Description | Search Execution |
General Data
| Package | S_ESH_ENG_SEARCH | Search (internal) |
| Created | 20070308 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | CL_ESH_IF_SEARCH_METADATA | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | IF_ESH_IF_SEARCH_METADATA | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Interface IF_ESH_IF_SEARCH_METADATA has no interface.
Friends
Interface IF_ESH_IF_SEARCH_METADATA has no friend.
Attributes
Interface IF_ESH_IF_SEARCH_METADATA has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Create a search connector | 20070308 | |
| 2 | Static method | Public | Method | Get search connectors | 20070308 | |
| 3 | Static method | Public | Method | Get request types of a search connector | 20070308 | |
| 4 | Static method | Public | Method | Get navigation targets | 20070308 | |
| 5 | Static method | Public | Method | Get related templates | 20070308 | |
| 6 | Static method | Public | Method | Get related templates | 20070308 | |
| 7 | Static method | Public | Method | Get search connector templates | 20070308 | |
| 8 | Static method | Public | Method | Get attributes of a search connector template | 20070308 | |
| 9 | Static method | Public | Method | Get request types of a search connector template | 20070308 |
Events
Interface IF_ESH_IF_SEARCH_METADATA has no event.
Types
Interface IF_ESH_IF_SEARCH_METADATA has no local type.
Method Signatures
Method CREATE_CONNECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 2 | CT_SEARCH_CONNECTORS | Call by reference | Type reference (TYPE) | ESH_T_IF_TEMPLATE_INSTANCES | Template instances / search connectors | 20070308 | |||
| 3 | CT_TEMPLATE_DEPLOYMENTS | Call by reference | Type reference (TYPE) | ESH_T_IF_TEMPLATE_DEPLOYMENTS2 | Template Logsys combinations | 20070612 | |||
| 4 | IR_APPLOG | Value transfer | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20071011 |
Method CREATE_CONNECTOR on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_CONNECTORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 2 | ET_SEARCH_CONNECTORS | Call by reference | Type reference (TYPE) | ESH_T_IF_SEARCH_CONNECTORS | Search Connectors | 20070308 | |||
| 3 | IT_LANGUAGES | Call by reference | Type reference (TYPE) | ESH_T_IF_LANGUAGES | Languages according to ISO 639 | 20070308 | |||
| 4 | IV_LOGSYS | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20070308 | |||
| 5 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 | |||
| 6 | IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20070308 |
Method GET_CONNECTORS on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_CONN_REQUEST_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_REQUEST_TYPES | Call by reference | Type reference (TYPE) | ESH_T_IF_REQUEST_TYPES | Request Types | 20070308 | |||
| 2 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 3 | IV_SEARCH_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20070308 | |||
| 4 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 |
Method GET_CONN_REQUEST_TYPES on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_NAVIGATION_TARGETS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_NAVIGATION_TARGETS | Call by reference | Type reference (TYPE) | ESH_T_IF_NAVIGATION_TARGETS | Targets for object navigation | 20070308 | |||
| 2 | CT_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 3 | IT_LANGUAGES | Call by reference | Type reference (TYPE) | ESH_T_IF_LANGUAGES | Languages according to ISO 639 | 20070328 | |||
| 4 | IV_CONFIGURATION_LEVEL | Call by reference | Type reference (TYPE) | ESH_E_IF_CONFIGURATION_LEVEL | Configuration level | 20070308 | |||
| 5 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 | |||
| 6 | IV_TARGET_UI_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_TARGET_UI_TYPE | Target UI type (SAP GUI, SAP Portal, #) | 20070308 | |||
| 7 | IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20070308 | |||
| 8 | IV_UI_OPERATION | Call by reference | Type reference (TYPE) | ESH_E_IF_UI_OPERATION | Unified name for UI operation | 20070308 |
Method GET_NAVIGATION_TARGETS on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_RELATED_CONNECTORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RELATED_SEARCH_CONNECTORS | Call by reference | Type reference (TYPE) | ESH_T_IF_RELATED_CONNECTORS | Related search connectors | 20070308 | |||
| 2 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 3 | IV_SEARCH_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20070308 | |||
| 4 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 |
Method GET_RELATED_CONNECTORS on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_RELATED_TEMPLATES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RELATED_TEMPLATES | Call by reference | Type reference (TYPE) | ESH_T_IF_RELATED_TEMPLATES | Related search connector templates | 20070308 | |||
| 2 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 3 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 | |||
| 4 | IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20070308 |
Method GET_RELATED_TEMPLATES on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_TEMPLATES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 2 | CT_TEMPLATES | Call by reference | Type reference (TYPE) | ESH_T_IF_TEMPLATES | Search Connector Templates | 20070308 | |||
| 3 | IT_LANGUAGES | Call by reference | Type reference (TYPE) | ESH_T_IF_LANGUAGES | Languages according to ISO 639 | 20070308 | |||
| 4 | IV_CONFIGURATION_LEVEL | Call by reference | Type reference (TYPE) | ESH_E_IF_CONFIGURATION_LEVEL | '20' | Configuration level | 20070308 | ||
| 5 | IV_LOGSYS | Call by reference | Type reference (TYPE) | LOGSYS | Logical system | 20070308 | |||
| 6 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | 'BOS' | Search Connector Type | 20070308 | ||
| 7 | IV_SYSTEM_GROUP | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSTEM_GROUP | System Group | 20070926 | |||
| 8 | IV_SYSTEM_RELEASE | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL | System/Release | 20070926 |
Method GET_TEMPLATES on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_TEMPLATE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ATTRIBUTES | Call by reference | Type reference (TYPE) | ESH_T_IF_TEMPLATES_ATTRIBUTES | Template Attributes | 20070308 | |||
| 2 | ET_DATA_ELEMENTS | Call by reference | Type reference (TYPE) | ESH_T_IF_DATA_ELEMENTS | Data elements | 20070308 | |||
| 3 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 4 | IT_LANGUAGES | Call by reference | Type reference (TYPE) | ESH_T_IF_LANGUAGES | Languages according to ISO 639 | 20070308 | |||
| 5 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 | |||
| 6 | IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20070308 |
Method GET_TEMPLATE_ATTRIBUTES on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
Method GET_TEMPL_REQUEST_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_REQUEST_TYPES | Call by reference | Type reference (TYPE) | ESH_T_IF_REQUEST_TYPES_NAMES | Request Types | 20070308 | |||
| 2 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070308 | |||
| 3 | IT_LANGUAGES | Call by reference | Type reference (TYPE) | ESH_T_IF_LANGUAGES | Languages according to ISO 639 | 20070308 | |||
| 4 | IV_SEARCH_CONNECTOR_TYPE | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | Search Connector Type | 20070308 | |||
| 5 | IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | Search Connector Template ID | 20070308 |
Method GET_TEMPL_REQUEST_TYPES on Interface IF_ESH_IF_SEARCH_METADATA has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 100 |