SAP ABAP Class CL_ESH_ADM_FILE_SCT_CONTROLLER (Search Connector Type Controller for File Search)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_ADMIN_FILES (Package) Monitoring and Admin for the File Search Component
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_ESH_ADM_ABSTRACT_SCT_CTRL | Abstract Base Class for SCT Controllers | 20070327 |
Properties
| Class | CL_ESH_ADM_FILE_SCT_CONTROLLER | |
| Short Description | Search Connector Type Controller for File Search | |
| Super Class | CL_ESH_ADM_ABSTRACT_SCT_CTRL | Abstract Base Class for SCT Controllers |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_ADMIN_FILES | Monitoring and Admin for the File Search Component |
| Created | 20070327 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_ESH_ADM_FILE_SCT_CONTROLLER has no forward declaration.
Interfaces
Class CL_ESH_ADM_FILE_SCT_CONTROLLER has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_DB_FILE_SCHEDULE | 20071109 | Schedule Data for File Indexing |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_CRAWL_ACTION | 'FULL_UPDATE_CRAWL' | Actions for crawlers | 20070411 | ||
| 2 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_CRAWL_ACTION | 'RESTART_CRAWL' | Actions for crawlers | 20071017 | ||
| 3 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_CRAWL_ACTION | 'RESUME_CRAWL' | Actions for crawlers | 20070411 | ||
| 4 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_CRAWL_ACTION | 'START_CRAWL' | Actions for crawlers | 20070411 | ||
| 5 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_CRAWL_ACTION | 'SUSPEND_CRAWL' | Actions for crawlers | 20070411 | ||
| 6 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_CRAWL_ACTION | 'UPDATE_CRAWL' | Actions for crawlers | 20070411 | ||
| 7 | Constant | Private | Type reference (TYPE) | BTCJOB | 'ACTIVATE_' | Background job name | 20070504 | ||
| 8 | Constant | Private | Type reference (TYPE) | BTCJOB | 'ESH_INDEX_' | Background job name | 20070504 | ||
| 9 | Constant | Public | Type reference (TYPE) | SEFS_D_CRAWL_ID | 'NEW_CRAWL_ID' | Temporary crawl ID for a new crawler | 20070420 | ||
| 10 | Constant | Public | Type reference (TYPE) | ESH_E_OM_NODE_NAME | 'FILE_ATTR' | Node Name | 20100823 | ||
| 11 | Constant | Private | Type reference (TYPE) | BTCSDATE | ' ' | Planned start date for background job | 20070504 | ||
| 12 | Constant | Private | Type reference (TYPE) | BTCSTIME | ' ' | Planned start time for background job | 20070504 | ||
| 13 | Constant | Private | Type reference (TYPE) | SEFS_D_ACCESS_RIGHT | '0' | Public index | 20070327 | ||
| 14 | Constant | Public | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_TYPE | 'FILES' | Search connector type | 20070327 | ||
| 15 | Constant | Private | Type reference (TYPE) | SEFS_D_ACCESS_RIGHT | '1' | Secure index | 20070327 | ||
| 16 | Constant | Public | Type reference (TYPE) | ESH_E_ADM_ROW_TYPE | 'CRAWL' | Type of the entity that is contained in one row | 20070327 | ||
| 17 | Static Attribute | Private | Type reference (TYPE) | STRING | Dummy message field | 20071116 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Convert search connector ID to object type ID | 20081202 | |
| 2 | Static method | Public | Method | Create a crawl | 20071212 |
Events
Class CL_ESH_ADM_FILE_SCT_CONTROLLER has no event.
Types
Class CL_ESH_ADM_FILE_SCT_CONTROLLER has no local type.
Method Signatures
Method CONV_SC_ID_TO_OBJECT_TYPE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_FS_CONNECTION | Call by reference | Type reference (TYPE) | ESH_S_ADAPT_CONN_FS_CONN | File Search Connectivity | 20081202 | |||
| 2 | IV_SC_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20081202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error in Connectivity Manager | 20081202 |
Method CREATE_CRAWL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_SC_LIST_CRAWL | Call by reference | Type reference (TYPE) | ESH_S_ADM_SC_INFO_UI | Extended Information about a Search Connector | 20071212 | |||
| 2 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | SESH_T_RETURN_CODES | Return codes per object type | 20071212 | |||
| 3 | IS_CRAWL_ADVANCED_UI | Call by reference | Type reference (TYPE) | SEFS_S_CRAWL_ADVANCED_UI | Crawl Advanced UI | 20071212 | |||
| 4 | IS_CRAWL_BASIC_UI | Call by reference | Type reference (TYPE) | SEFS_S_CRAWL_BASIC_UI | Crawl Basic UI | 20071212 | |||
| 5 | IT_CRAWL_DIR_EXCL | Call by reference | Type reference (TYPE) | SEFS_T_CRAWL_DIR_EXCL | Excluding Directories for Crawl | 20071212 | |||
| 6 | IT_CRAWL_HOST_INFO | Call by reference | Type reference (TYPE) | SEFS_T_CRAWL_HOST_INFO | Host Information for Crawl | 20071212 | |||
| 7 | IV_PARENT_KEY | Call by reference | Type reference (TYPE) | ESH_E_ADM_KEY | Key for Hierarchical Structure | 20071212 | |||
| 8 | IV_SC_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20071212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error in Connectivity Manager | 20081202 | ||
| 2 | Crawl and Index Exceptions | 20071212 | ||
| 3 | Exception class for Configuration Error | 20071212 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 100 |