SAP ABAP Class CL_ESH_OS_UTILITY (OpenSearch Utility)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_IF_OPEN_SEARCH (Package) Open Search Service
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_IF_OPEN_SEARCH (Package) Open Search ServiceProperties
| Class | CL_ESH_OS_UTILITY | |
| Short Description | OpenSearch Utility | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_IF_OPEN_SEARCH | Open Search Service |
| Created | 20081023 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | CL_ABAP_CHAR_UTILITIES |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ESH_OS_UTILITY has no interface implemented.
Friends
Class CL_ESH_OS_UTILITY has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_CATEGORY_SCOPE |
Constant | Public | Type reference (TYPE) | STRING | 'category' | Scope - category | 20081104 | |
| 2 | CV_CONNECTOR_SCOPE |
Constant | Public | Type reference (TYPE) | STRING | 'connector' | Scope - connector | 20081104 | |
| 3 | CV_DESCRIPTION_PATH |
Constant | Private | Type reference (TYPE) | STRING | '/sap/es/opensearch/description' | Description path | 20081023 | |
| 4 | CV_ES_NAMESPACE |
Constant | Public | Type reference (TYPE) | STRING | 'http://sap.com/EnterpriseSearch' | Enterprise Search namespace | 20081027 | |
| 5 | CV_ES_NS_PREFIX |
Constant | Public | Type reference (TYPE) | STRING | 'sap_es' | Enterprise Search prefix | 20081209 | |
| 6 | CV_LF |
Constant | Public | Type reference (TYPE) | CHAR2 | CL_ABAP_CHAR_UTILITIES=>CR_LF | Version number component | 20081023 | |
| 7 | CV_LIST_PATH |
Constant | Private | Type reference (TYPE) | STRING | '/sap/es/opensearch/list' | List path | 20081023 | |
| 8 | CV_NAMESPACE |
Constant | Public | Type reference (TYPE) | STRING | 'xmlns:sap_es="http://sap.com/EnterpriseSearch"' | Enterprise Search namespace | 20081209 | |
| 9 | CV_REFINE_TYPE_ATTR |
Constant | Public | Type reference (TYPE) | STRING | 'attributeValue' | Refinement type Attribute | 20100929 | |
| 10 | CV_REFINE_TYPE_RANGE |
Constant | Public | Type reference (TYPE) | STRING | 'attributeRange' | Refinement type Range | 20100929 | |
| 11 | CV_REQUEST_TYPE_SCOPE |
Constant | Public | Type reference (TYPE) | STRING | 'request_type' | Scope - request type | 20081104 | |
| 12 | CV_SEARCH_PATH |
Constant | Private | Type reference (TYPE) | STRING | '/sap/es/opensearch/search' | Search path | 20081023 | |
| 13 | CV_SEARCH_PATH_HTML5_UI |
Constant | Private | Type reference (TYPE) | STRING | '/sap/es/ina/Loader/sap/bc/ina/apps/suite/search.html' | Search path of html5 search UI | 20130412 | |
| 14 | CV_SEARCH_PATH_UI |
Constant | Private | Type reference (TYPE) | STRING | '/sap/es/search' | Search path of Search UI | 20081112 | |
| 15 | CV_TEMPLATE_SCOPE |
Constant | Public | Type reference (TYPE) | STRING | 'template' | Scope - template | 20081104 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | DOM_TO_STRING |
Static method | Public | Method | Convert XML DOM to string | 20081210 |
| 2 | GET_BASE_URL |
Static method | Public | Method | Get base URL | 20081023 |
| 3 | GET_DESCRIPTION_URL |
Static method | Public | Method | Get description URL | 20081023 |
| 4 | GET_LIST_URL |
Static method | Public | Method | Get list URL | 20081023 |
| 5 | GET_RFC822_TIMESTAMP |
Static method | Public | Method | Get timestamp that conforms RFC822 | 20090513 |
| 6 | GET_SEARCH_URL |
Static method | Public | Method | Get search URL | 20081023 |
Events
Class CL_ESH_OS_UTILITY has no event.
Types
Class CL_ESH_OS_UTILITY has no local type.
Method Signatures
Method DOM_TO_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_DOM | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | IF_IXML_DOCUMENT | 20081210 | ||
| 2 | Importing |
IR_IXML | Call by reference | Object reference (TYPE REF TO) | IF_IXML | IF_IXML | 20081210 | ||
| 3 | Importing |
IV_ENCODING | Call by reference | Type reference (TYPE) | STRING | 20081210 | |||
| 4 |  Exporting |
RV_XML | Call by reference | Type reference (TYPE) | STRING | 20081210 | |||
| 5 | Exporting |
RV_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | 20100118 |
Method DOM_TO_STRING on class CL_ESH_OS_UTILITY has no exception.
Method GET_BASE_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | STRING | 20081023 |
Method GET_BASE_URL on class CL_ESH_OS_UTILITY has no exception.
Method GET_DESCRIPTION_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CATEGORY_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_CATEGORY_ID | Category ID | 20090213 | ||
| 2 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20090213 | ||
| 3 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | STRING | 20081023 |
Method GET_DESCRIPTION_URL on class CL_ESH_OS_UTILITY has no exception.
Method GET_LIST_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | STRING | 20081023 |
Method GET_LIST_URL on class CL_ESH_OS_UTILITY has no exception.
Method GET_RFC822_TIMESTAMP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20090513 | ||
| 2 | Returning |
RV_TIMESTAMP | Value transfer | Type reference (TYPE) | STRING | 20090513 |
Method GET_RFC822_TIMESTAMP on class CL_ESH_OS_UTILITY has no exception.
Method GET_SEARCH_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FOR_HTML5_UI | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20130412 | ||
| 2 | Importing |
IV_FOR_SEARCH_UI | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20081112 | ||
| 3 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | STRING | 20081023 |
Method GET_SEARCH_URL on class CL_ESH_OS_UTILITY has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 720 |
