SAP ABAP Class CL_ESH_TREX_PROXY (TREX Proxy Superclass)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_TREX (Package) TREX handling for Enterprise Search
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_ESH_TREX_PROXY_ADMIN NWES Proxy for TREX Function Modules 20090828
2 Inheritance (c INHERITING FROM c_ref)  CL_ESH_TREX_PROXY_RUNTIME Runtime Proxy for NW ES - TREX 20090911
Properties
Class CL_ESH_TREX_PROXY  
Short Description TREX Proxy Superclass    
Super Class    
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_TREX   TREX handling for Enterprise Search 
Created 20090805   SAP 
Last change 20141121    
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_PROXY has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_TREX_PROXY_ADMIN 20090828 NWES Proxy for TREX Function Modules
2 CL_ESH_TREX_PROXY_RUNTIME 20090911 Runtime Proxy for NW ES - TREX
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_FOUND Constant Protected Type reference (TYPE) CHAR01 'X' Found 20110720
2 GC_TREX_MIN_REVISION_71 Constant Public Type reference (TYPE) I 41 Minimum TREX Revision for 7.1 20120306
3 GC_TREX_MIN_REVISION_72 Constant Public Type reference (TYPE) I 06 Minimum TREX Revision for 7.2 20120306
4 GC_TREX_VERSION_71 Constant Public Type reference (TYPE) TREXS_TREX_VERSION_INFO2-VERSION '7.1' TREX Version 7.1 20120306
5 GC_TREX_VERSION_72 Constant Public Type reference (TYPE) TREXS_TREX_VERSION_INFO2-VERSION '7.2' TREX Version 7.2 20120306
6 GC_TREX_VERSION_REGEX Constant Private Type reference (TYPE) STRING '^7..{1}' Regex to determine the TREX version 20120306
7 MR_APPLOG Instance attribute Protected Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application log 20090828
8 MS_DCONN Instance attribute Protected Type reference (TYPE) ESH_S_HDB_CONNECTIVITY HDB/TREX Connectivity 20130820
9 MT_TREX_LANDSCAPE_INFO Instance attribute Protected Type reference (TYPE) TREXT_LANDSCAPE_INFO TREX Landscape Info 20130820
10 ST_DCONN Static Attribute Protected Type reference (TYPE) ESH_T_HDB_CONNECTIVITY HDB/TREX Connectivities 20130823
11 SV_SAP_RELEASE Static Attribute Public Type reference (TYPE) SAPRELEASE SAP Release 20120306
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_DESTINATION Instance method Protected Method Check destination 20130820
2 CHECK_READ_ONLY Instance method Protected Method Check destination is read-only 20130820
3 CHECK_TABLE_OWNERSHIP Instance method Protected Method Check table ownership 20121217
4 CLASS_CONSTRUCTOR Static method Public Constructor Class constructor 20100726
5 CLIENT_PLACEHOLDER Instance method Public Method Get Client Placeholder 20131212
6 CONNECTION_GUID Instance method Public Method Get Connection GUID 20130823
7 CONSTRUCTOR Instance method Private Constructor Constructor 20090805
8 DESTINATION Instance method Public Method Get TREX destination or HDB connection 20130823
9 DEST_DBSCHEMA Instance method Public Method Get DB-Schema for Search Entities 20130831
10 DEST_TYPE Instance method Public Method Get destination type (TREX/HANA) 20130823
11 EXTERNAL_SYSTEM_ID Instance method Public Method Get External System ID 20130823
12 EXTERNAL_SYSTEM_TYPE Instance method Public Method Get External System Type 20130823
13 GET_GEN_CONN Instance method Private Method Get Generic Connectivity 20130830
14 GET_HDB_CONN_DBSCHEMA Instance method Protected Method Get HDB Connectivity DB Schema 20130830
15 GET_SAP_RELEASE Static method Private Method Get SAP Release 20120306
16 GET_VERSION_INFO Instance method Public Method Get TREX/HANA version info 20100921
17 INIT_CALL Instance method Protected Method Init routine - to be called before API calls 20110719
18 IS_LOCAL Instance method Public Method Is Local 20130823
19 IS_READ_ONLY Instance method Public Method Is Read-Only 20130823
20 LOGSYS Instance method Public Method Get Logsys 20130823
21 PERFORM_SANITY_CHECK_HANA Instance method Protected Method Perform Sanity Check (HANA) 20120307
22 PERFORM_SANITY_CHECK_TREX Instance method Protected Method Perform Sanity Check (TREX) 20120307
23 PROXY_EXC_APPEND_MESSAGE Instance method Protected Method Append a message to CX_ESH_TREX_PROXY exception object 20130611
24 PROXY_EXC_APPEND_TREX_MESSAGES Instance method Protected Method Append TREX messages to CX_ESH_TREX_PROXY exception object 20110824
25 REREAD_CONNECTIVITIES Instance method Private Method Reread Connectivities 20131015
26 REVISION Instance method Public Method Get revision number of version 20131211
27 VERSION Instance method Public Method Get version 20130823
28 VERSION_HANDLING_HANA Instance method Protected Method Execute Version Handling (HANA) 20120306
29 VERSION_HANDLING_TREX Instance method Protected Method Execute Version Handling (TREX) - including revision det. 20120306
30 VERSION_SHORT Instance method Public Method Get version (short) 20130823
Events
Class CL_ESH_TREX_PROXY has no event.
Types
Class CL_ESH_TREX_PROXY has no local type.
Method Signatures

Method CHECK_DESTINATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTION Call by reference Type reference (TYPE) CHAR01 Action 20130820
2 Importing IV_DESTINATION Call by reference Type reference (TYPE) ESH_E_HDB_DEST HDB/TREX Destination 20130820
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY General ESH TREX Exception 20130820

Method CHECK_READ_ONLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTION Call by reference Type reference (TYPE) CHAR01 Action 20130820
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY General ESH TREX Exception 20130820

Method CHECK_TABLE_OWNERSHIP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTION Call by reference Type reference (TYPE) CHAR01 Action 20121217
2 Importing IV_INDEX_ID Call by reference Type reference (TYPE) TREXD_INDEX_ID Table name 20121217
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY General ESH TREX Exception 20121217

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ESH_TREX_PROXY has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_TREX_PROXY has no exception.

Method CLIENT_PLACEHOLDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CLIENT_PLACEHOLDER Value transfer Type reference (TYPE) CHAR3 Placeholder for $$ESH_CLIENT$$ constraint 20131212

Method CLIENT_PLACEHOLDER on class CL_ESH_TREX_PROXY has no exception.

Method CONNECTION_GUID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CONNECTION_GUID Value transfer Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20130823

Method CONNECTION_GUID on class CL_ESH_TREX_PROXY has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090828
2 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20130823
3 Importing IV_EXT_SYS_ID Call by reference Type reference (TYPE) ESH_E_ADM_EXTERNAL_SYSTEM_ID External System ID 20130823
4 Importing IV_LOCAL Call by reference Type reference (TYPE) CHAR01 Local System 20130823
5 Importing IV_LOGSYS Call by reference Type reference (TYPE) LOGSYS Logical System 20130823
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY 20100803

Method DESTINATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DESTINATION Value transfer Type reference (TYPE) ESH_E_HDB_DEST HDB connection / TREX destination 20130823

Method DESTINATION on class CL_ESH_TREX_PROXY has no exception.

Method DEST_DBSCHEMA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DBSCHEMA_ESHCONN Value transfer Type reference (TYPE) ESH_E_HDB_DBSCHEMA Database Schema 20130831

Method DEST_DBSCHEMA on class CL_ESH_TREX_PROXY has no exception.

Method DEST_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DEST_TYPE Value transfer Type reference (TYPE) ESH_E_ADM_DESTINATION_TYPE Destination type (TREX/HANA) 20130823

Method DEST_TYPE on class CL_ESH_TREX_PROXY has no exception.

Method EXTERNAL_SYSTEM_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_EXT_SYS_ID Value transfer Type reference (TYPE) ESH_E_ADM_EXTERNAL_SYSTEM_ID External System ID 20130823

Method EXTERNAL_SYSTEM_ID on class CL_ESH_TREX_PROXY has no exception.

Method EXTERNAL_SYSTEM_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_EXT_SYS_TYPE Value transfer Type reference (TYPE) ESH_E_HDB_EXTERNAL_SYSTEM_TYPE External System Type 20130823

Method EXTERNAL_SYSTEM_TYPE on class CL_ESH_TREX_PROXY has no exception.

Method GET_GEN_CONN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20130830
2 Importing IV_EXT_SYS_ID Call by reference Type reference (TYPE) ESH_E_ADM_EXTERNAL_SYSTEM_ID External System ID 20130830
3 Importing IV_LOGSYS Call by reference Type reference (TYPE) LOGSYS Logsys (= EXT_SYS_ID in this case) 20130830
4 Returning RS_DCONN Value transfer Type reference (TYPE) ESH_S_HDB_CONNECTIVITY Generic Connectivity 20130830
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY General ESH TREX Exception 20130830

Method GET_HDB_CONN_DBSCHEMA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_UPDATED Call by reference Type reference (TYPE) CHAR01 Entry has been updated 20130830

Method GET_HDB_CONN_DBSCHEMA on class CL_ESH_TREX_PROXY has no exception.

Method GET_SAP_RELEASE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_SAP_RELEASE Call by reference Type reference (TYPE) SAPRELEASE SAP Release (NW Basis Component) 20120306

Method GET_SAP_RELEASE on class CL_ESH_TREX_PROXY has no exception.

