SAP ABAP Interface /UI2/IF_CACHE_SUPPORT (Enable service to do its own cache handling)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/CACHE (Package) UI BE: Cache mechanism for OData services
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-INT-BE (Application Component) Backend Enablement⤷
/UI2/CACHE (Package) UI BE: Cache mechanism for OData services
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_CACHE_SUPPORT | Default cache support class | 20121210 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_EDM_DP_V06_PB | EDM Data Provider: Pagebuilder v0.6 (WD config) | 20130311 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_POWL_FLIGHT_CACHE | Implements cache support for POWL flight service | 20120427 |
Properties
| Interface | /UI2/IF_CACHE_SUPPORT | |
| Short Description | Enable service to do its own cache handling |
General Data
| Package | /UI2/CACHE | UI BE: Cache mechanism for OData services |
| Created | 20120425 | SAP |
| Last changed | 20141120 | |
| 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) |
Interfaces
Interface /UI2/IF_CACHE_SUPPORT has no interface.
Friends
Interface /UI2/IF_CACHE_SUPPORT has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ACTION_DELETE_CACHE | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'DeleteCache' | Action name for cache deletion | 20130225 | |
| 2 | GC_ACTION_REFRESH_CACHE_NAME | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'RefreshCache' | Action name for cache refresh | 20130104 | |
| 3 | GC_ALL_CLIENTS | Constant | Public | Type reference (TYPE) | SY-MANDT | 'ALL' | All clients | 20130808 | |
| 4 | GC_ALL_USERS | Constant | Public | Type reference (TYPE) | SY-UNAME | 'ALL' | All users | 20130903 | |
| 5 | GC_CACHE_ONE_BLOB | Constant | Public | Type reference (TYPE) | STRING | '1-BLOB' | Store complete request in one blob | 20140128 | |
| 6 | GC_CACHE_SUPPORTED | Constant | Public | Type reference (TYPE) | STRING | 'CACHE_SUPPORTED' | Cache is supported for entity or entity set | 20130213 | |
| 7 | GC_CACHE_SUPPORTED_ONE_BLOB | Constant | Public | Type reference (TYPE) | STRING | 'CACHE_SUPPORTED_ONE_BLOB' | Complete request is cached as one BLOB | 20140117 | |
| 8 | GC_CTYPE_DELETE_CACHE | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'DeleteCacheResult' | Name of complex type for action delete cache | 20130227 | |
| 9 | GC_CTYPE_DELETE_CACHE_STRU | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | '/UI2/CACHE_DEL_RETURN_TYPE' | DDIC structure containing result of cache deletion | 20130228 | |
| 10 | GC_CTYPE_PARAM_ENTITY_SET | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'entitySet' | OData name of complex type parameter entity set | 20130227 | |
| 11 | GC_CTYPE_PARAM_ENTITY_SET_DDIC | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'ENTITY_SET' | Component name of complex type parameter entity set | 20130228 | |
| 12 | GC_CTYPE_PARAM_TIME_STAMP | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'timeStamp' | OData name of complex type parameter time stamp | 20130227 | |
| 13 | GC_CTYPE_PARAM_TIME_STAMP_DDIC | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'TIME_STAMP' | Component name of complex type parameter time stamp | 20130228 | |
| 14 | GC_FILTER_SUPPORTED | Constant | Public | Type reference (TYPE) | STRING | 'FILTER_SUPPORTED' | Filtering ($filter) is supported by application (X = true) | 20130213 | |
| 15 | GC_GENERIC_ENTITY_NAME | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'GenericEntity' | Name for generic entity | 20130104 | |
| 16 | GC_LPD_CHANGE | Constant | Public | Type reference (TYPE) | /UI2/SECONDARY_CACHE_KEY | 'LPD_CHANGE' | A launchpad was changed | 20131121 | |
| 17 | GC_MAX_CACHE_AGE | Constant | Public | Type reference (TYPE) | /UI2/MAX_CACHE_AGE | -1 | Maximum cache age (-1 = outdated cache) | 20121228 | |
| 18 | GC_PAGING_SUPPORTED | Constant | Public | Type reference (TYPE) | STRING | 'PAGING_SUPPORTED' | Paging ($skip, $top) is supported by application (X = true) | 20130213 | |
| 19 | GC_PARAM_ENTITY_SET_NAME | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'entitySet' | OData action parameter name 'entitySet' | 20130104 | |
| 20 | GC_PARAM_ENTITY_SET_NAME_DDIC | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | '/UI2/ENTITY_SET' | Component name for parameter 'entitySet' | 20130313 | |
| 21 | GC_PARAM_MAX_CACHE_AGE_DDIC | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | '/UI2/MAX_CACHE_AGE' | Component name for parameter 'maxCacheAge' | 20130228 | |
| 22 | GC_PARAM_MAX_CACHE_AGE_NAME | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'maxCacheAge' | OData action parameter name 'maxCacheAge' | 20130104 | |
| 23 | GC_PARAM_REFRESH_CACHE | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | 'refreshCache' | Action parameter name 'refreshCache' | 20130225 | |
| 24 | GC_PARAM_REFRESH_CACHE_DDIC | Constant | Public | Type reference (TYPE) | /IWBEP/MED_EXTERNAL_NAME | '/UI2/CACHE_REFRESH' | Component name for parameter 'refreshCache' | 20130228 | |
| 25 | GC_ROLE_CHANGE | Constant | Public | Type reference (TYPE) | /UI2/SECONDARY_CACHE_KEY | 'ROLE_CHANGE' | One of PFCG roles was changed | 20130808 | |
| 26 | GC_SORT_SUPPORTED | Constant | Public | Type reference (TYPE) | STRING | 'SORT_SUPPORTED' | Sort ($orderby) is supported by application (X = true) | 20130213 | |
| 27 | GC_SQO_FILTER | Constant | Public | Type reference (TYPE) | STRING | '$filter' | System query option $filter | 20130212 | |
| 28 | GC_SQO_ORDERBY | Constant | Public | Type reference (TYPE) | STRING | '$orderby' | System query option $orderby | 20130212 | |
| 29 | GC_SQO_SKIP | Constant | Public | Type reference (TYPE) | STRING | '$skip' | System query option $skip | 20130212 | |
| 30 | GC_SQO_TOP | Constant | Public | Type reference (TYPE) | STRING | '$top' | System query option $top | 20130212 | |
| 31 | GC_URI_DUMMY | Constant | Public | Type reference (TYPE) | /UI2/CACHE_ID-URL | 'dummy' | Dummy cache key | 20130313 | |
| 32 | GS_CACHE_SUPPORT | Instance attribute | Public | Type reference (TYPE) | /UI2/CACHE_SUP | Cache support per service | 20130122 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_CACHE_PAR |
Instance method | Public | Method | Get service-specific cache parameters | 20120425 |
| 2 | GET_DATADESCR |
Instance method | Public | Method | Get service-specific data types | 20120426 |
| 3 | GET_SECONDARY_CACHE_KEY |
Instance method | Public | Method | Get secondary cache key from data provider | 20130308 |
| 4 | IS_CACHE_ACTIVE |
Instance method | Public | Method | Check if cache is active | 20120427 |
Events
Interface /UI2/IF_CACHE_SUPPORT has no event.
Types
Interface /UI2/IF_CACHE_SUPPORT has no local type.
Method Signatures
Method GET_CACHE_PAR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_FIELDS | Call by reference | Object reference (TYPE REF TO) | /UI2/CL_GW_DP_REQUEST_FIELDS | UI2 Gateway data provider http request fields | 20120425 | ||
| 2 | Importing |
IV_URI | Call by reference | Type reference (TYPE) | STRING | Service URL | 20120425 | ||
| 3 |  Returning |
RV_PAR | Value transfer | Type reference (TYPE) | STRING | Parameters to be added to the cache | 20121205 |
Method GET_CACHE_PAR on Interface /UI2/IF_CACHE_SUPPORT has no exception.
Method GET_DATADESCR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Name of data component | 20120426 | ||
| 2 | Importing |
IV_URI | Call by reference | Type reference (TYPE) | STRING | URL | 20120426 | ||
| 3 | Returning |
RO_DATADESCR | Value transfer | Object reference (TYPE REF TO) | CL_ABAP_DATADESCR | Runtime Type Services | 20120426 |
Method GET_DATADESCR on Interface /UI2/IF_CACHE_SUPPORT has no exception.
Method GET_SECONDARY_CACHE_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ENTITY_NAME | Call by reference | Type reference (TYPE) | STRING | 20130311 | |||
| 2 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | /UI2/SECONDARY_CACHE_KEY | Secondary cache key used for server-side cache invalidation) | 20130308 |
Method GET_SECONDARY_CACHE_KEY on Interface /UI2/IF_CACHE_SUPPORT has no exception.
Method IS_CACHE_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' = cache is active | 20120427 |
Method IS_CACHE_ACTIVE on Interface /UI2/IF_CACHE_SUPPORT has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |
