SAP ABAP Class CL_SEFS_CRAWL_INDEX_INT_UTIL (Utilities (only for internal use))
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-TRX-EFS (Application Component) TREX Enterprise File Search
⤷
SEFS_CRAWL (Package) Crawl Files
⤷
⤷
Properties
| Class | CL_SEFS_CRAWL_INDEX_INT_UTIL | |
| Short Description | Utilities (only for internal use) | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | SEFS | |
| Program status | ||
| Category | 0 | |
| Package | SEFS_CRAWL | Crawl Files |
| Created | 20070222 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_SEFS_CRAWL_INDEX_INT_UTIL has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_SEFS_CRAWL | 20070222 | Crawl | |
| 2 | CL_SEFS_CRAWL_CONFIG | 20070301 | Crawl Configuration | |
| 3 | CL_SEFS_CRAWL_CONFIG_ESH | 20100806 | Crawl Configuration ESH | |
| 4 | CL_SEFS_INDEX | 20070222 | Index |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | ACTIV_AUTH | CL_SEFS_CONSTANTS=>GC_ADM_AUTH_DELETE | Delete Activity (Administration) | 20070615 | ||
| 2 | Constant | Private | Type reference (TYPE) | TEXT9 | CL_SEFS_CONSTANTS=>GC_MAIN_NODE_NAME | Main Node Name in File Template | 20100806 | ||
| 3 | Constant | Private | Type reference (TYPE) | SYMSGTY | CL_SEFS_CONSTANTS=>GC_MSGTY_ERROR | Message Type Error | 20070503 | ||
| 4 | Constant | Private | Type reference (TYPE) | SYMSGTY | CL_SEFS_CONSTANTS=>GC_MSGTY_INFO | Message Type Info | 20070503 | ||
| 5 | Constant | Private | Type reference (TYPE) | CHAR4 | CL_SEFS_CONSTANTS=>GC_NAMESPACE_EFS | Namespace of Enterprise File Search (Index, Crawl) | 20070302 | ||
| 6 | Constant | Private | Type reference (TYPE) | CHAR4 | CL_SEFS_CONSTANTS=>GC_NAMESPACE_ESH | Namespace of Enterprise File Search (Index, Crawl) | 20100806 | ||
| 7 | Constant | Private | Type reference (TYPE) | CHAR4 | CL_SEFS_CONSTANTS=>GC_NAMESPACE_FILE | Namespace FILE_ (Object Type) | 20100809 | ||
| 8 | Constant | Private | Type reference (TYPE) | BOOLEAN | CL_SEFS_CONSTANTS=>GC_X | 'X' | 20070222 | ||
| 9 | Static Attribute | Private | Type reference (TYPE) | SESH_T_RETURN_CODES | Return codes per object type | 20070226 | |||
| 10 | Static Attribute | Private | Type reference (TYPE) | STRING | Message Text (only for message ... into GV_MSG_TXT) | 20070222 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Private | Method | Add Free Text to Log with Message Type Error | 20070503 | |
| 2 | Static method | Private | Method | Add Free Text to Log with Message Type Info | 20070503 | |
| 3 | Static method | Public | Method | Add Return Codes into Table | 20070228 | |
| 4 | Static method | Protected | Method | Build Id | 20070222 | |
| 5 | Static method | Protected | Method | Check Input | 20070222 | |
| 6 | Static method | Public | Method | Clear Table with Return Codes | 20070228 | |
| 7 | Static method | Protected | Method | Convert Date or Timestamp to Display Format | 20070222 | |
| 8 | Static method | Protected | Method | Delete all Crawl Data | 20070307 | |
| 9 | Static method | Private | Method | Get Domain Values | 20070307 | |
| 10 | Static method | Public | Method | Get Text of Domain Value | 20070307 | |
| 11 | Static method | Public | Method | Get Name from Id | 20070222 | |
| 12 | Static method | Protected | Method | Get Number from Number Range Object | 20070301 | |
| 13 | Static method | Public | Method | Get Table with Return Codes | 20070227 | |
| 14 | Static method | Protected | Method | Is EFS (Enterprise File Search) | 20100917 | |
| 15 | Static method | Protected | Method | Prepare Timestamp | 20070222 | |
| 16 | Static method | Public | Method | Set Table with Return Codes | 20070502 |
Events
Class CL_SEFS_CRAWL_INDEX_INT_UTIL has no event.
Types
Class CL_SEFS_CRAWL_INDEX_INT_UTIL has no local type.
Method Signatures
Method ADD_FREE_TEXT_2_LOG_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MSG_TXT | Call by reference | Type reference (TYPE) | STRING | Message Text | 20070503 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Crawl and Index Exceptions | 20070503 |
Method ADD_FREE_TEXT_2_LOG_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MSG_TXT | Call by reference | Type reference (TYPE) | STRING | Message Text | 20070503 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Crawl and Index Exceptions | 20070503 |
Method ADD_RETURN_CODES_TAB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CRAWL_ID | Call by reference | Type reference (TYPE) | TREXS_CRUISER-CRUISE_NAME | Crawl ID | 20070228 | |||
| 2 | IV_INDEX_ID | Call by reference | Type reference (TYPE) | SEFS_D_INDEX_ID | Index ID | 20070228 | |||
| 3 | IV_MSG_TXT | Call by reference | Type reference (TYPE) | STRING | Message Text (only for message ... into GV_MSG_TXT) | 20070228 | |||
| 4 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | SEFS_D_OBJECT_TYPE | Object Type | 20070228 |
Method ADD_RETURN_CODES_TAB on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method BUILD_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NAME | Call by reference | Type reference (TYPE) | SEFS_D_INDEX_NAME | Name | 20070222 | |||
| 2 | RV_ID | Value transfer | Type reference (TYPE) | TREXD_INDEX_ID | Id | 20070222 |
Method BUILD_ID on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method CHECK_INPUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CHECK | Call by reference | Type reference (TYPE) | STRING | Check Against ... | 20070222 | |||
| 2 | IV_INPUT | Call by reference | Type reference (TYPE) | STRING | Input | 20070222 | |||
| 3 | IV_LOG_HANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Application Log: Log Handle | 20070222 | |||
| 4 | RV_VALID | Value transfer | Type reference (TYPE) | BOOLEAN | 'X' = Input is Valid | 20070222 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Crawl and Index Exceptions | 20070330 | ||
| 2 | TREX Administration Exceptions | 20070330 |
Method CLEAR_RETURN_CODES_TAB Signature
Method CLEAR_RETURN_CODES_TAB on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no parameter.
Method CLEAR_RETURN_CODES_TAB on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method CONVERT_DATE_2_DISPLAY_FORMAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_INPUT | Call by reference | Type reference (TYPE) | ANY | Date or Timestamp | 20070222 | |||
| 2 | RV_OUTPUT | Value transfer | Type reference (TYPE) | STRING | Date or Timestamp in Display Format | 20070222 |
Method CONVERT_DATE_2_DISPLAY_FORMAT on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method DELETE_ALL_CRAWL_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_CRAWL_ID | Call by reference | Type reference (TYPE) | SEFS_T_CRAWL_ID | Crawl ID | 20070307 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Crawl and Index Exceptions | 20070430 |
Method GET_DOMAIN_VALUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_DATA_ELEMENT | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20070307 | |||
| 2 | RT_DOMAIN_VALUES | Value transfer | Type reference (TYPE) | DDFIXVALUES | Description of Domain Fixed Values | 20070307 |
Method GET_DOMAIN_VALUES on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method GET_DOMAIN_VALUE_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_DATA_ELEMENT | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20070307 | |||
| 2 | IV_DOMAIN_VALUE | Call by reference | Type reference (TYPE) | DOMVALUE_L | Values for Domains: Single Value / Upper Limit | 20070307 | |||
| 3 | RV_DOMAIN_VALUE_TEXT | Value transfer | Type reference (TYPE) | VAL_TEXT | Short Text for Fixed Values | 20070307 |
Method GET_DOMAIN_VALUE_TEXT on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method GET_NAME_FROM_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Value transfer | Type reference (TYPE) | TREXD_INDEX_ID | Id | 20070222 | |||
| 2 | RV_NAME | Value transfer | Type reference (TYPE) | SEFS_D_INDEX_NAME | Name | 20070222 |
Method GET_NAME_FROM_ID on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method GET_NUMBER_FROM_NUMBER_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_RANGE_NR | Call by reference | Type reference (TYPE) | NRNR | Number Range Number | 20070301 | |||
| 2 | IV_RANGE_OBJ | Call by reference | Type reference (TYPE) | NROBJ | Name of Number Range Object | 20070301 | |||
| 3 | RV_NUMBER | Value transfer | Type reference (TYPE) | CHAR10 | Number from Number Range | 20070301 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Crawl and Index Exceptions | 20070301 |
Method GET_RETURN_CODES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_RETURN_CODES | Value transfer | Type reference (TYPE) | SESH_T_RETURN_CODES | Return codes per object type | 20070227 |
Method GET_RETURN_CODES on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method IS_EFS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Call by reference | Type reference (TYPE) | SEFS_D_INDEX_ID | Index ID | 20101004 | |||
| 2 | IV_NAME | Call by reference | Type reference (TYPE) | SEFS_D_INDEX_NAME | Index Name | 20101004 | |||
| 3 | RV_IS_EFS | Value transfer | Type reference (TYPE) | XFELD | 'X' = is EFS | 20100917 |
Method IS_EFS on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method PREPARE_TIMESTAMP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_INPUT | Call by reference | Type reference (TYPE) | ANY | Date or Timestamp | 20070222 | |||
| 2 | RV_TIMESTAMP | Value transfer | Type reference (TYPE) | TZNTSTMPS | Timestamp | 20070222 |
Method PREPARE_TIMESTAMP on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
Method SET_RETURN_CODES_TAB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_RETURN_CODES | Call by reference | Type reference (TYPE) | SESH_T_RETURN_CODES | Return codes per object type | 20070502 |
Method SET_RETURN_CODES_TAB on class CL_SEFS_CRAWL_INDEX_INT_UTIL has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 710 |