SAP ABAP Interface IF_COM_SE_TREX (OO-Interface for Search Engine (TREX or Similar))
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-TRX-SES (Application Component) TREX Search Engine Service
     SES_CUSTOM (Package) SES: Customizing + central types and functions
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_COM_SE_TREX OO Wrapper for TREX ABAP Client 20031203
Properties
Interface IF_COM_SE_TREX  
Short Description OO-Interface for Search Engine (TREX or Similar)    
General Data
Package SES_CUSTOM   SES: Customizing + central types and functions 
Created 20031125   SAP 
Last changed 20130531   SAP 
Unicode checks active    
Forward declarations
Interface IF_COM_SE_TREX has no forward declaration.
Interfaces
Interface IF_COM_SE_TREX has no interface.
Friends
Interface IF_COM_SE_TREX has no friend.
Attributes
Interface IF_COM_SE_TREX has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CREATE_INDEX Instance method Public Method Create Index 20031202
2 CREATE_JOIN_INDEX Instance method Public Method Create Join Index 20050118
3 DELETE_INDEX Instance method Public Method Delete Index 20031202
4 FEED_INDEX Instance method Public Method Feed Index (= Index/Deindex Documents/Objects) 20040202
5 FLUSH_QUEUES Instance method Public Method Trigger Flush of Index Queues 20040125
6 GET_ATTRIBUTE_TYPE Instance method Public Method Determine TREX attribute type from DDIC type 20050714
7 GET_INSTANCE Static method Public Method Fetching Instance (Singleton) 20031211
8 GET_QUEUES Instance method Public Method Get Status of Index Queues 20040229
9 INDEX_EXISTS Instance method Public Method List of Indexes with their return code 20050105
10 SEARCH_DOCUMENTS Instance method Public Method Search for Documents/Objects 20031203
11 SET_QUEUE_PARAMETERS Instance method Public Method Set Queue Parameter(s) 20040629
Events
Interface IF_COM_SE_TREX has no event.
Types
Interface IF_COM_SE_TREX has no local type.
Method Signatures

Method CREATE_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20031202
2 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20031202
3 Importing IT_ATTRIBUTE_DEFINITIONS Call by reference Type reference (TYPE) TREXT_ATTR_DEF Attributdefinitionen (Gruppen etc.) 20050303
4 Importing IT_FREESTYLE_SEARCH_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_ATTRIBUTES Standardattribute, bei denen eine Freistilsuche stattfindet 20050303
5 Importing IV_DESCRIPTION Call by reference Type reference (TYPE) TREX_RFC-DESCRIPTION Bezeichnung 20031204
6 Importing IV_INDEX_ID Call by reference Type reference (TYPE) TREX_RFC-INDEX_ID Index-ID 20031202
7 Importing IV_LANGUAGE Call by reference Type reference (TYPE) LAISO Sprache nach ISO 639, z.B. 'EN' 20040123
8 Importing IV_MULTILANG_DOCS Call by reference Type reference (TYPE) TREX_RFC-FLAG 'X' X = mehrsprachige Dokumente/Objekte 20031204
9 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination der Suchmaschine 20031202
10 Importing IV_SIZE_FOR_DELTA_INDEX Call by reference Type reference (TYPE) TREX_RFC-NUMC 0 Anzahl Dokumente/Objekte, ab der Delta-Indizierung aktiv 20031204
11 Importing IV_TEXTMINING_RELEVANT Call by reference Type reference (TYPE) TREX_RFC-FLAG ' ' X = relevant für Textmining 20031211
12 Importing IV_USE_QUEUESERVER Call by reference Type reference (TYPE) TREX_RFC-FLAG 'X' X = Queue benutzen 20031202
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20031202
2 ERROR Fehler, siehe SYST-Variablen 20031202

Method CREATE_JOIN_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20050118
2 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20050118
3 Importing IT_BUSINESS_OBJECT_VIEWS Call by reference Type reference (TYPE) TREXT_BO_VIEWS Business-Objekt-Views 20050118
4 Importing IT_JOIN_INDEXES Call by reference Type reference (TYPE) TREXT_JOIN_INDEX Join-Index 20050118
5 Importing IT_JOIN_PATHS Call by reference Type reference (TYPE) TREXT_JOIN_PATHS Join-Pfade 20050118
6 Importing IT_KEY_FIGURES Call by reference Type reference (TYPE) TREXT_KEY_FIGURE Kennzahl 20050118
7 Importing IT_SEMANTIC_RELATIONS Call by reference Type reference (TYPE) TREXT_SEMANTIC_RELATIONS Semantische Beziehungen 20050118
8 Importing IT_STATIC_JOIN_CONDITIONS Call by reference Type reference (TYPE) TREXT_STATIC_JOIN_CONDITION Statische Join-Bedingung 20050118
9 Importing IT_VIEW_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_VIEW_ATTRIBUTES View-Attribute 20050118
10 Importing IV_DEFAULT_VIEW_NAME Call by reference Type reference (TYPE) TREXS_BO_VIEW-VIEW_NAME Standard-View-Name 20050118
11 Importing IV_DESCRIPTION Call by reference Type reference (TYPE) TREX_RFC-DESCRIPTION Bezeichnung 20050118
12 Importing IV_INDEX_ID Call by reference Type reference (TYPE) TREX_RFC-INDEX_ID Index-ID 20050118
13 Importing IV_INDEX_TYPE Call by reference Type reference (TYPE) TREX_RFC-FLAG '2' Index-Typ: 3=olap, 2=join 20050118
14 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination zur TREX-Engine 20050118
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20050118
2 ERROR Fehler, siehe Fehlermeldung 20050118

Method DELETE_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20031202
2 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20031202
3 Importing IV_INDEX_ID Call by reference Type reference (TYPE) TREX_RFC-INDEX_ID Index-ID 20031202
4 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination der Suchmaschine 20031202
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20031202
2 ERROR Fehler, siehe SYST-Variablen 20031202

Method FEED_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_RETURN_ERROR_DOC Call by reference Type reference (TYPE) TREXT_INDEX_DOCS fehlerhafte Dokumente/Objekte 20040202
2 Exporting EV_COMPONENT_RUNTIME Call by reference Type reference (TYPE) TREXS_COMPONENT_RUNTIME Laufzeit der Suchmaschine 20040202
3 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20040202
4 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20040202
5 Importing IT_INDEX_DOCUMENT_LIST Call by reference Type reference (TYPE) TREXT_INDEX_DOCS Dokumente/Objekte zur Indizierung 20040202
6 Importing IV_FLUSH_AFTER_INDEX Call by reference Type reference (TYPE) TREX_RFC-FLAG 'X' Flush documents after indexing 20071004
7 Importing IV_INDEX_ID Call by reference Type reference (TYPE) TREX_RFC-INDEX_ID Index-ID 20040202
8 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination der Suchmaschine 20040202
9 Importing IV_USE_QUEUESERVER Call by reference Type reference (TYPE) TREX_RFC-FLAG 'X' X = Queue benutzen 20040202
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20040202
2 ERROR Fehler, siehe SYST-Variablen 20040202

Method FLUSH_QUEUES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_QUEUE_RETURN Call by reference Type reference (TYPE) TREXT_QUEUE_RETURN Queues mit Returncode 20040126
2 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20040125
3 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20040125
4 Importing IT_INDEXES Call by reference Type reference (TYPE) TREXT_INDEX_IDS Indizes, für deren Queue ein Flush ausgelöst werden soll 20040125
5 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination der Suchmaschine 20040125
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20040126
2 ERROR Fehler, siehe SYST-Variablen 20040126

Method GET_ATTRIBUTE_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_ATTRIBUTE_TYPE Call by reference Type reference (TYPE) TREXS_ATTR_DEF-ATTR_TYPE TREX-Attributtyp 20050714
2 Exporting EV_DIGITS_AFTER Call by reference Type reference (TYPE) TREXS_ATTR_DEF-DIGITS_AFTER Optional für Typ X: Stellen nach Dezimalzeichen 20050714
3 Exporting EV_DIGITS_BEFORE Call by reference Type reference (TYPE) TREXS_ATTR_DEF-DIGITS_BEFORE Optional für Typ X: Stellen nach Dezimalzeichen 20050714
4 Importing IV_DATATYPE_1 Call by reference Type reference (TYPE) ABAPTYPE 1-stelliger Datentyp in ABAP-Laufzeit (z.B.: C) 20050714
5 Importing IV_DATATYPE_4 Call by reference Type reference (TYPE) DD04V-DATATYPE 4-stelliger Datentyp in ABAP-Verzeichnis (e.g.: CHAR) 20050714
6 Importing IV_DECIMALS Call by reference Type reference (TYPE) DD04V-DECIMALS Anzahl der Dezimalstellen 20050714
7 Importing IV_DOMNAME Call by reference Type reference (TYPE) DD04V-DOMNAME Domänenname (für Zeitstempel + GUID) 20050714
8 Importing IV_LENG Call by reference Type reference (TYPE) DD04V-LENG Länge (Zeichenzahl) 20050714
9 Importing IV_LOWERCASE Call by reference Type reference (TYPE) DD04V-LOWERCASE Kleinbuchstaben erlaubt/nicht erlaubt 20050714

Method GET_ATTRIBUTE_TYPE on Interface IF_COM_SE_TREX has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_INSTANCE Value transfer Object reference (TYPE REF TO) IF_COM_SE_TREX Singleton-Instanz der implementierenden Klasse 20031211

Method GET_INSTANCE on Interface IF_COM_SE_TREX has no exception.