Method GET_VERSION_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Return Code 20100921
2 Exporting E_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Return Text 20100921
3 Exporting E_TREX_VERSION_INFO Call by reference Type reference (TYPE) TREXT_TREX_VERSION_INFO2 Version Info 20120306
4 Importing I_LOCATION Call by reference Type reference (TYPE) TREX_RFC-LOCATION2 Location 20100921
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY 20100921

Method INIT_CALL Signature

Method INIT_CALL on class CL_ESH_TREX_PROXY has no parameter.
Method INIT_CALL on class CL_ESH_TREX_PROXY has no exception.

Method IS_LOCAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_IS_LOCAL Value transfer Type reference (TYPE) CHAR01 Is Local 20130823

Method IS_LOCAL on class CL_ESH_TREX_PROXY has no exception.

Method IS_READ_ONLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning IS_READ_ONLY Value transfer Type reference (TYPE) CHAR01 Is Read-Only 20130823

Method IS_READ_ONLY on class CL_ESH_TREX_PROXY has no exception.

Method LOGSYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_LOGSYS Value transfer Type reference (TYPE) LOGSYS Logical System 20130823

Method LOGSYS on class CL_ESH_TREX_PROXY has no exception.

Method PERFORM_SANITY_CHECK_HANA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20120307
2 Importing IR_SANITY_CHECKER Call by reference Object reference (TYPE REF TO) CL_ESH_HANA_SANITY_CHECK Sanity Check (HANA) 20120307
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY General ESH TREX Exception 20120307

Method PERFORM_SANITY_CHECK_TREX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20120307
2 Importing IR_SANITY_CHECKER Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_SANITY_CHECK Sanity Check (TREX) 20120307
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY General ESH TREX Exception 20120307

Method PROXY_EXC_APPEND_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CX_TREX_PROXY Call by reference Object reference (TYPE REF TO) CX_ESH_TREX_PROXY General ESH TREX Exception 20130611
2 Importing IV_MSGID Call by reference Type reference (TYPE) SYMSGID 'ESH_HANA_ADMIN' Message ID 20130611
3 Importing IV_MSGNO Call by reference Type reference (TYPE) SYMSGNO Message Number 20130611
4 Importing IV_MSGV1 Call by reference Type reference (TYPE) CSEQUENCE Message Parameter 1 20130611
5 Importing IV_MSGV2 Call by reference Type reference (TYPE) CSEQUENCE Message Parameter 2 20130611
6 Importing IV_MSGV3 Call by reference Type reference (TYPE) CSEQUENCE Message Parameter 3 20130611
7 Importing IV_MSGV4 Call by reference Type reference (TYPE) CSEQUENCE Message Parameter 4 20130611
8 Importing IV_TYPE Call by reference Type reference (TYPE) SYMSGTY 'E' Type 20130611

Method PROXY_EXC_APPEND_MESSAGE on class CL_ESH_TREX_PROXY has no exception.

Method PROXY_EXC_APPEND_TREX_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CX_TREX_PROXY Call by reference Object reference (TYPE REF TO) CX_ESH_TREX_PROXY General ESH TREX Exception 20110824
2 Importing IV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Return Code 20110824
3 Importing IV_RETURN_STRING Call by reference Type reference (TYPE) STRING Return Text (String) 20130308
4 Importing IV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Return Text 20110824

Method PROXY_EXC_APPEND_TREX_MESSAGES on class CL_ESH_TREX_PROXY has no exception.

Method REREAD_CONNECTIVITIES Signature

Method REREAD_CONNECTIVITIES on class CL_ESH_TREX_PROXY has no parameter.
Method REREAD_CONNECTIVITIES on class CL_ESH_TREX_PROXY has no exception.

Method REVISION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_REVISION Value transfer Type reference (TYPE) ESH_E_HDB_REVISION Revision number of TREX/HANA version 20131211

Method REVISION on class CL_ESH_TREX_PROXY has no exception.

Method VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_VERSION Value transfer Type reference (TYPE) ESH_E_HDB_VERSION HDB/TREX Version 20130823

Method VERSION on class CL_ESH_TREX_PROXY has no exception.

Method VERSION_HANDLING_HANA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_UPDATED Call by reference Type reference (TYPE) CHAR01 Entry has been updated 20130830

Method VERSION_HANDLING_HANA on class CL_ESH_TREX_PROXY has no exception.

Method VERSION_HANDLING_TREX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_UPDATED Call by reference Type reference (TYPE) CHAR01 Entry has been updated 20130830

Method VERSION_HANDLING_TREX on class CL_ESH_TREX_PROXY has no exception.

Method VERSION_SHORT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_VERSION_SHORT Value transfer Type reference (TYPE) ESH_E_HDB_VERSION_SHORT TREX Version (short) 20130823

Method VERSION_SHORT on class CL_ESH_TREX_PROXY has no exception.
History
Last changed by/on SAP  20141121 
SAP Release Created in 730