SAP ABAP Class CL_ESH_ADM_PARAM (Configuration Parameter)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_MONITORING_ADMIN (Package) Monitoring and Admin Component
Properties
Class CL_ESH_ADM_PARAM  
Short Description Configuration Parameter    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_MONITORING_ADMIN   Monitoring and Admin Component 
Created 20071005   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_ADM_PARAM has no interface implemented.
Friends
Class CL_ESH_ADM_PARAM has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_BUILD_CYCLIC_JOIN_INDEX Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'BUILD_CYCLIC_JOIN_IX' Build cyclic join index 20100722
2 GC_DATE_LAST_PROG_INDEX_UPD Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'DATE_LAST_PRGIDX_UPD' 20110721
3 GC_KEEP_TREX_PROGRAM_ID Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'KEEP_TREX_PROGRAM_ID' Keep the program ID in TREX RFC destination 20100928
4 GC_P_CONFLICT_HANDLING Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'CONFLICT_HANDLING' Execute conflict handling 20080530
5 GC_P_COPY_SWC_ALL Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'COPY_SWC_ALL' Copy all software components 20100713
6 GC_P_DELEGATE_SWC Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'DELEGATE_SWC' Delegate software component to ES hub 20080605
7 GC_P_FU_IDLE_TIME Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'FU_IDLE_TIME' Fast update idle time before shutting down 20081212
8 GC_P_FU_SUSPEND Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'FU_SUSPEND' Fast update suspended 20081209
9 GC_P_HBT_RELOC_EXEC_ID Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'HBT_RELOC_EXEC_ID' Execution ID for hub tests: Relocation tests 20100114
10 GC_P_HBT_RELOC_EXEC_MODE Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'HBT_RELOC_EXEC_MODE' Execution mode for hub tests: Relocation tests 20100114
11 GC_P_HUB_DESTINATION Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'HUB_DESTINATION' RFC destination of ES hub 20071005
12 GC_P_HUB_DESTINATION_AUTH Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'HUB_DESTINATION_AUTH' RFC destination of ES hub 20100205
13 GC_P_LOG_RESPONSE_TIME Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'LOG_RESPONSE_TIME' Log response time 20080326
14 GC_P_LOG_SEARCH_REQUESTS Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'LOG_SEARCH_REQUESTS' Log search requests (X: generally, user name: specific user) 20080814
15 GC_P_MODEL_COMPRESSION Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'MODEL_COMPRESSION' Model compression customizing 20081211
16 GC_P_ODP_MODELING Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'ODP_MODELING' ODP modeling switched on/ off 20091020
17 GC_P_OPTIMIZE_COUNTER Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'OPTIMIZE_COUNTER' Number of data packages after which optimize is called 20080423
18 GC_P_PENDING_TEXT_REF Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'PENDING_TEXT_REF' Pending text references 20080214
19 GC_P_REHASH_SWC Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'REHASH_SWC' Recalculate hash code in SWC 20080724
20 GC_P_RELOC_IMPORT_DIR Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'RELOC_IMPORT_DIR' File directory for index content import during relocation 20090326
21 GC_P_REMOTESEARCH_BACKEND Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'REM_SEARCH_BACKEND' System is client for Remote Search 20130819
22 GC_P_REMOTESEARCH_PROXY Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'REM_SEARCH_PROXY' System is client for Remote Search 20130819
23 GC_P_REMOTESEARCH_PROXYDEST Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'REM_SEARCH_PROXYDEST' Remote Search hub destination 20130819
24 GC_P_SET_CONNS_IN_DIALOG Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'SET_CONNS_IN_DIALOG' Set up connectors in dialog process (X: generally, username) 20081209
25 GC_P_SET_INDEXING_IN_DIALOG Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'SET_INDEXING_IN_DIAL' Start indexing in dialog process ('X': generally, username) 20090911
26 GC_P_SNAPSHOT Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'SNAPSHOT' Snapshot 20131121
27 GC_P_STOP_INDEXING Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'STOP_INDEXING' Stop executing program ESH_IX_PROCESS_CHANGE_POINTERS 20080805
28 GC_P_SWC_UPDATE Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'SWC_UPDATE_AVAILABLE' Updates available in back-end system 20081020
29 GC_P_TEST_CONTEXT Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'TEST_CONTEXT' Test context 20080418
30 GC_P_TEST_MODE Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'TEST_MODE' Test mode 20080418
31 GC_P_TST_SCENARIO Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'TST_SCENARIO' Test scenario (for example HUBTEST / NOTEST) 20100114
32 GC_P_USE_NEW_QP Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'USE_NEW_QP' Temporary: use new query parts 20080729
33 GC_TREX_NO_REFACTOR Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'TREX_NO_REFACTOR' Deactivate new TREX interface for connectors 20091008
34 GC_TREX_NO_REFACTOR_IDX Constant Public Type reference (TYPE) ESH_E_ADM_PARAM 'TREX_NO_REFACTOR_IDX' Deactivate new TREX interface for indexing 20091008
35 GS_CACHE Static Attribute Public Type reference (TYPE) ESH_S_ADM_PARAM_CACHE Cached data from ESH_ADM_PARAM methods 20091111
36 GT_PARAM_VALUES Static Attribute Private Type reference (TYPE) ESH_T_ADM_PARAM Configuration parameter 20071005
37 GT_SWCV Static Attribute Private Type reference (TYPE) ESH_T_ADM_SWCV Software component versions 20080131
38 GV_COMPLETE Static Attribute Private Type reference (TYPE) ABAP_BOOL 20071005
Methods
# Method Level Visibility Method type Description Created on
1 CLASS_CONSTRUCTOR Static method Public Constructor Class constructor 20090408
2 GET Static method Public Method Get values for specific parameter 20071005
3 GET_ALL Static method Public Method Get all parameter values 20071005
4 GET_CACHE Static method Public Method Fill local buffer from cache 20091106
5 GET_DESTINATION_FOR_SWC Static method Public Method Get ES destination (local/central) for software component 20080605
6 GET_HUB_DESTINATION Static method Public Method Get RFC destination of ES hub 20071005
7 GET_HUB_DESTINATION_AUTH Static method Public Method Get RFC destination of ES hub 20100205
8 GET_REMOTESEARCH_PROXYDEST Static method Public Method Get proxy destinations in RemoteSearch backend 20130819
9 GET_SP_LEVEL Static method Public Method Get release and SP for SWC 20131015
10 GET_SWCV Static method Public Method Get software component versions with settings 20080131
11 INVALIDATE_CACHE Static method Public Method Invalidate cache 20091106
12 IS_AUTH_CHECK_ACTIVE Static method Public Method Is authorization check active on connectors and categories 20130424
13 IS_CENTRAL Static method Public Method Central deployment 20071005
14 IS_CUSTOMER_SYSTEM Static method Public Method Is system a customer system? 20130213
15 IS_NEWDB Static method Public Method Is system running on HANA/ NewDB? 20111230
16 IS_REMOTESEARCH_BACKEND Static method Public Method Is system backend for Remote Search? 20130819
17 IS_REMOTESEARCH_PROXY Static method Public Method Is system proxy for Remote Search? 20130819
18 IS_SNAPSHOT_ACTIVE Static method Public Method Is snapshot search active 20131121
19 LOAD_CACHE_DATA Static method Public Method Load cache data 20091111
20 REFRESH_BUFFER Static method Public Method Refresh the buffer table 20080805
21 SEARCH_DELEGATION_ACTIVE Static method Public Method Is search delegation active? 20090929
22 SET Static method Public Method Set parameter values 20071005
23 SET_AUTH_CHECK_STATUS Static method Public Method 20130925
24 SET_FOREGROUND_PROCESSING Static method Public Method (De)Activate refactor coding 20100114
25 SET_TREX_INTERFACE Static method Public Method (De)Activate refactor coding 20091008
Events
Class CL_ESH_ADM_PARAM has no event.
Types
Class CL_ESH_ADM_PARAM has no local type.
Method Signatures

