SAP ABAP Interface IF_ESH_SCT_CONTROLLER (Search connector type controller)
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
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_ESH_ADM_ABSTRACT_SCT_CTRL Abstract Base Class for SCT Controllers 20070306
Properties
Interface IF_ESH_SCT_CONTROLLER  
Short Description Search connector type controller    
General Data
Package S_ESH_ENG_MONITORING_ADMIN   Monitoring and Admin Component 
Created 20070306   SAP 
Last changed 20141121    
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)
2 CL_ESH_EX_FU_ADMIN Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 CL_ESH_OM_CONSTANTS Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Interface IF_ESH_SCT_CONTROLLER has no interface.
Friends
Interface IF_ESH_SCT_CONTROLLER has no friend.
Attributes
Interface IF_ESH_SCT_CONTROLLER has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 DELETE_INDEXING_SCHEDULE Instance method Public Method Delete the indexing schedule(s) 20080318
2 DELETE_SEARCH_CONNECTOR Instance method Public Method Delete the specified Search Object Connector 20071109
3 GET_DEPENDENT_SCS Instance method Public Method Get the list of dependent Search Object Connectors 20080401
4 GET_JOBLOG_MESSAGES Instance method Public Method Get the joblog messages for the specified object type(s) 20080229
5 GET_PROCESS_INFO Instance method Public Method Get information about the realtime indexing process 20090123
6 GET_PROCESS_JOBLOG_MESSAGES Instance method Public Method Get the joblog messages of the realtime indexing process 20090224
7 GET_SCHEDULE_DATA Instance method Public Method Get schedule data for the specified Search Object Connector 20080211
8 GET_SCT_CONTROLLER_NAME Instance method Public Method Get the name of the Search Object Connector controller 20070306
9 GET_SCT_CONTROLLER_TYPE Instance method Public Method Get the type of the Search Object Connector controller 20070313
10 GET_SCT_DESCR Instance method Public Method Get the description of the Search Object Connector type 20070306
11 GET_SEARCH_CONNECTOR_INFO Instance method Public Method Get (structured) information about Object Connectors 20070316
12 INDEX_AUTHORIZATION_DATA Instance method Public Method Index authorization data 20120629
13 PREPARE_SEARCH_CONNECTORS Instance method Public Method Prepare the specified Search Object Connectors 20071116
14 RESET_SEARCH_CONNECTOR Instance method Public Method Reset the specified Search Object Connector 20070515
15 SCHEDULE_INDEXING Instance method Public Method Schedule initial and delta indexing for Object Connectors 20070309
16 SET_PROCESS_PARAMETERS Instance method Public Method Set process parameters for realtime indexing 20090128
17 START_PROCESS Instance method Public Method Start the realtime indexing process for a destination 20090120
18 STOP_PROCESS Instance method Public Method Stop the realtime indexing process for a destination 20090120
19 UPDATE_SEARCH_CONNECTOR_STATUS Instance method Public Method Update the status of the Search Object Connector 20090331
Events
Interface IF_ESH_SCT_CONTROLLER has no event.
Types
Interface IF_ESH_SCT_CONTROLLER has no local type.
Method Signatures

Method DELETE_INDEXING_SCHEDULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20080318
2 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search Connector 20080318
3 Importing IT_CRAWLS Call by reference Type reference (TYPE) ESH_T_CRAWL_SCHEDULE Crawl IDs and indexing action 20090514
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20080318

Method DELETE_SEARCH_CONNECTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20071109
2 Importing IR_MODEL_METADATA_A Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_MODEL_METADATA Model references (active model) 20091210
3 Importing IR_MODEL_METADATA_I Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_MODEL_METADATA Model references (inactive model) 20091210
4 Importing IR_SCENARIO_ANALYZER Call by reference Object reference (TYPE REF TO) CL_ESH_HANA_SCENARIO_ANALYZER ESH-on-HANA Scenario Analyzer 20120524
5 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search Connector 20071109
6 Importing IT_AUTH_OBJECTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_AUTHONW List of authorization objects 20080325
7 Importing IT_SC_NODES Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_NODES List of nodes 20071128
8 Importing IT_SC_OBJECTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_OBJECTS List of objects 20111018
9 Importing IT_SC_ODPS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_ODPS List of ODPs 20111018
10 Importing IT_SC_REQUESTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_REQUESTS List of requests 20071128
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20071109

Method GET_DEPENDENT_SCS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20080401
2 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search Connector 20080401
3 Returning RT_SEARCH_CONNECTORS Value transfer Type reference (TYPE) ESH_T_ADM_SEARCH_CONNECTOR List of dependent Search Connectors 20080401
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20080401

