SAP ABAP Interface IF_ESH_CA_CACHE (Cache)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_CACHE (Package) Cache
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_CACHE (Package) Cache
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_CA_CACHE | Cache | 20091006 |
Properties
| Interface | IF_ESH_CA_CACHE | |
| Short Description | Cache |
General Data
| Package | S_ESH_ENG_CACHE | Cache |
| Created | 20091006 | SAP |
| Last changed | 20130531 | SAP |
| 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 IF_ESH_CA_CACHE has no interface.
Friends
Interface IF_ESH_CA_CACHE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MV_CLIENT_CLASS | Instance attribute | Public | Type reference (TYPE) | E_CLIENT_CLASS | Client class name | 20091010 | ||
| 2 | MV_DATA_CONTAINER_CLASS | Instance attribute | Public | Type reference (TYPE) | E_DATA_CONTAINER_CLASS | Data container class name | 20091010 | ||
| 3 | MV_READ_ONLY_DATA_REF | Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | Boolean: Data references are read-only | 20091117 | ||
| 4 | SC_ALGORITHM_CLEAR | Constant | Public | Type reference (TYPE) | E_CACHE_ALGORITHM | 'CLR' | Cache Algorithm: Clear complete cache storage (CLR) | 20091010 | |
| 5 | SC_ALGORITHM_FIFO | Constant | Public | Type reference (TYPE) | E_CACHE_ALGORITHM | 'FIFO' | Cache Algorithm: First In - First Out (FIFO) | 20091010 | |
| 6 | SC_ALGORITHM_LRU | Constant | Public | Type reference (TYPE) | E_CACHE_ALGORITHM | 'LRU' | Cache Algorithm: Least Recently Used (LRU) | 20091010 | |
| 7 | SC_ALGORITHM_UNLIMITED | Constant | Public | Type reference (TYPE) | E_CACHE_ALGORITHM | 'UNLI' | Cache Algorithm: Unlimited no. of entries/ no autom. removal | 20091010 | |
| 8 | SC_CACHE_HIT_IN_CLIENT_IMPL | Constant | Public | Type reference (TYPE) | E_CACHE_HIT_LOCATION | 'CLNT' | Cache hit in client implementation | 20091023 | |
| 9 | SC_CACHE_HIT_IN_INDEX_DATABASE | Constant | Public | Type reference (TYPE) | E_CACHE_HIT_LOCATION | 'INDX' | Cache hit in index database | 20091023 | |
| 10 | SC_CACHE_HIT_IN_SESSION_MEMORY | Constant | Public | Type reference (TYPE) | E_CACHE_HIT_LOCATION | 'SESS' | Cache hit in session memory | 20091023 | |
| 11 | SC_CACHE_HIT_IN_SHARED_OBJECTS | Constant | Public | Type reference (TYPE) | E_CACHE_HIT_LOCATION | 'SHMA' | Cache hit in shared objects | 20091023 | |
| 12 | SC_MAX_ENTRIES_DEFAULT | Constant | Public | Type reference (TYPE) | I | 500 | Maximum no. of cache entries: default | 20091010 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET |
Instance method | Public | Method | Get data by ID | 20091006 |
| 2 | GET_MULTI |
Instance method | Public | Method | Get data by IDs | 20091006 |
| 3 | INVALIDATE |
Instance method | Public | Method | Invalidate data by ID | 20091006 |
| 4 | INVALIDATE_ALL |
Instance method | Public | Method | Invalidate all data | 20091007 |
| 5 | INVALIDATE_MULTI |
Instance method | Public | Method | Invalidate data by IDs | 20091006 |
| 6 | SET |
Instance method | Public | Method | Set data with ID | 20091006 |
| 7 | SET_MULTI |
Instance method | Public | Method | Set data with IDs | 20091006 |
Events
Interface IF_ESH_CA_CACHE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | E_CACHE_ALGORITHM | Public | See coding | Cache algorithm | 20091010 | e_cache_algorithm TYPE c LENGTH 4
|
|
| 2 | E_CACHE_HIT_LOCATION | Public | See coding | Cache hit location (where data have been found) | 20091023 | e_cache_hit_location TYPE c LENGTH 4
|
|
| 3 | E_CLIENT_CLASS | Public | See coding | Client class name | 20091006 | e_client_class TYPE c LENGTH 30
|
|
| 4 | E_DATA_CONTAINER_CLASS | Public | See coding | Data container class name | 20091010 | e_data_container_class TYPE c LENGTH 30
|
|
| 5 | E_DATA_ID | Public | See coding | Data ID | 20091006 | e_data_id TYPE c LENGTH 120
|
|
| 6 | S_GET_MULTI | Public | See coding | Structure for mass enabled cache readouts | 20091011 | BEGIN OF s_get_multi,
id TYPE e_data_id,
* data_container_read TYPE REF TO if_esh_ca_data_container_read,
data_ref TYPE REF TO data,
cache_hit_location TYPE if_esh_ca_cache=>e_cache_hit_location,
END OF s_get_multi
|
|
| 7 | S_INVALIDATE_MULTI | Public | See coding | Structure for mass enabled cache invalidations | 20091007 | BEGIN OF s_invalidate_multi,
id TYPE e_data_id,
END OF s_invalidate_multi
|
|
| 8 | S_SET_MULTI | Public | See coding | Structure for mass enabled cache updates | 20091011 | BEGIN OF s_set_multi,
id TYPE e_data_id,
data_container TYPE REF TO if_esh_ca_data_container,
END OF s_set_multi
|
|
| 9 | T_GET_MULTI | Public | See coding | Table for mass enabled cache readouts | 20091011 | t_get_multi TYPE HASHED TABLE OF s_get_multi WITH UNIQUE KEY id
|
|
| 10 | T_INVALIDATE_MULTI | Public | See coding | Table for mass enabled cache invalidations | 20091007 | t_invalidate_multi TYPE HASHED TABLE OF s_invalidate_multi WITH UNIQUE KEY id
|
|
| 11 | T_SET_MULTI | Public | See coding | Table for mass enabled cache updates | 20091011 | t_set_multi TYPE HASHED TABLE OF s_set_multi WITH UNIQUE KEY id
|
Method Signatures
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ER_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | Data reference | 20091112 | ||
| 2 | Exporting |
EV_CACHE_HIT_LOCATION | Call by reference | Type reference (TYPE) | E_CACHE_HIT_LOCATION | Cache hit location (where data have been found) | 20091025 | ||
| 3 | Exporting |
E_DATA | Call by reference | Type reference (TYPE) | DATA | Data | 20091007 | ||
| 4 |  Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 | |
| 5 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | E_DATA_ID | Data ID | 20091007 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_CA_DATA_NOT_FOUND |
Data not found | 20091013 |
Method GET_MULTI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_DATA | Call by reference | Type reference (TYPE) | T_GET_MULTI | Table for mass enabled cache readouts | 20091011 | ||
| 2 | Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 |
Method GET_MULTI on Interface IF_ESH_CA_CACHE has no exception.
Method INVALIDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 | |
| 2 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | E_DATA_ID | Data ID | 20091007 |
Method INVALIDATE on Interface IF_ESH_CA_CACHE has no exception.
Method INVALIDATE_ALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 | |
| 2 | Importing |
IV_SYSTEM_CLIENT | Call by reference | Type reference (TYPE) | SYST-MANDT | SY-MANDT | System Client ID | 20091105 |
Method INVALIDATE_ALL on Interface IF_ESH_CA_CACHE has no exception.
Method INVALIDATE_MULTI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_IDS | Call by reference | Type reference (TYPE) | T_INVALIDATE_MULTI | Table for mass enabled cache invalidations | 20091011 | ||
| 2 | Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 |
Method INVALIDATE_MULTI on Interface IF_ESH_CA_CACHE has no exception.
Method SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_DATA_CONTAINER | Call by reference | Object reference (TYPE REF TO) | IF_ESH_CA_DATA_CONTAINER | Data Container of Cache Client | 20091007 | ||
| 2 | Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 | |
| 3 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | E_DATA_ID | Data ID | 20091007 |
Method SET on Interface IF_ESH_CA_CACHE has no exception.
Method SET_MULTI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_DATA | Call by reference | Type reference (TYPE) | T_SET_MULTI | Table for mass enabled cache updates | 20091011 | ||
| 2 | Importing |
IV_DB_COMMIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Execute DB Commit if required and allowed | 20121128 |
Method SET_MULTI on Interface IF_ESH_CA_CACHE has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 730 |