Method CLASS_CONSTRUCTOR Signature

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

Method GET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_PARAMETER Call by reference Type reference (TYPE) ESH_E_ADM_PARAM Config Parameter 20071005
2 Returning RT_PARAM_VALUES Value transfer Type reference (TYPE) ESH_T_ADM_PARAM Configuration Parameter 20071005

Method GET on class CL_ESH_ADM_PARAM has no exception.

Method GET_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_PARAM_VALUES Value transfer Type reference (TYPE) ESH_T_ADM_PARAM Configuration Parameter 20071005

Method GET_ALL on class CL_ESH_ADM_PARAM has no exception.

Method GET_CACHE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ERROR Value transfer Type reference (TYPE) ABAP_BOOL 20091106

Method GET_CACHE on class CL_ESH_ADM_PARAM has no exception.

Method GET_DESTINATION_FOR_SWC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SWC Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component 20080605
2 Returning RV_RFC_DESTINATION Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20080605

Method GET_DESTINATION_FOR_SWC on class CL_ESH_ADM_PARAM has no exception.

Method GET_HUB_DESTINATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20091106
2 Returning RV_RFC_DESTINATION Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20071005

Method GET_HUB_DESTINATION on class CL_ESH_ADM_PARAM has no exception.

Method GET_HUB_DESTINATION_AUTH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20100205
2 Returning RV_RFC_DESTINATION Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20100205

Method GET_HUB_DESTINATION_AUTH on class CL_ESH_ADM_PARAM has no exception.

Method GET_REMOTESEARCH_PROXYDEST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_DESTINATIONS Value transfer Type reference (TYPE) ESH_T_INT_RFCDEST RFC destinations 20130819

Method GET_REMOTESEARCH_PROXYDEST on class CL_ESH_ADM_PARAM has no exception.

Method GET_SP_LEVEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RELEASE Call by reference Type reference (TYPE) SAPRELEASE SAP Release 20131017
2 Exporting EV_SP_LEVEL Call by reference Type reference (TYPE) SAPPATCHLV Support Package Level of a Software Component 20131017
3 Importing IV_SW_COMP Call by reference Type reference (TYPE) DLVUNIT Software Component 20131015