Method GET_JOBLOG_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_JOBLOG_MESSAGES Call by reference Type reference (TYPE) ESH_T_ADM_MESSAGES List of joblog messages 20080305
2 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20080229
3 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search Connector 20080229
4 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20080229
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20080229

Method GET_PROCESS_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_FU_PROCESS_INFO Call by reference Type reference (TYPE) ESH_S_ADM_FU_PROCESS_INFO Information about fast update process 20090123
2 Exporting ET_FU_SC_INFO Call by reference Type reference (TYPE) ESH_T_ADM_FU_SC_INFO Information about fast update indexing Search Connectors 20090123
3 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090123
4 Importing IV_RFCDEST Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090123
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20090123

Method GET_PROCESS_JOBLOG_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_JOBLOG_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Joblog Messages 20090224
2 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090224
3 Importing IV_RFCDEST Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090224
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20090224

Method GET_SCHEDULE_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SCHEDULE_DATA Call by reference Type reference (TYPE) ESH_T_ADM_SCHEDULE_DATA Schedule data 20080221
2 Exporting EV_NO_REALTIME_INDEXING Call by reference Type reference (TYPE) ABAP_BOOL Flag: Realtime indexing is not available 20090225
3 Exporting EV_SCHEDULE_EXISTS Call by reference Type reference (TYPE) ABAP_BOOL Flag: Schedule exists in DB 20080221
4 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20080211
5 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search Connector 20080211
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20080211

Method GET_SCT_CONTROLLER_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CONTROLLER_NAME Value transfer Type reference (TYPE) ESH_E_ADM_SCT_CTRL_NAME Name of a search connector controller 20070306

Method GET_SCT_CONTROLLER_NAME on Interface IF_ESH_SCT_CONTROLLER has no exception.

Method GET_SCT_CONTROLLER_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CONTROLLER_TYPE Value transfer Type reference (TYPE) ESH_E_IF_SEARCH_CONNECTOR_TYPE Search Connector Type 20070313

Method GET_SCT_CONTROLLER_TYPE on Interface IF_ESH_SCT_CONTROLLER has no exception.

Method GET_SCT_DESCR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_SCT_DESCR Value transfer Type reference (TYPE) ESH_S_ADM_SCT_DESCR Description of Search Connector Type 20070306

Method GET_SCT_DESCR on Interface IF_ESH_SCT_CONTROLLER has no exception.

Method GET_SEARCH_CONNECTOR_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_LOG_MESSAGES Call by reference Type reference (TYPE) ESH_T_ADM_BAL_S_MSG Messages for application log 20070316
2 Exporting ET_SEARCH_CONNECTOR_INFO Call by reference Type reference (TYPE) ESH_T_ADM_SC_INFO Hirarchical info about Search Connectors 20070316
3 Exporting EV_ERROR Call by reference Type reference (TYPE) ABAP_BOOL Flag: Error occured 20070316
4 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20071127
5 Importing IT_SEARCH_CONNECTORS Call by reference Type reference (TYPE) ESH_T_ADM_SEARCH_CONNECTOR List of Search Connectors 20070316
6 Importing IV_AREA Call by reference Type reference (TYPE) ESH_E_OM_AREA CL_ESH_OM_CONSTANTS=>GC_AREA_ACTIVE Area 20080131

Method GET_SEARCH_CONNECTOR_INFO on Interface IF_ESH_SCT_CONTROLLER has no exception.

Method INDEX_AUTHORIZATION_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20120629
2 Importing IR_SCENARIO_ANALYZER Call by reference Object reference (TYPE REF TO) CL_ESH_HANA_SCENARIO_ANALYZER ESH-on-HANA Scenario Analyzer 20120629
3 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20120629
4 Importing IV_TEMPLATE_TYPE Call by reference Type reference (TYPE) ESH_E_OM_TEMPLATE_TYPE Template Type 20120629

Method INDEX_AUTHORIZATION_DATA on Interface IF_ESH_SCT_CONTROLLER has no exception.

