SAP ABAP Class CL_WSD_ESH_SEARCH (Enterprise search class for material)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
SD-MD-MM-CS (Application Component) Additional Material Functions
⤷
WSD_CS_FU (Package) Functionality Enhanced Material Search
SAP_APPL (Software Component) Logistics and Accounting⤷
SD-MD-MM-CS (Application Component) Additional Material Functions⤷
WSD_CS_FU (Package) Functionality Enhanced Material SearchProperties
| Class | CL_WSD_ESH_SEARCH | |
| Short Description | Enterprise search class for material | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | WSD_CS_FU | Functionality Enhanced Material Search |
| Created | 20090123 | SAP |
| Last change | 20110908 | 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_WSD_ESH_SEARCH has no interface implemented.
Friends
Class CL_WSD_ESH_SEARCH has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MR_ESH_REQ |
Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_SE_SEARCH_REQUEST | Search Request | 20090123 | ||
| 2 | MR_ESH_RES |
Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20090123 | ||
| 3 | MR_ESH_RESP_CONNECT |
Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESP_CONNECT | Search Response of Connector | 20090123 | ||
| 4 | MR_ESH_SEARCH_CONNECTOR |
Static Attribute | Private | Object reference (TYPE REF TO) | BADI_WSD_ESH_CONNECTOR | 20090917 | |||
| 5 | MR_MAP_BADI |
Static Attribute | Private | Object reference (TYPE REF TO) | BADI_WSD_MATERIAL_SEARCH | 20090123 | |||
| 6 | MT_CONNECTORS |
Instance attribute | Private | Type reference (TYPE) | ESH_T_IF_MDATA_CONNECTORS | Search Connectors | 20090123 | ||
| 7 | MT_REQ_ATTRS |
Instance attribute | Public | Type reference (TYPE) | WSD_ATTRIBUTE_TTY | Attributes list table type | 20090209 | ||
| 8 | MV_FREE_TEXT |
Instance attribute | Public | Type reference (TYPE) | STRING | Free Text | 20090211 | ||
| 9 | MV_FUZZY_MODE |
Instance attribute | Public | Type reference (TYPE) | TREXD_TERM_ACTION | Fuzzy Mode | 20090211 | ||
| 10 | MV_RESULT_FROM |
Instance attribute | Public | Type reference (TYPE) | I | 1 | Result from | 20090211 | |
| 11 | MV_RESULT_TO |
Instance attribute | Public | Type reference (TYPE) | I | Result to - Max number of records to be extracted | 20090211 | ||
| 12 | MV_TEMPL_ID_MAT |
Static Attribute | Private | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 'SAP_APPL~STANDARD~MATERIAL~' | Search Connector Template ID | 20090310 | |
| 13 | MV_TEMPL_ID_MAT_PLANT |
Static Attribute | Private | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 'SAP_APPL~STANDARD~MATERIAL~MATERIAL_PLANT' | Search Connector Template ID | 20090310 | |
| 14 | MV_TEMPL_ID_MAT_SALES |
Static Attribute | Private | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 'SAP_APPL~STANDARD~MATERIAL~MATERIAL_SALES' | Search Connector Template ID | 20090310 | |
| 15 | MV_TEMPL_ID_PIR |
Static Attribute | Private | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 'SAP_APPL~STANDARD~PURCHASE_INFO_REC~' | Search Connector Template ID | 20090310 | |
| 16 | MV_TEMPL_ID_PIR_EINE |
Static Attribute | Private | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 'SAP_APPL~STANDARD~PURCHASE_INFO_REC~EINE' | Search Connector Template ID | 20090310 | |
| 17 | MV_TEMPL_ID_WSD_CAT |
Static Attribute | Private | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 'SAP_APPL~STANDARD~WSD_CAT~' | Search Connector Template ID | 20090310 | |
| 18 | M_ES_OBJECT_TYPE |
Instance attribute | Public | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090123 | ||
| 19 | M_REQTID |
Instance attribute | Private | Type reference (TYPE) | ESH_E_IF_REQUEST_TYPE_ID | 'DEFAULT' | Request Type ID | 20090123 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BADI_MAP_SEARCH_RESULTS |
Instance method | Private | Method | BAdI call to Enhance / Map Search Results | 20090605 |
| 2 | BADI_MAP_SEARCH_RESULTS_ESH |
Instance method | Public | Method | BAdI call to Enhance / Map Material Search Results using ES | 20090616 |
| 3 | BADI_MODIFY_CONNECTOR_ID |
Instance method | Private | Method | Call BAdI to modify connector for catalog search | 20090604 |
| 4 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20090123 |
| 5 | CONVERT_CATALOG_RESULT |
Instance method | Public | Method | Format result data for catalog search | 20090123 |
| 6 | CONVERT_QUERY |
Instance method | Private | Method | 20090129 | |
| 7 | DO_SEARCH |
Instance method | Public | Method | Search data from ERP or catalog | 20090123 |
| 8 | GET_ATTRIBUTES_LIST |
Instance method | Private | Method | To fetch all attributes list of the BO template. | 20090123 |
| 9 | GET_ATTRIBUTE_NAME |
Instance method | Public | Method | Get attribute name from data element | 20090127 |
| 10 | GET_QUERY_PIR |
Instance method | Public | Method | Get Query for Purchase Info Record | 20090209 |
| 11 | GET_QUERY_PIR_EINE |
Instance method | Public | Method | Get Query for Purchase Info Record with Info record number | 20090622 |
| 12 | IS_SUPPORTED_ATTR |
Instance method | Public | Method | Check supported request attributes for Material search | 20090209 |
| 13 | SET_CONNECTORS |
Instance method | Private | Method | Sets connector id as an input to Enterprise search | 20090123 |
| 14 | SET_QUERY |
Instance method | Public | Method | Prepare search query | 20090123 |
| 15 | SET_RESULT_FROM_TO |
Instance method | Public | Method | Set result From and To (to limit number of results returned) | 20090123 |
| 16 | SET_SEARCH_MODE |
Instance method | Public | Method | Set search mode to Fuzzy #F# or Exact #E#. | 20090123 |
| 17 | SET_SEARCH_TEXT |
Instance method | Public | Method | Set search text | 20090127 |
Events
Class CL_WSD_ESH_SEARCH has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTY_QUERY_ESH | Public | See coding | 20090127 | BEGIN OF gty_query_esh,
name TYPE string,
values TYPE RANGE OF char255,
END OF gty_query_esh
|
||
| 2 | GTY_QUERY_ESH_TTY | Public | See coding | 20090127 | gty_query_esh_tty TYPE STANDARD TABLE OF gty_query_esh
|
||
| 3 | GTY_RESULTS_ESH | Public | See coding | 20090128 | BEGIN OF gty_results_esh,
displayed(1),
connector_id TYPE esh_e_if_search_connector_id,
request_type_id TYPE esh_e_if_request_type_id,
data TYPE REF TO data,
hits TYPE i,
all_hits TYPE i,
time TYPE i,
error TYPE string,
END OF gty_results_esh
|
||
| 4 | GTY_RESULTS_ESH_TTY | Public | See coding | 20090128 | gty_results_esh_tty TYPE STANDARD TABLE OF gty_results_esh
|
Method Signatures
Method BADI_MAP_SEARCH_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CS_RESULT | Call by reference | Type reference (TYPE) | WSD_MS_RESULT_STY | Material search result structure | 20090605 | ||
| 2 |  Importing |
IV_ATTR_NAME | Call by reference | Type reference (TYPE) | CHAR32 | Attribute Name | 20090605 | ||
| 3 | Importing |
IV_VALUE | Call by reference | Type reference (TYPE) | STRING | Attribute Value | 20090605 |
Method BADI_MAP_SEARCH_RESULTS on class CL_WSD_ESH_SEARCH has no exception.
Method BADI_MAP_SEARCH_RESULTS_ESH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CS_RESULT | Call by reference | Type reference (TYPE) | WSD_MS_RESULT_STY | Material search result structure | 20090616 |
Method BADI_MAP_SEARCH_RESULTS_ESH on class CL_WSD_ESH_SEARCH has no exception.
Method BADI_MODIFY_CONNECTOR_ID Signature
Method BADI_MODIFY_CONNECTOR_ID on class CL_WSD_ESH_SEARCH has no parameter.
Method BADI_MODIFY_CONNECTOR_ID on class CL_WSD_ESH_SEARCH has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_OBJTYP | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090123 | ||
| 2 | Importing |
IV_RESULT_FROM | Call by reference | Type reference (TYPE) | I | Result from | 20090209 | ||
| 3 | Importing |
IV_RESULT_TO | Call by reference | Type reference (TYPE) | I | Result to | 20090209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method CONVERT_CATALOG_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_RESULT | Call by reference | Type reference (TYPE) | WSD_MS_RESULT_TTY | Material search result table type | 20090123 | ||
| 2 | Importing |
IT_DATA | Call by reference | Type reference (TYPE) | GTY_RESULTS_ESH_TTY | Result table from Enterprise search | 20090129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method CONVERT_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_QUERY_ESH | Call by reference | Type reference (TYPE) | GTY_QUERY_ESH_TTY | Enterprise search query table type | 20090129 | ||
| 2 | Importing |
IT_QUERY | Call by reference | Type reference (TYPE) | WSD_MS_QUERY_TTY | Material search query table type | 20090129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method DO_SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_RESULT | Call by reference | Type reference (TYPE) | GTY_RESULTS_ESH_TTY | Material search result table type | 20090123 | ||
| 2 | Importing |
IV_EINE_ONLY | Call by reference | Type reference (TYPE) | BOOLE_D | EINE data only | 20090622 | ||
| 3 | Importing |
IV_INITIAL_MAT_SEARCH | Call by reference | Type reference (TYPE) | BOOLE_D | First Search for MATERIAL | 20090216 | ||
| 4 | Importing |
IV_INITIAL_PIR_SEARCH | Call by reference | Type reference (TYPE) | BOOLE_D | First Search for PIR | 20090622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090123 |
Method GET_ATTRIBUTES_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RT_ATTRIBUTES | Value transfer | Type reference (TYPE) | WSD_ATTRIBUTE_TTY | Attributes list table type | 20090123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method GET_ATTRIBUTE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DATA_ELEMENT | Call by reference | Type reference (TYPE) | WSD_DATA_ELEMENT | Data element | 20090127 | ||
| 2 | Returning |
RV_ATTR_NAME | Value transfer | Type reference (TYPE) | STRING | 20090127 |
Method GET_ATTRIBUTE_NAME on class CL_WSD_ESH_SEARCH has no exception.
Method GET_QUERY_PIR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_QUERY | Call by reference | Type reference (TYPE) | WSD_MS_QUERY_TTY | Search query | 20090209 | ||
| 2 | Importing |
IT_QUERY_MAT | Call by reference | Type reference (TYPE) | WSD_MS_QUERY_TTY | List of Materials to be searched | 20090420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method GET_QUERY_PIR_EINE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_QUERY | Call by reference | Type reference (TYPE) | WSD_MS_QUERY_TTY | Search query | 20090622 | ||
| 2 | Importing |
IT_QUERY_PIR | Call by reference | Type reference (TYPE) | WSD_MS_QUERY_TTY | List of Materials to be searched | 20090622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090622 |
Method IS_SUPPORTED_ATTR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_ATTR_NAME | Call by reference | Type reference (TYPE) | WSD_DATA_ELEMENT | Exporting Data element | 20090209 | ||
| 2 | Exporting |
EV_RESULT | Value transfer | Type reference (TYPE) | BOOLE_D | X = Success | 20090209 | ||
| 3 | Importing |
IV_ATTR_NAME | Call by reference | Type reference (TYPE) | WSD_DATA_ELEMENT | Importing Data element | 20090209 |
Method IS_SUPPORTED_ATTR on class CL_WSD_ESH_SEARCH has no exception.
Method SET_CONNECTORS Signature
Method SET_CONNECTORS on class CL_WSD_ESH_SEARCH has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method SET_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_QUERY | Call by reference | Type reference (TYPE) | WSD_MS_QUERY_TTY | Search query | 20090123 | ||
| 2 | Importing |
IT_QUERY_MAT | Call by reference | Type reference (TYPE) | GTY_QUERY_ESH_TTY | Range Object - Material | 20090210 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WSD_MATERIAL_SEARCH |
Material search exception class for WSD project | 20090213 |
Method SET_RESULT_FROM_TO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_RESULT_FROM | Call by reference | Type reference (TYPE) | I | Result From | 20090123 | ||
| 2 | Importing |
IV_RESULT_TO | Call by reference | Type reference (TYPE) | I | Result to | 20090123 |
Method SET_RESULT_FROM_TO on class CL_WSD_ESH_SEARCH has no exception.
Method SET_SEARCH_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SEARCH_MODE | Call by reference | Type reference (TYPE) | WSD_MS_FUZZY_MODE | Material search fuzzy mode flag | 20090123 |
Method SET_SEARCH_MODE on class CL_WSD_ESH_SEARCH has no exception.
Method SET_SEARCH_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SEARCH_TEXT | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_SEARCH_TERM_F4 | Text search string | 20090127 |
Method SET_SEARCH_TEXT on class CL_WSD_ESH_SEARCH has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 605 |
