SAP ABAP Class CL_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) CacheMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ESH_CA_CACHE | Cache | 20091006 |
Properties
| Class | CL_ESH_CA_CACHE | |
| Short Description | Cache | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_CACHE | Cache |
| Created | 20091005 | SAP |
| Last change | 20110908 | 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 | IF_ESH_CA_CACHE |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | IF_ESH_CA_CACHE_STORAGE |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ESH_CA_CACHE | Cache | 20091006 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_CA_SHARED_OBJECTS | 20091023 | Cache Storage: Shared Objects |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MR_STORAGE |
Instance attribute | Protected | Object reference (TYPE REF TO) | S_STORAGE | 20091011 | |||
| 2 | MT_STORAGES |
Instance attribute | Protected | Type reference (TYPE) | T_STORAGES | Cache storages | 20091010 | ||
| 3 | SC_COMMIT_ALLOWED |
Static Attribute | Protected | Type reference (TYPE) | ABAP_BOOL | ABAP_UNDEFINED | Commit allowed in current transaction | 20091023 | |
| 4 | SR_CACHE |
Static Attribute | Protected | Type reference (TYPE) | R_CACHE | Reference to cache instance | 20091005 | ||
| 5 | ST_CACHES |
Static Attribute | Protected | Type reference (TYPE) | T_CACHES | Cache instances | 20091005 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Protected | Constructor | Constructor | 20091005 |
| 2 | FREE_INSTANCE |
Static method | Public | Method | Free instance | 20091005 |
| 3 | GET_INSTANCE |
Static method | Public | Method | Get instance | 20091005 |
Events
Class CL_ESH_CA_CACHE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | R_CACHE | Protected | Object reference (TYPE REF TO) | S_CACHE | Reference to cache instance | 20091005 | |
| 2 | S_CACHE | Protected | See coding | Cache instance | 20091005 | BEGIN OF s_cache,
client_class TYPE if_esh_ca_cache=>e_client_class,
cache_instance TYPE REF TO if_esh_ca_cache,
END OF s_cache
|
|
| 3 | S_STORAGE | Protected | See coding | Cache storage | 20091010 | BEGIN OF s_storage,
read_order TYPE int2,
write_order TYPE int2, "important: must contain the row number of table key write_order
read TYPE abap_bool,
write TYPE abap_bool,
instance TYPE REF TO if_esh_ca_cache_storage,
settings TYPE REF TO if_esh_ca_cache_storage=>s_settings,
location_type TYPE if_esh_ca_cache=>e_cache_hit_location,
propagation_table TYPE REF TO if_esh_ca_cache=>t_set_multi,
END OF s_storage
|
|
| 4 | T_CACHES | Protected | See coding | Cache instances | 20091005 | t_caches TYPE HASHED TABLE OF s_cache
WITH UNIQUE KEY client_class
|
|
| 5 | T_STORAGES | Protected | See coding | Cache storages | 20091010 | t_storages TYPE SORTED TABLE OF s_storage
WITH UNIQUE KEY read_order
WITH UNIQUE SORTED KEY write_order COMPONENTS write_order
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_CLIENT_CLASS | Call by reference | Type reference (TYPE) | IF_ESH_CA_CACHE=>E_CLIENT_CLASS | 20091006 |
Method CONSTRUCTOR on class CL_ESH_CA_CACHE has no exception.
Method FREE_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CLIENT_CLASS | Call by reference | Type reference (TYPE) | IF_ESH_CA_CACHE=>E_CLIENT_CLASS | Client class name | 20091006 |
Method FREE_INSTANCE on class CL_ESH_CA_CACHE has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CLIENT_CLASS | Call by reference | Type reference (TYPE) | IF_ESH_CA_CACHE=>E_CLIENT_CLASS | Client class name | 20091006 | ||
| 2 |  Returning |
RO_CACHE | Value transfer | Object reference (TYPE REF TO) | IF_ESH_CA_CACHE | Cache | 20091005 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_CA_CACHE_EXCEPTION |
General Cache Exception | 20091013 | |
| 2 | CX_ESH_CA_CLIENT_EXCEPTION |
Cache client exception | 20091013 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 730 |