Method PREPARE_SEARCH_CONNECTORS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20071116
2 Importing IR_MODEL_METADATA_A Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_MODEL_METADATA Model references (active model) 20091210
3 Importing IR_MODEL_METADATA_I Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_MODEL_METADATA Model references (inactive model) 20091210
4 Importing IR_SCENARIO_ANALYZER Call by reference Object reference (TYPE REF TO) CL_ESH_HANA_SCENARIO_ANALYZER ESH-on-HANA Scenario Analyzer 20120524
5 Importing IT_AUTH_OBJECTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_AUTHONW List of authorization objects 20080325
6 Importing IT_SC_NODES Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_NODES List of nodes 20071116
7 Importing IT_SC_OBJECTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_OBJECTS List of objects 20111014
8 Importing IT_SC_ODPS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_ODPS List of ODPs 20111014
9 Importing IT_SC_REQUESTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_REQUESTS List of requests 20071116
10 Importing IT_SEARCH_CONNECTORS Call by reference Type reference (TYPE) ESH_T_ADM_SEARCH_CONNECTOR Search Object Connectors 20071116
11 Importing IV_DIALOG_PROCESSING Call by reference Type reference (TYPE) CHAR1 SPACE Flag: Dialog Processing for Debug 20071116
12 Importing IV_RESET_MODE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Flag: Reset mode 20071213
13 Importing IV_WRITE_LOG Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Flag: write application log 20071116
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20071116

Method RESET_SEARCH_CONNECTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20071213
2 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search connector 20070515
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20071213

Method SCHEDULE_INDEXING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20071122
2 Importing IS_DELTA_SCHEDULE Call by reference Type reference (TYPE) ESH_S_ADM_JOB_DELTA_SCHEDULE Time interval for schedule of delta indexing 20070309
3 Importing IS_SEARCH_CONNECTOR Call by reference Type reference (TYPE) ESH_S_ADM_SEARCH_CONNECTOR Search connector 20070309
4 Importing IT_SCHEDULE_DATA Call by reference Type reference (TYPE) ESH_T_ADM_SCHEDULE_DATA List of schedule data 20071126
5 Importing IV_ACTION_INDEXING Call by reference Type reference (TYPE) STRING Action for Schedule Indexing 20071011
6 Importing IV_DIALOG_PROCESSING Call by reference Type reference (TYPE) CHAR1 SPACE Flag: Dialog Processing for Debug 20070427
7 Importing IV_REPLICATE_DATA Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Flag: Execute the process chains (BOS Search only) 20070314
8 Importing IV_SCHEDULE_DATE Call by reference Type reference (TYPE) BTCSDATE Planned Start Date for Background Job 20070309
9 Importing IV_SCHEDULE_TIME Call by reference Type reference (TYPE) BTCSTIME Planned start time for background Job 20070309
10 Importing IV_WRITE_LOG Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Flag: write application log 20070314
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20071122

Method SET_PROCESS_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090128
2 Importing IV_BLOCKSIZE Call by reference Type reference (TYPE) ESH_E_EX_FU_BLOCKSIZE Fast Update Extraction Blocksize 20090128
3 Importing IV_EXTRACT_FREQ Call by reference Type reference (TYPE) ESH_E_EX_FU_EXTRACT_FREQ Extraction Frequency 20090128
4 Importing IV_MAX_IDLE_TIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_IDLE_TIME Fast Update: Max Idle Time 20090128
5 Importing IV_MAX_RUNTIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_RUNTIME Fast Update: Max Runtime (secs) 20090128
6 Importing IV_RFCDEST Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090128
7 Importing IV_SUSPEND_MODE Call by reference Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE Fast Update Suspended Mode 20090128
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20090128

Method START_PROCESS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090120
2 Importing IV_BLOCKSIZE Call by reference Type reference (TYPE) ESH_E_EX_FU_BLOCKSIZE CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_BLOCKSIZE Fast Update Extraction Blocksize 20090120
3 Importing IV_EXTRACT_FREQ Call by reference Type reference (TYPE) ESH_E_EX_FU_EXTRACT_FREQ CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_FREQUENCY Extraction Frequency 20090120
4 Importing IV_MAX_IDLE_TIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_IDLE_TIME Fast Update: Max Idle Time 20090120
5 Importing IV_MAX_RUNTIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_RUNTIME Fast Update: Max Runtime (secs) 20090120
6 Importing IV_RFCDEST Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090120
7 Importing IV_SUSPEND_MODE Call by reference Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE Fast Update Suspended Mode 20090120
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20090120

Method STOP_PROCESS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090120
2 Importing IV_RFCDEST Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090120
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20090120

Method UPDATE_SEARCH_CONNECTOR_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20090331
2 Importing IT_SEARCH_CONNECTORS Call by reference Type reference (TYPE) ESH_T_ADM_SEARCH_CONNECTOR List of Search Connectors 20090331
3 Importing IV_IGNORING_JOB_STATUS Call by reference Type reference (TYPE) CHAR01 ABAP_FALSE Calculate status ignoring "create connector" job status 20131016
# Exception Resumable Description Created on
1 CX_ESH_ADM_GENERAL_ERROR Errors in Monitoring/Admin Component 20090401
History
Last changed by/on SAP  20141121 
SAP Release Created in 100