Method GET_QUEUES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_QUEUE_STATE_RETURN Call by reference Type reference (TYPE) TREXT_QUEUE_STATE_RETURN Queues mit Returncode, Dokumentzahlen 20040229
2 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20040229
3 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20040229
4 Importing IT_INDEXES Call by reference Type reference (TYPE) TREXT_INDEX_IDS Indizes, deren Queue-Status geholt werden soll 20040229
5 Importing IV_NAMESPACE Call by reference Type reference (TYPE) TREX_RFC-NAMESPACE ' ' Namespace der Indizes, deren Queue-Status geholt werden soll 20040229
6 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination der Suchmaschine 20040229
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20040229
2 ERROR Fehler, siehe SYST-Variablen 20040229

Method INDEX_EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_INDEX_INFO Call by reference Type reference (TYPE) TREXT_INDEX_EXIST Index vorhanden 20050105
2 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Rückgabewert 20050105
3 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20050105
4 Importing IT_INDEXES Call by reference Type reference (TYPE) TREXT_INDEX_IDS Indizes 20050105
5 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination zur TREX-Engine 20050105
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20050105
2 ERROR Fehler, siehe Fehlermeldung 20050105

Method SEARCH_DOCUMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ATTR_DIST_VALUES Call by reference Type reference (TYPE) TREXT_ATTR_DIST_VALUES Attribute distribution values 20081009
2 Exporting ET_RESULT_DOCS Call by reference Type reference (TYPE) TREXT_RESULT_DOCS gefundene Dokumente/Objekte 20031203
3 Exporting ET_SUGGESTED_TERMS Call by reference Type reference (TYPE) TREXT_SUGGESTED_TERM DidYouMean 20090113
4 Exporting EV_COMPONENT_RUNTIME Call by reference Type reference (TYPE) TREXS_COMPONENT_RUNTIME Laufzeit der Suchmaschine 20031203
5 Exporting EV_INDEX_SIZE Call by reference Type reference (TYPE) I Anzahl Dokumente/Objekte im Index 20031203
6 Exporting EV_NO_OF_ALL_HITS Call by reference Type reference (TYPE) I Anzahl aller Treffer im Index 20031203
7 Exporting EV_NO_OF_HITS Call by reference Type reference (TYPE) I Anzahl Treffer in ET_RESULT_DOCS 20031203
8 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20031203
9 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20031203
10 Importing IS_ATTR_DIST_GLOBAL Call by reference Type reference (TYPE) TREXS_ATTR_DIST_GLOBAL Attribute distribution: Global settings 20081230
11 Importing IT_INDEXES Call by reference Type reference (TYPE) TREXT_INDEXLIST Indizes, über die gesucht werden soll 20031203
12 Importing IT_QUERY_ENTRIES Call by reference Type reference (TYPE) TREXT_QUERY_ENTRIES Suchanfragen (Queries) 20031203
13 Importing IT_REQ_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_ATTRIBUTES angeforderte Attribute 20031203
14 Importing IT_REQ_JOIN_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_JOIN_ATTRIBUTES Attribute mit Index-ID und Join-Pfad 20050215
15 Importing IT_SNIPPET_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_ATTRIBUTES Snippets for text attributes 20090213
16 Importing IT_SORT_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_SORT_ATTRIBUTES Sortierattribute 20031203
17 Importing IT_STAT_INFO_ATTRS Call by reference Type reference (TYPE) TREXT_ATTRIBUTES Attributes for statistical Info 20081230
18 Importing IV_COUNT_ONLY Call by reference Type reference (TYPE) TREX_RFC-FLAG X: result documents are only counted 20090316
19 Importing IV_REQUESTED_RESULTS Call by reference Type reference (TYPE) TREX_RFC-REQUESTED_RESULTS 1 Angefor. Ergebnisse: 1 = docs, 8 = hit attrs / doc, 9 = both 20050311
20 Importing IV_REQUEST_FLAGS Call by reference Type reference (TYPE) TREX_RFC-REQUEST_FLAG 0 Request-Kennzeichen 20050209
21 Importing IV_RESULT_FROM Call by reference Type reference (TYPE) I 1 von Treffer-Nr. 20031203
22 Importing IV_RESULT_TO Call by reference Type reference (TYPE) I 20 bis Treffer-Nr. 20031203
23 Importing IV_STATISTICAL_INFO Call by reference Type reference (TYPE) BOOLE_D ' ' 'X' - with statistical info 20081009
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20031203
2 ERROR Fehler, siehe SYST-Variablen 20031203

Method SET_QUEUE_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RETURN_CODE Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE Returncode 20040629
2 Exporting EV_RETURN_TEXT Call by reference Type reference (TYPE) TREX_RFC-RETURN_TEXT Rückgabetext 20040629
3 Importing IV_QUEUE_PARAMETERS Call by reference Type reference (TYPE) TREXT_QUEUE_PARAMETERS Queue-Parameter 20040629
4 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination der Suchmaschine 20040629
# Exception Resumable Description Created on
1 CONVERSION_ERROR Fehler bei der Konvertierung nach UTF-8 20040629
2 ERROR Fehler, siehe SYST-Variablen 20040629
History
Last changed by/on SAP  20130531 
SAP Release Created in 300