SAP ABAP Class CL_ESH_TREX_UTIL (APIs for TREX)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_TOOLS (Package) Tools for BOS
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_TOOLS (Package) Tools for BOSProperties
| Class | CL_ESH_TREX_UTIL | |
| Short Description | APIs for TREX | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_TOOLS | Tools for BOS |
| Created | 20060914 | 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_ESH_TREX_UTIL has no interface implemented.
Friends
Class CL_ESH_TREX_UTIL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_MESSAGE_ID_ENGINE |
Constant | Private | Type reference (TYPE) | SYMSGID | 'ESH_IX_ENGINE' | Message class | 20061030 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_TREX_UI_MESSAGE |
Static method | Public | Method | 20091013 | |
| 2 | CREATE_DATA_TYPE |
Static method | Private | Method | Create a dynamic data type | 20060915 |
| 3 | CREATE_INDEX |
Static method | Public | Method | Create index | 20060915 |
| 4 | CREATE_INDEX_FROM_DB_TABLE |
Static method | Public | Method | Create index from DB table | 20060915 |
| 5 | CREATE_TABLE_FROM_ATTRIBUTES |
Static method | Public | Method | Create table from attributes | 20060914 |
| 6 | CREATE_TABLE_FROM_INDEX |
Static method | Public | Method | Create table object for a certain index | 20060914 |
| 7 | CREATE_TABLE_FROM_VIEW |
Static method | Public | Method | Create table from view attributes | 20060914 |
| 8 | GET_BEST_STRING_ALIGNMENT |
Static method | Public | Method | Get the best alignment of two strings | 20100802 |
| 9 | STRING_TO_SYSTEM_MESSAGE |
Static method | Public | Method | 20091013 |
Events
Class CL_ESH_TREX_UTIL has no event.
Types
Class CL_ESH_TREX_UTIL has no local type.
Method Signatures
Method ADD_TREX_UI_MESSAGE Signature
Method ADD_TREX_UI_MESSAGE on class CL_ESH_TREX_UTIL has no parameter.
Method ADD_TREX_UI_MESSAGE on class CL_ESH_TREX_UTIL has no exception.
Method CREATE_DATA_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_FIELDS | Call by reference | Type reference (TYPE) | DDFIELDS | DD: Field List | 20060915 | ||
| 2 |  Returning |
RR_STRUCT_TYPE | Value transfer | Object reference (TYPE REF TO) | CL_ABAP_STRUCTDESCR | Runtime Type Services | 20060915 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SY_STRUCT_CREATION |
Ausnahme beim Erzeugen eines Strukturtyps | 20060915 |
Method CREATE_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_CODE | Return Code | 20060915 | ||
| 2 | Exporting |
EV_RETURN_TEXT | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_TEXT | Return Text | 20060915 | ||
| 3 | Importing |
IT_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DEF | Attribute definitions | 20060915 | ||
| 4 | Importing |
IT_KEY_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Attributes | 20060915 | ||
| 5 | Importing |
IV_INDEX_ID | Call by reference | Type reference (TYPE) | TREX_RFC-INDEX_ID | Index Id | 20060915 | ||
| 6 | Importing |
IV_RFCDEST | Call by reference | Type reference (TYPE) | TREX_RFC-RFC_DESTINATION | RFC destination to TREX | 20060915 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Internal error | 20060915 |
Method CREATE_INDEX_FROM_DB_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_CODE | Return Code | 20060915 | ||
| 2 | Exporting |
EV_RETURN_TEXT | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_TEXT | Return Text | 20060915 | ||
| 3 | Importing |
IV_DB_RFC_DEST | Call by reference | Type reference (TYPE) | RFCDEST | RFC destination to source system | 20060915 | ||
| 4 | Importing |
IV_FILL_INDEX | Call by reference | Type reference (TYPE) | FLAG | Fill the index? | 20060915 | ||
| 5 | Importing |
IV_INDEX_ID | Call by reference | Type reference (TYPE) | TREXD_INDEX_ID | Index Id | 20060915 | ||
| 6 | Importing |
IV_TABNAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20060915 | ||
| 7 | Importing |
IV_TREX_RFC_DEST | Call by reference | Type reference (TYPE) | TREX_RFC-RFC_DESTINATION | RFC destination to TREX | 20060915 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Internal error | 20060915 |
Method CREATE_TABLE_FROM_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ER_STRUC | Value transfer | Object reference (TYPE REF TO) | DATA | Structure type | 20060917 | ||
| 2 | Exporting |
ER_TAB | Value transfer | Object reference (TYPE REF TO) | DATA | Table type | 20060917 | ||
| 3 | Importing |
IT_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DEF | Attribute definitions | 20060914 |
Method CREATE_TABLE_FROM_ATTRIBUTES on class CL_ESH_TREX_UTIL has no exception.
Method CREATE_TABLE_FROM_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ER_STRUC_TYPE | Call by reference | Object reference (TYPE REF TO) | DATA | Structure type | 20060917 | ||
| 2 | Exporting |
ER_TAB_TYPE | Value transfer | Object reference (TYPE REF TO) | DATA | Table type | 20060914 | ||
| 3 | Importing |
IV_INDEX_ID | Call by reference | Type reference (TYPE) | TREXD_INDEX_ID | Index Id | 20060914 | ||
| 4 | Importing |
IV_RFCDEST | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20060914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TREX_REMOTE_COMMUNICATION |
Remote Communication Exception | 20070516 | |
| 2 | CX_TREX_SERVER |
Error returned from Server | 20070516 |
Method CREATE_TABLE_FROM_VIEW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ER_STRUC | Value transfer | Object reference (TYPE REF TO) | DATA | Structure type | 20060918 | ||
| 2 | Exporting |
ER_TAB | Value transfer | Object reference (TYPE REF TO) | DATA | Table type | 20060918 | ||
| 3 | Importing |
IT_VIEW_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_VIEW_ATTRIBUTES | View attributes | 20060918 | ||
| 4 | Importing |
IV_RFCDEST | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20060918 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TREX_REMOTE_COMMUNICATION |
Remote Communication Exception | 20070516 | |
| 2 | CX_TREX_SERVER |
Error returned from Server | 20070516 |
Method GET_BEST_STRING_ALIGNMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_MATCH_LENGTH | Call by reference | Type reference (TYPE) | INT4 | Match length | 20100802 | ||
| 2 | Exporting |
EV_MATCH_OFFSET | Call by reference | Type reference (TYPE) | INT4 | Match offset | 20100802 | ||
| 3 | Importing |
IV_SEARCH_STRING | Call by reference | Type reference (TYPE) | ESH_E_SEARCH_TERM | Search string | 20100802 | ||
| 4 | Importing |
IV_SOURCE_STRING | Call by reference | Type reference (TYPE) | ESH_E_SEARCH_TERM | Text string | 20100802 |
Method GET_BEST_STRING_ALIGNMENT on class CL_ESH_TREX_UTIL has no exception.
Method STRING_TO_SYSTEM_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TEXT | Call by reference | Type reference (TYPE) | STRING | 20091013 |
Method STRING_TO_SYSTEM_MESSAGE on class CL_ESH_TREX_UTIL has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