Method GET_SP_LEVEL on class CL_ESH_ADM_PARAM has no exception.

Method GET_SWCV Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_SWCV Value transfer Type reference (TYPE) ESH_T_ADM_SWCV Software component versions 20080131

Method GET_SWCV on class CL_ESH_ADM_PARAM has no exception.

Method INVALIDATE_CACHE Signature

Method INVALIDATE_CACHE on class CL_ESH_ADM_PARAM has no parameter.
Method INVALIDATE_CACHE on class CL_ESH_ADM_PARAM has no exception.

Method IS_AUTH_CHECK_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130424
2 Returning RV_AUTH_CHECK_ACTIVE Value transfer Type reference (TYPE) ABAP_BOOL 20130424

Method IS_AUTH_CHECK_ACTIVE on class CL_ESH_ADM_PARAM has no exception.

Method IS_CENTRAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20091106
2 Returning RV_CENTRAL Value transfer Type reference (TYPE) ABAP_BOOL 20071005

Method IS_CENTRAL on class CL_ESH_ADM_PARAM has no exception.

Method IS_CUSTOMER_SYSTEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130213
2 Returning RV_CUSTOMER_SYSTEM Value transfer Type reference (TYPE) ABAP_BOOL 20130213

Method IS_CUSTOMER_SYSTEM on class CL_ESH_ADM_PARAM has no exception.

Method IS_NEWDB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_NEWDB Value transfer Type reference (TYPE) ABAP_BOOL 20111230

Method IS_NEWDB on class CL_ESH_ADM_PARAM has no exception.

Method IS_REMOTESEARCH_BACKEND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130827
2 Returning RV_REMOTESEARCH_BACKEND Value transfer Type reference (TYPE) ABAP_BOOL 20130819

Method IS_REMOTESEARCH_BACKEND on class CL_ESH_ADM_PARAM has no exception.

Method IS_REMOTESEARCH_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130827
2 Returning RV_REMOTESEARCH_PROXY Value transfer Type reference (TYPE) ABAP_BOOL 20130819

Method IS_REMOTESEARCH_PROXY on class CL_ESH_ADM_PARAM has no exception.

Method IS_SNAPSHOT_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20131121
2 Returning RV_SNAPSHOT Value transfer Type reference (TYPE) ABAP_BOOL 20131121

Method IS_SNAPSHOT_ACTIVE on class CL_ESH_ADM_PARAM has no exception.

Method LOAD_CACHE_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_CACHE_DATA Call by reference Type reference (TYPE) ESH_S_ADM_PARAM_CACHE Cached data from ESH_ADM_PARAM methods 20091111

Method LOAD_CACHE_DATA on class CL_ESH_ADM_PARAM has no exception.

Method REFRESH_BUFFER Signature

Method REFRESH_BUFFER on class CL_ESH_ADM_PARAM has no parameter.
Method REFRESH_BUFFER on class CL_ESH_ADM_PARAM has no exception.

Method SEARCH_DELEGATION_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BYPASS_CACHE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20091106
2 Returning RV_DELEGATE_SEARCH Value transfer Type reference (TYPE) ABAP_BOOL 20090929

Method SEARCH_DELEGATION_ACTIVE on class CL_ESH_ADM_PARAM has no exception.

Method SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_PARAM_VALUES Value transfer Type reference (TYPE) ESH_T_ADM_PARAM Configuration Parameter 20071005
2 Importing IV_COMPLETE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE All values of parameter 20071005
3 Importing IV_PARAMETER Call by reference Type reference (TYPE) ESH_E_ADM_PARAM Config Parameter 20071005
4 Importing IV_SYNCHRONOUS_UPDATE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Update synchronously 20080912

Method SET on class CL_ESH_ADM_PARAM has no exception.

Method SET_AUTH_CHECK_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_AUTH_CHECK_ACTIVE Call by reference Type reference (TYPE) ABAP_BOOL 20130925

Method SET_AUTH_CHECK_STATUS on class CL_ESH_ADM_PARAM has no exception.

Method SET_FOREGROUND_PROCESSING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DELETE_OLD_ENTRIES Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20100114
2 Importing IV_DISABLE_FOR_USER Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20100301
3 Importing IV_FOR_ALL_USERS Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20100114
4 Importing IV_USERNAME Call by reference Type reference (TYPE) SYUNAME 20100114

Method SET_FOREGROUND_PROCESSING on class CL_ESH_ADM_PARAM has no exception.

Method SET_TREX_INTERFACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FOR_ALL_USERS Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20091008
2 Importing IV_OLD_CONNECTOR_HANDLING Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20091008
3 Importing IV_OLD_INDEXING Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Boolean Variable (X=True, -=False, Space=Unknown) 20091008

Method SET_TREX_INTERFACE on class CL_ESH_ADM_PARAM has no exception.
History
Last changed by/on SAP  20141121 
SAP Release Created in 700