SAP ABAP Class CBN_CL_ES_GW_ADAPTER_D (ES Model based OData Model)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-AR-BE (Application Component) SAP UI Integration - Application Reuse - Backend Enabl.
⤷
S_CBN_ODATA_ADPT_ES_GW (Package) CestBON Enterprise Search Adapter for OData in Gateway
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | /IWBEP/CL_MGW_ABS_DATA | Abstract Business Data Provider | 20130808 |
Meta Relationship - Used By
Properties
| Class | CBN_CL_ES_GW_ADAPTER_D | |
| Short Description | ES Model based OData Model | |
| Super Class | /IWBEP/CL_MGW_ABS_DATA | Abstract Business Data Provider |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_CBN_ODATA_ADPT_ES_GW | CestBON Enterprise Search Adapter for OData in Gateway |
| Created | 20130808 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CBN_CL_ES_GW_ADAPTER_D has no interface implemented.
Friends
Class CBN_CL_ES_GW_ADAPTER_D has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Object reference (TYPE REF TO) | /IWBEP/CL_COS_LOGGER | 20130808 | ||||
| 2 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSE | Search Response | 20131202 | |||
| 3 | Static Attribute | Private | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | Technical name-value pairs | 20131202 | |||
| 4 | Static Attribute | Private | Type reference (TYPE) | /IWBEP/MGW_TECH_NAME | Technical name | 20131202 | |||
| 5 | Instance attribute | Public | Type reference (TYPE) | BALMSGHNDL | 20130808 | ||||
| 6 | Instance attribute | Public | Type reference (TYPE) | ESH_E_IF_TEMPLATE_ID | 20130808 | ||||
| 7 | Static Attribute | Private | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20131202 |
Methods
Events
Class CBN_CL_ES_GW_ADAPTER_D has no event.
Types
Class CBN_CL_ES_GW_ADAPTER_D has no local type.
Method Signatures
Method ADD_FILTER_CITERIA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_SEARCH_REQ | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | 20130808 | ||||
| 2 | IT_ATTRIBUTE_MAP | Call by reference | Type reference (TYPE) | CBN_CL_ES_ENTITY=>LTTY_ATTR_MAP | 20130808 | ||||
| 3 | IT_SELECT_OPTION | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_SELECT_OPTION | 20130808 |
Method ADD_FILTER_CITERIA on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method ADD_KEY_CITERIA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_NONE_KEY | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | 20130808 | ||||
| 2 | IO_SEARCH_REQ | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | 20130808 | ||||
| 3 | IS_DATA | Call by reference | Type reference (TYPE) | DATA | 20130808 | ||||
| 4 | IT_ATTRIBUTE_MAP | Call by reference | Type reference (TYPE) | CBN_CL_ES_ENTITY=>LTTY_ATTR_MAP | 20130808 | ||||
| 5 | IT_KEY | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | 20130808 | ||||
| 6 | IV_LOG_CALL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20140604 |
Method ADD_KEY_CITERIA on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method ADD_SORTING_ORDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_SEARCH_REQ | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | 20131009 | ||||
| 2 | IT_ATTRIBUTE_MAP | Call by reference | Type reference (TYPE) | CBN_CL_ES_ENTITY=>LTTY_ATTR_MAP | 20140206 | ||||
| 3 | IT_TECH_ORDER | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_ORDER | the sorting order | 20131009 |
Method ADD_SORTING_ORDER on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method CHECK_CONNECTOR_AUTHORITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20131009 | |||
| 2 | IV_ENTITY_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MGW_TECH_NAME | Technical name | 20131009 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CestBon: business exception class | 20140214 |
Method CONTROL_CACHE Signature
Method CONTROL_CACHE on class CBN_CL_ES_GW_ADAPTER_D has no parameter.
Method CONTROL_CACHE on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method CREATE_TECH_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENTITY_NAME | Call by reference | Type reference (TYPE) | STRING | 20130808 | ||||
| 2 | IV_LOG_MESSAGE | Call by reference | Type reference (TYPE) | STRING | 20130808 | ||||
| 3 | IV_MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | 20130808 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130808 |
Method FINALIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENTITY_NAME | Call by reference | Type reference (TYPE) | STRING | 20130808 | ||||
| 2 | IV_OPERATION_NAME | Call by reference | Type reference (TYPE) | CHAR10 | 20130808 | ||||
| 3 | IX_EXCEPTION | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | 20130808 |
Method FINALIZE on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method GET_DATA_STRUCTURE_BY_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TECH_ENTITY_TYPE | Call by reference | Type reference (TYPE) | CBN_MGW_TECH_NAME | Technical name | 20130914 | |||
| 2 | RO_DATA_STRUCTURE | Value transfer | Object reference (TYPE REF TO) | DATA | 20130914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Technical Exception | 20130914 |
Method GET_DATA_TABLE_BY_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TECH_ENTITY_TYPE | Call by reference | Type reference (TYPE) | CBN_MGW_TECH_NAME | Technical name | 20130914 | |||
| 2 | RO_DATA_TABLE | Value transfer | Object reference (TYPE REF TO) | DATA | 20130914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Technical Exception | 20130914 |
Method GET_SINGLE_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_RESULT | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESULT | Search Result | 20131202 | |||
| 2 | IO_TECH_REQ_CONTEXT_ENT | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_REQ_ENTITY | Request Details for Entity Read Operation | 20131202 | |||
| 3 | IO_TECH_REQ_CONTEXT_ENT_SET | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_REQ_ENTITYSET | Request Details for Read Feed | 20131202 | |||
| 4 | IS_ENTITY | Call by reference | Type reference (TYPE) | CBN_CL_ES_MODEL=>LSTY_ENTITY | 20131202 | ||||
| 5 | IT_KEY | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | Technical name-value pairs | 20131202 | |||
| 6 | IT_SOURCE_KEY | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | Technical name-value pairs | 20131202 | |||
| 7 | IV_LOG_CALL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20140604 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Technical Exception | 20131202 |
Method GET_SINGLE_RESULT_FROM_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_RESULT | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESULT | Search Result | 20131202 | |||
| 2 | IT_KEY | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | Technical name-value pairs | 20131202 | |||
| 3 | IV_ENTITY_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MGW_TECH_NAME | Technical name | 20131202 |
Method GET_SINGLE_RESULT_FROM_CACHE on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_OPERATION_NAME | Call by reference | Type reference (TYPE) | CHAR10 | 20130808 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130808 |
Method LOG_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | 20130808 | ||||
| 2 | IV_MSGTEXT | Call by reference | Type reference (TYPE) | STRING | 20130808 | ||||
| 3 | IV_MSGTYP | Call by reference | Type reference (TYPE) | SYMSGTY | 20130808 |
Method LOG_MESSAGE on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method PROVIDE_DEFAULT_SORTING_ORDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_TECH_REQUEST_CONTEXT | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_REQ_ENTITYSET | Request Details for Entity Read Operation | 20131009 | |||
| 2 | RT_TECH_ORDER | Value transfer | Type reference (TYPE) | /IWBEP/T_MGW_TECH_ORDER | the sorting order | 20131009 |
Method PROVIDE_DEFAULT_SORTING_ORDER on class CBN_CL_ES_GW_ADAPTER_D has no exception.
Method SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_ENTITYSET | Call by reference | Object reference (TYPE REF TO) | DATA | 20130808 | ||||
| 2 | ES_RESPONSE_CONTEXT | Call by reference | Type reference (TYPE) | /IWBEP/IF_MGW_APPL_SRV_RUNTIME=>TY_S_MGW_RESPONSE_CONTEXT | 20130808 | ||||
| 3 | IO_SEARCH_REQ | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | 20130808 | ||||
| 4 | IO_TECH_REQUEST_CONTEXT | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_REQ_ENTITYSET | 20130808 | ||||
| 5 | IR_LINE_TYPE | Call by reference | Object reference (TYPE REF TO) | DATA | 20130808 | ||||
| 6 | IV_ENTITY_NAME | Call by reference | Type reference (TYPE) | STRING | 20130808 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130808 |
Method SEARCH_SINGLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_ENTITY | Call by reference | Object reference (TYPE REF TO) | DATA | 20130808 | ||||
| 2 | IO_SEARCH_REQ | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | 20130808 | ||||
| 3 | IT_NONE_KEY | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_TECH_PAIRS | 20130808 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130808 |
Meta Relationship - Used By (full list)
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 740 |