SAP ABAP Class CL_SEFS_SEARCH (Search)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-TRX-EFS (Application Component) TREX Enterprise File Search
⤷
SEFS_SEARCH (Package) Search Files
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-TRX-EFS (Application Component) TREX Enterprise File Search⤷
SEFS_SEARCH (Package) Search FilesProperties
| Class | CL_SEFS_SEARCH | |
| Short Description | Search | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SEFS_SEARCH | Search Files |
| Created | 20070129 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CL_SEFS_CONSTANTS |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_SEFS_SEARCH has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_ADAPT_FS | 20090602 | File Search Adapter | |
| 2 | CL_SEFS_CRAWL | 20070202 | Crawl | |
| 3 | CL_SEFS_INDEX | 20070205 | Index |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_AN_ALLOW_ACC |
Constant | Private | Type reference (TYPE) | SXES_D_ATTRIBUTE_NAME | CL_SEFS_CONSTANTS=>GC_AN_ALLOW_ACC | Attribute Name 'allowedreadaccess' | 20070419 | |
| 2 | GC_AN_DENY_ACC |
Constant | Private | Type reference (TYPE) | SXES_D_ATTRIBUTE_NAME | CL_SEFS_CONSTANTS=>GC_AN_DENY_ACC | Attribute Name 'deniedreadaccess' | 20070419 | |
| 3 | GC_AN_FILE_NAME |
Constant | Private | Type reference (TYPE) | SXES_D_ATTRIBUTE_NAME | CL_SEFS_CONSTANTS=>GC_AN_FILE_NAME | Attribute Name 'filename' | 20070207 | |
| 4 | GC_AV_AND |
Constant | Private | Type reference (TYPE) | STRING | CL_SEFS_CONSTANTS=>GC_AV_AND | Attribut Vale 'AND' | 20070419 | |
| 5 | GC_AV_NOT |
Constant | Private | Type reference (TYPE) | STRING | CL_SEFS_CONSTANTS=>GC_AV_NOT | Attribut Vale 'NOT' | 20070423 | |
| 6 | GC_AV_OR |
Constant | Private | Type reference (TYPE) | STRING | CL_SEFS_CONSTANTS=>GC_AV_OR | Attribut Vale 'OR' | 20070419 | |
| 7 | GC_AV_TREXPUBLIC |
Constant | Private | Type reference (TYPE) | STRING | CL_SEFS_CONSTANTS=>GC_AV_TREXPUBLIC | Attribut Vale '@@TREXPublic@@' | 20070419 | |
| 8 | GC_CT_C |
Constant | Private | Type reference (TYPE) | TREXD_CONTENT_TYPE | CL_SEFS_CONSTANTS=>GC_CT_C | Content Type 'C'; content (default) | 20070423 | |
| 9 | GC_CT_OR |
Constant | Private | Type reference (TYPE) | TREXD_CONTENT_TYPE | CL_SEFS_CONSTANTS=>GC_CT_OR | Content Type 'O'; or | 20070419 | |
| 10 | GC_NOT_PUBLIC |
Constant | Private | Type reference (TYPE) | SEFS_D_ACCESS_RIGHT | CL_SEFS_CONSTANTS=>GC_NOT_PUBLIC | Not Secure/Not Public | 20070419 | |
| 11 | GC_OP_EQ |
Constant | Private | Type reference (TYPE) | TREXD_OPERATOR | CL_SEFS_CONSTANTS=>GC_OP_EQ | Operator 'EQ' | 20070419 | |
| 12 | GC_RT_ATTRIBUTE |
Constant | Private | Type reference (TYPE) | TREXD_ROWTYPE | CL_SEFS_CONSTANTS=>GC_RT_ATTRIBUTE | RowType 'ATTRIBUTE' | 20070129 | |
| 13 | GC_RT_BRACKET_CLOSE |
Constant | Private | Type reference (TYPE) | TREXD_ROWTYPE | CL_SEFS_CONSTANTS=>GC_RT_BRACKET_CLOSE | RowType 'BRACKET_C' | 20070419 | |
| 14 | GC_RT_BRACKET_OPEN |
Constant | Private | Type reference (TYPE) | TREXD_ROWTYPE | CL_SEFS_CONSTANTS=>GC_RT_BRACKET_OPEN | RowType 'BRACKET_O' | 20070419 | |
| 15 | GC_RT_OPERATOR |
Constant | Private | Type reference (TYPE) | TREXD_ROWTYPE | CL_SEFS_CONSTANTS=>GC_RT_OPERATOR | RowType 'OPERATOR' | 20070419 | |
| 16 | GC_SID_EVERYONE |
Constant | Private | Type reference (TYPE) | CHAR10 | CL_SEFS_CONSTANTS=>GC_SID_EVERYONE | SID Everyone 'S-1-1-0' | 20070419 | |
| 17 | GC_TA_EXACT |
Constant | Private | Type reference (TYPE) | TREXD_TERM_ACTION | CL_SEFS_CONSTANTS=>GC_TA_EXACT | Term Action 'E', Exact Search | 20070419 | |
| 18 | GC_X |
Constant | Private | Type reference (TYPE) | BOOLEAN | CL_SEFS_CONSTANTS=>GC_X | 'X' | 20070207 | |
| 19 | GV_MSG_TXT |
Static Attribute | Private | Type reference (TYPE) | STRING | Message Text (only for message ... into GV_MSG_TXT) | 20070129 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BUILD_INDEXES |
Static method | Private | Method | Build table with Object Type IDs | 20070226 |
| 2 | BUILD_QUERY_ENTRIES |
Static method | Private | Method | Build table with Query Entries | 20070226 |
| 3 | BUILD_REQ_ATTRIBUTES |
Static method | Private | Method | Build table with Requested Attributes | 20070226 |
| 4 | BUILD_SORT_ATTRIBUTES |
Static method | Private | Method | Build table with Sorted Attributes | 20070226 |
| 5 | CONVERT_DATE_IN_DISPLAY_FORMAT |
Static method | Private | Method | Convert Date Value in Display Format | 20070129 |
| 6 | EXECUTE_SEARCH |
Static method | Public | Method | Execute Search | 20070129 |
| 7 | EXECUTE_SEARCH_TREX |
Static method | Protected | Method | Execute Search TREX | 20070129 |
| 8 | EXPAND_QUERY_WITH_SID |
Static method | Private | Method | Expand Query with Security Identifiers (SID) | 20070419 |
| 9 | GET_SEARCH_RESULTS |
Static method | Private | Method | Build Table with Search Results | 20070130 |
Events
Class CL_SEFS_SEARCH has no event.
Types
Class CL_SEFS_SEARCH has no local type.
Method Signatures
Method BUILD_INDEXES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_INDEXES | Call by reference | Type reference (TYPE) | TREXT_INDEXLIST | Indexes with language and rfc destination | 20070323 | ||
| 2 | Exporting |
EV_SECURE | Call by reference | Type reference (TYPE) | SEFS_D_ACCESS_RIGHT | Secure | 20070323 | ||
| 3 |  Importing |
IT_OBJ_TYPE | Call by reference | Type reference (TYPE) | SEFS_T_OBJ_TYPE | Object Types | 20070226 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SEFS_DB_CONFIG_ERROR |
Exception class for Configuration Error | 20070226 |
Method BUILD_QUERY_ENTRIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_QUERY | Call by reference | Type reference (TYPE) | SXES_T_QUERY_ENTRIES | Search query | 20070226 | ||
| 2 | Importing |
IV_SECURE | Call by reference | Type reference (TYPE) | SEFS_D_ACCESS_RIGHT | Secure | 20070323 | ||
| 3 |  Returning |
RT_QUERY_ENTRIES | Value transfer | Type reference (TYPE) | TREXT_QUERY_ENTRIES | Search query | 20070226 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SEFS_SEARCH_ERROR |
File Search Errors | 20070420 |
Method BUILD_REQ_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_REQUESTED_FIELDS | Call by reference | Type reference (TYPE) | SXES_T_ATTR_NAMES | Table of attribute names | 20070226 | ||
| 2 | Returning |
RT_REQ_ATTRS | Value transfer | Type reference (TYPE) | TREXT_ATTRIBUTES | Table of attribute names | 20070226 |
Method BUILD_REQ_ATTRIBUTES on class CL_SEFS_SEARCH has no exception.
Method BUILD_SORT_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_SORT | Call by reference | Type reference (TYPE) | SXES_T_SORT_ATTRIBUTES | Sort attributes | 20070226 | ||
| 2 | Returning |
RT_SORT_ATTRS | Value transfer | Type reference (TYPE) | TREXT_SORT_ATTRIBUTES | Sort attributes | 20070226 |
Method BUILD_SORT_ATTRIBUTES on class CL_SEFS_SEARCH has no exception.
Method CONVERT_DATE_IN_DISPLAY_FORMAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DATE | Call by reference | Type reference (TYPE) | STRING | Date | 20070129 | ||
| 2 | Returning |
RV_DATE_DISPLAY | Value transfer | Type reference (TYPE) | STRING | Date in Display Format | 20070129 |
Method CONVERT_DATE_IN_DISPLAY_FORMAT on class CL_SEFS_SEARCH has no exception.
Method EXECUTE_SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ATTR_DIST_RANGES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_RANGES | Attribute distribution ranges | 20070221 | ||
| 2 | Exporting |
ET_ATTR_DIST_VALUES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_VALUES | Attribute distribution values | 20070221 | ||
| 3 | Exporting |
ET_RESULTS | Call by reference | Type reference (TYPE) | SXES_T_RESULTS | Result table of one search service provider | 20070129 | ||
| 4 | Exporting |
ET_RUNTIMES | Call by reference | Type reference (TYPE) | SXES_T_BENCHMARKS | List of runtimes of components in the call stack | 20070420 | ||
| 5 | Exporting |
EV_NO_OF_ALL_HITS | Call by reference | Type reference (TYPE) | I | Hit count for search (all) | 20090115 | ||
| 6 | Exporting |
EV_NO_OF_HITS | Call by reference | Type reference (TYPE) | I | Hit count for search | 20090115 | ||
| 7 | Importing |
IS_ATTR_DIST_GLOBAL | Call by reference | Type reference (TYPE) | SESH_S_ATTR_DIST_GLOBAL | Attribute distibution: Global settings | 20070518 | ||
| 8 | Importing |
IT_ATTR_DIST_DEFINITION | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_DEFINITION | Attribute distribution: Definition | 20070221 | ||
| 9 | Importing |
IT_OBJ_TYPE_IDS | Call by reference | Type reference (TYPE) | SXES_T_OBJECT_TYPE_IDS | Table of object type ids of one search service provider | 20070129 | ||
| 10 | Importing |
IT_QUERY | Call by reference | Type reference (TYPE) | SXES_T_QUERY_ENTRIES | Search query | 20070129 | ||
| 11 | Importing |
IT_REQUESTED_FIELDS | Call by reference | Type reference (TYPE) | SXES_T_ATTR_NAMES | Table of attribute names | 20070129 | ||
| 12 | Importing |
IT_SORT | Call by reference | Type reference (TYPE) | SXES_T_SORT_ATTRIBUTES | Sort attributes | 20070129 | ||
| 13 | Importing |
IT_STAT_INFO_ATTRS | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Statistic Information Attributes | 20090114 | ||
| 14 | Importing |
IV_FROM | Call by reference | Type reference (TYPE) | I | 1 | 20070129 | ||
| 15 | Importing |
IV_LANGU | Call by reference | Type reference (TYPE) | LAISO | Language according to ISO 639 | 20070129 | ||
| 16 | Importing |
IV_READ_STAT_INFO | Call by reference | Type reference (TYPE) | XFELD | 'X' = Read Statistical Information | 20090113 | ||
| 17 | Importing |
IV_TO | Call by reference | Type reference (TYPE) | I | 5 | 20070129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SEFS_DB_CONFIG_ERROR |
Exception class for Configuration Error | 20070209 | |
| 2 | CX_SEFS_SEARCH_ERROR |
Object Type Errors | 20070129 |
Method EXECUTE_SEARCH_TREX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ATTR_DIST_RANGES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_RANGES | Attribute distribution ranges | 20070221 | ||
| 2 | Exporting |
ET_ATTR_DIST_VALUES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_VALUES | Attribute distribution values | 20070221 | ||
| 3 | Exporting |
ET_RESULT_DOCS | Call by reference | Type reference (TYPE) | TREXT_RESULT_DOCS | Result table of one search service provider | 20070129 | ||
| 4 | Exporting |
EV_NO_OF_ALL_HITS | Call by reference | Type reference (TYPE) | I | Hit count for search (all) | 20090115 | ||
| 5 | Exporting |
EV_NO_OF_HITS | Call by reference | Type reference (TYPE) | I | Hit count for search | 20090115 | ||
| 6 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_CODE | Returncode | 20070129 | ||
| 7 | Exporting |
EV_RETURN_TEXT | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_TEXT | Returntext | 20070129 | ||
| 8 | Importing |
IS_ATTR_DIST_GLOBAL | Call by reference | Type reference (TYPE) | TREXS_ATTR_DIST_GLOBAL | Attribute distibution: Global settings | 20070518 | ||
| 9 | Importing |
IT_ATTR_DIST_DEFINITION | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_DEFINITION | Attribute distribution: Definition | 20070221 | ||
| 10 | Importing |
IT_INDEXES | Call by reference | Type reference (TYPE) | TREXT_INDEXLIST | Indexes with language and rfc destination | 20070129 | ||
| 11 | Importing |
IT_QUERY_ENTRIES | Call by reference | Type reference (TYPE) | TREXT_QUERY_ENTRIES | Search query | 20070129 | ||
| 12 | Importing |
IT_REQ_ATTRS | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Table of attribute names | 20070129 | ||
| 13 | Importing |
IT_SORT_ATTRS | Call by reference | Type reference (TYPE) | TREXT_SORT_ATTRIBUTES | Sort attributes | 20070129 | ||
| 14 | Importing |
IT_STAT_INFO_ATTRS | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Statistic Information Attributes | 20090114 | ||
| 15 | Importing |
IV_FROM | Call by reference | Type reference (TYPE) | I | 1 | 20070129 | ||
| 16 | Importing |
IV_LANGU | Call by reference | Type reference (TYPE) | LAISO | Language according to ISO 639 | 20070129 | ||
| 17 | Importing |
IV_READ_STAT_INFO | Call by reference | Type reference (TYPE) | XFELD | 'X' = Read Statistical Information | 20090113 | ||
| 18 | Importing |
IV_TO | Call by reference | Type reference (TYPE) | I | 5 | 20070129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SEFS_DB_CONFIG_ERROR |
Exception class for Configuration Error | 20070213 | |
| 2 | CX_SEFS_SEARCH_ERROR |
Object Type Errors | 20070129 |
Method EXPAND_QUERY_WITH_SID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_QUERY_ENTRIES | Call by reference | Type reference (TYPE) | TREXT_QUERY_ENTRIES | Search query | 20070419 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SEFS_SEARCH_ERROR |
File Search Errors | 20070419 |
Method GET_SEARCH_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_RESULTS | Call by reference | Type reference (TYPE) | SXES_T_RESULTS | Result table of one search service provider | 20070208 | ||
| 2 | Importing |
IT_RESULT_DOCS | Call by reference | Type reference (TYPE) | TREXT_RESULT_DOCS | Result table of one search service provider | 20070130 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SEFS_DB_CONFIG_ERROR |
Exception class for Configuration Error | 20070209 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 710 |
