SAP ABAP Class CL_RMSA_SES_TOOLS (Tools for Search Engine Service)
Hierarchy
☛
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
⤷
PLM-RM (Application Component) Recipe Management
⤷
RMSATLMSC (Package) RMS-ATL: Miscellaneous
⤷
⤷
Properties
| Class | CL_RMSA_SES_TOOLS | |
| Short Description | Tools for Search Engine Service | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | RMSATLMSC | RMS-ATL: Miscellaneous |
| Created | 20061130 | SAP |
| Last change | 20100310 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_RMSA_SES_TOOLS has no interface implemented.
Friends
Class CL_RMSA_SES_TOOLS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Protected | Type reference (TYPE) | CHAR4 | 'GRP_' | Prefix: Attribute Group | 20061204 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Create Values for Attribute Group | 20070112 | |
| 2 | Static method | Public | Method | Add Content | 20061229 | |
| 3 | Static method | Public | Method | Create Generic Attribute Catalog | 20061207 | |
| 4 | Static method | Public | Method | Create Search Query for Attribute Search | 20061207 | |
| 5 | Static method | Public | Method | Create Search Query for Full-Text Search | 20061207 | |
| 6 | Static method | Public | Method | Convert Sap-Script Table into String | 20061214 | |
| 7 | Static method | Public | Method | Get Field Names of Attribute Groups | 20070112 | |
| 8 | Static method | Public | Method | Form Intersection of Search Result and Restriction | 20061218 | |
| 9 | Static method | Public | Method | Convert Attribute Indicator to Attribute Name | 20061207 | |
| 10 | Static method | Public | Method | Modify Buffer For Change Pointer | 20061214 | |
| 11 | Static method | Public | Method | Find Objects | 20061214 |
Events
Class CL_RMSA_SES_TOOLS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_GROUP_FNAME | Public | See coding | Field Names of Attribute Groups | 20070112 | BEGIN OF ty_s_group_fname,
group TYPE com_search_tv_attribute_group,
fieldname TYPE fieldname,
language TYPE flag,
attr_type TYPE trexd_attr_type,
END OF ty_s_group_fname
|
|
| 2 | TY_S_SEARCH_REQUEST | Public | See coding | SearchQuery | 20061207 | BEGIN OF ty_s_search_request,
query_tab TYPE trext_query_entries,
req_attr_tab TYPE trext_attributes,
req_join_attr_tab TYPE trext_join_attributes,
relation TYPE flag,
END OF ty_s_search_request
|
|
| 3 | TY_TS_ATTR | Public | See coding | Table of Attributes | 20061229 | ty_ts_attr TYPE SORTED TABLE OF trexd_attr_name
WITH UNIQUE KEY table_line
|
|
| 4 | TY_TS_FIELDNAME | Public | See coding | Sorted Table: Field Names | 20061207 | ty_ts_fieldname TYPE SORTED TABLE OF fieldname
WITH UNIQUE KEY table_line
|
|
| 5 | TY_TS_GROUP_FNAME | Public | See coding | Sorted Table: Field Names of Attribute Groups | 20070112 | ty_ts_group_fname TYPE SORTED TABLE OF ty_s_group_fname
WITH UNIQUE KEY group fieldname
|
|
| 6 | TY_T_SEARCH_REQUEST | Public | See coding | Table of Search Queries | 20061207 | ty_t_search_request TYPE STANDARD TABLE OF ty_s_search_request
WITH DEFAULT KEY
|
Method Signatures
Method ADD_ATTRIBUTE_GROUP_VALUES_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_ATTRIBUTE_VALUES | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_ATTRIBUTE_VALUE | Tabelle mit Attributwerten zu Objekten | 20070112 | |||
| 2 | IS_DATA | Call by reference | Type reference (TYPE) | ANY | 20070112 | ||||
| 3 | IT_GROUP_FNAMES | Call by reference | Type reference (TYPE) | TY_TS_GROUP_FNAME | Sortierte Tabelle: Feldnamen von Attributgruppen | 20070112 | |||
| 4 | I_ATTRIBUTE_GROUP | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_ATTRIBUTE_GROUP | Attributgruppe | 20070112 | |||
| 5 | I_LANGUAGE | Call by reference | Type reference (TYPE) | LAISO | Sprache nach ISO 639 | 20070112 | |||
| 6 | I_OBJECT_ID | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_OBJECT_ID | Interne Objekt-ID (GUID) im Suchmaschinenservice (SES) | 20070112 | |||
| 7 | I_ROW_COUNTER | Call by reference | Type reference (TYPE) | I | 20070112 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070112 |
Method ADD_CONTENT_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_CONTENT | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_CONTENT | Tabelle mit Content zu Objekten | 20061229 | |||
| 2 | IT_ATTR_VAL | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_ATTRIBUTE_VALUE | Tabelle mit Attributwerten zu Objekten | 20061229 | |||
| 3 | IT_CONTENT_ATTR | Call by reference | Type reference (TYPE) | TY_TS_ATTR | Tabelle mti Atttributen | 20061229 |
Method ADD_CONTENT_CL on class CL_RMSA_SES_TOOLS has no exception.
Method BUILD_ATTRIBUTE_CATALOGUE_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ATTR_NAME | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_ATTRIBUTE_NAME | Tabelle mit Attributtexten | 20061207 | |||
| 2 | IS_ATTRIBUTES | Call by reference | Type reference (TYPE) | ANY | Struktur mit Attributen | 20061207 | |||
| 3 | IT_EXCLUDE | Call by reference | Type reference (TYPE) | TY_TS_FIELDNAME | Sortierte Tabelle: Feldnamen | 20061211 | |||
| 4 | IV_LANGU | Call by reference | Type reference (TYPE) | LAISO | Sprache nach ISO 639 | 20061207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20061207 |
Method BUILD_ATTR_SEARCH_REQUEST_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_SEARCH_REQUEST | Call by reference | Type reference (TYPE) | TY_T_SEARCH_REQUEST | Suchanfragen | 20061207 | |||
| 2 | IS_SEARCH_PARA | Call by reference | Type reference (TYPE) | ANY | Attributwerte | 20061207 | |||
| 3 | IT_FN_EXCLUDE | Call by reference | Type reference (TYPE) | TY_TS_FIELDNAME | Sortierte Tabelle: Feldnamen | 20061207 | |||
| 4 | IT_REQ_ATTR | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Attribute | 20061215 | |||
| 5 | IT_RESULT_RESTRICT | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_RESULT_ITEM | Tabelle mit Objekt-IDs | 20061207 | |||
| 6 | I_FUZZY | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_MODE_FUZZY | Option: Fuzzy-Modus | 20061207 |
Method BUILD_ATTR_SEARCH_REQUEST_CL on class CL_RMSA_SES_TOOLS has no exception.
Method BUILD_FTEXT_SEARCH_REQUEST_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_SEARCH_REQUEST | Call by reference | Type reference (TYPE) | TY_T_SEARCH_REQUEST | 20061207 | ||||
| 2 | IO_INDEXER | Call by reference | Object reference (TYPE REF TO) | OBJECT | RM SES Adapter | 20061207 | |||
| 3 | IT_REQ_ATTR | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Attribute | 20061207 | |||
| 4 | I_FULLTEXT | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_SEARCH_TERM_F4 | Eingabefeld für Volltextsuche | 20061207 | |||
| 5 | I_FUZZY | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_MODE_FUZZY | Option: Fuzzy-Modus | 20061207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20061207 |
Method CONVERT_SAPSCRIPT_TO_STRING_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_STRING | Call by reference | Type reference (TYPE) | STRING | 20061214 | ||||
| 2 | IT_SAPSCRIPT | Call by reference | Type reference (TYPE) | RCPTY_API_TDLINE | RMS-RCP: API - Tabellentyp Langtextzeile | 20061214 | |||
| 3 | I_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | Sprachenschlüssel der aktuellen Textumgebung | 20061229 |
Method CONVERT_SAPSCRIPT_TO_STRING_CL on class CL_RMSA_SES_TOOLS has no exception.
Method GET_FNAMES_OF_ATTR_GROUPS_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_GROUP_FNAMES | Call by reference | Type reference (TYPE) | TY_TS_GROUP_FNAME | Sortierte Tabelle: Feldnamen von Attributgruppen | 20070112 | |||
| 2 | IT_ATTRIBUTE_NAMES | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_ATTRIBUTE_NAME | Tabelle mit Attributtexten | 20070112 |
Method GET_FNAMES_OF_ATTR_GROUPS_CL on class CL_RMSA_SES_TOOLS has no exception.
Method INTERSECT_OBJECT_ID_TABS_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_INTERSECTION | Call by reference | Type reference (TYPE) | STANDARD TABLE | Suchergebnisliste | 20061218 | |||
| 2 | IT_TAB1 | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20061218 | ||||
| 3 | IT_TAB2 | Call by reference | Type reference (TYPE) | STANDARD TABLE | Suchergebnisliste | 20061218 | |||
| 4 | I_FN_OBJ_ID1 | Call by reference | Type reference (TYPE) | FIELDNAME | 'OBJECT_ID' | Feldname | 20061218 | ||
| 5 | I_FN_OBJ_ID2 | Call by reference | Type reference (TYPE) | FIELDNAME | 'OBJECT_ID' | Feldname | 20061218 | ||
| 6 | I_TAB_TYPE_RESULT | Call by reference | Type reference (TYPE) | I | 2 | Typ des Ergebnisses ('1'/'2') | 20061218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20061218 |
Method MAP_REQUESTED_ATTRIBUTES_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_REQ_ATTR | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Attribute | 20061207 | |||
| 2 | IO_INDEXER | Call by reference | Object reference (TYPE REF TO) | OBJECT | Objekt-Interface für Suchmaschinenservice (SES) | 20061207 | |||
| 3 | IS_REQ_ATTR | Call by reference | Type reference (TYPE) | ANY | 20061207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20061207 |
Method MODIFY_CPOINTER_BUFFER_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_CPOINTER | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_CPOINTER_DATA | Netto-Daten für SES-Objektänderungszeiger | 20061214 | |||
| 2 | I_BUSOBJ | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_BUSOBJ | Business-Objekt für Suchmaschinenservice (SES) | 20061214 | |||
| 3 | I_LINEMODE | Call by reference | Type reference (TYPE) | C | 20061214 | ||||
| 4 | I_OBJECT_ID | Call by reference | Type reference (TYPE) | ANY | 20061214 | ||||
| 5 | I_OBJECT_TYPE | Call by reference | Type reference (TYPE) | COM_SEARCH_TV_OBJECT_TYPE | Typ des Business-Objekts | 20061214 |
Method MODIFY_CPOINTER_BUFFER_CL on class CL_RMSA_SES_TOOLS has no exception.
Method SEARCH_OBJECTS_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_INDEX_INFOS | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_INDEX_LIST_OBJTY | Index-IDs für Objekttypen in Tabelle COM_SE_BUSOBJTY | 20061214 | |||
| 2 | ET_RESULT_ITEMS | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_RESULT_ITEM | Suchergebnisliste | 20061214 | |||
| 3 | EV_AUTH_CHECK_IS_COMPLETE | Call by reference | Type reference (TYPE) | BOOLE_D | X = Alle Suchmaschinen-Treffer wurden auf Berechtig. geprüft | 20061214 | |||
| 4 | EV_COMPONENT_RUNTIME | Call by reference | Type reference (TYPE) | TREXS_COMPONENT_RUNTIME | Laufzeit der Suchmaschine | 20061214 | |||
| 5 | EV_RETURN_CODE | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_CODE | Returncode der Suchmaschine | 20061214 | |||
| 6 | EV_RETURN_TEXT | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_TEXT | Returntext der Suchmaschine | 20061214 | |||
| 7 | EV_RUN_TIME_BO | Call by reference | Type reference (TYPE) | I | Laufzeit des Business-Objekts pro Treffer | 20061214 | |||
| 8 | EV_RUN_TIME_SE | Call by reference | Type reference (TYPE) | I | Laufzeit der Suchmaschine, komplett | 20061214 | |||
| 9 | IT_OBJECT_TYPE | Call by reference | Type reference (TYPE) | COM_SEARCH_TT_OBJECT_TYPE_KEY | Liste der Objekttypen, in denen gesucht wird | 20061214 | |||
| 10 | IT_QUERY_ENTRIES | Call by reference | Type reference (TYPE) | TREXT_QUERY_ENTRIES | Suchanfrage | 20061214 | |||
| 11 | IT_REQUESTED_LANGUAGES | Call by reference | Type reference (TYPE) | TREXT_LANGUAGES | Languages range list (for output) | 20061214 | |||
| 12 | IT_REQ_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | angeforderte Attribute | 20061214 | |||
| 13 | IT_REQ_JOIN_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_JOIN_ATTRIBUTES | Attributes with indexId and join path | 20061214 | |||
| 14 | IT_SORT_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_SORT_ATTRIBUTES | Sortierattribute | 20061214 | |||
| 15 | IV_AUTH_CHECK_LIMIT | Call by reference | Type reference (TYPE) | I | Maximale Anzahl von Objekten bei Berechtigungsprüfung | 20061214 | |||
| 16 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | LAISO | Sprache der Suchanfrage | 20061214 | |||
| 17 | IV_REQUESTED_RESULTS | Call by reference | Type reference (TYPE) | TREX_RFC-REQUESTED_RESULTS | 1 | Requested Results: 1 = docs, 8 = hit attrs / doc, 9 = both | 20061214 | ||
| 18 | IV_REQUEST_FLAGS | Call by reference | Type reference (TYPE) | TREX_RFC-REQUEST_FLAG | 0 | Anfrage-Kennzeichen, Semantik: 256 = distinct | 20061214 | ||
| 19 | IV_SEARCH_BY_RELATION | Call by reference | Type reference (TYPE) | COM_SE_TV_SEARCH_BY_REL | X = Suche nach Beziehung | 20061214 | |||
| 20 | I_FLG_ALL_HITS | Call by reference | Type reference (TYPE) | FLAG | Alle Treffer anfordern | 20061214 | |||
| 21 | I_NO_OF_HITS | Call by reference | Type reference (TYPE) | DDSHMAXREC | 20061214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Business-Objekt wird von aktueller Klasse nicht unterstützt | 20061214 | ||
| 2 | Fehler bei der Konvertierung nach UTF-8 | 20061214 | ||
| 3 | Fehler, siehe SYST-Variablen | 20061214 | ||
| 4 | Index-ID unbekannt | 20061214 | ||
| 5 | Interner Fehler | 20061214 | ||
| 6 | Fehler beim Zugriff auf die Suchmaschine | 20061214 |
History
| Last changed by/on | SAP | 20100310 |
| SAP Release Created in | 700 |