SAP ABAP Class /UI2/CL_CACHE_HELPER (Cache utilities)

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

Properties

Class	/UI2/CL_CACHE_HELPER
Short Description	Cache utilities
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	/UI2/CACHE	UI BE: Cache mechanism for OData services
Created	20121218	SAP
Last change	20141120
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)

Interfaces

Class /UI2/CL_CACHE_HELPER has no interface implemented.

Friends

Class /UI2/CL_CACHE_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_PARAM_ORDERBY_ASC	Constant	Protected	☐	Type reference (TYPE)	STRING	'asc'	OData $orderby ascending	20121219
2	GC_PARAM_ORDERBY_DESC	Constant	Protected	☐	Type reference (TYPE)	STRING	'desc'	OData $orderby descending	20121219
3	MO_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/UI2/CL_CACHE_HELPER		Cache utilities	20121218
4	MV_ENTITY_SET_NAME	Static Attribute	Private	☐	Type reference (TYPE)	/IWBEP/MGW_TECH_NAME		Entity set name	20130103
5	MV_FILTER_FLAG	Instance attribute	Protected	☐	Type reference (TYPE)	/UI2/FILTER_FLAG		Filtering ($filter) is supported by application (X = true)	20130123
6	MV_PAGING_FLAG	Instance attribute	Protected	☐	Type reference (TYPE)	/UI2/PAGING_FLAG		Paging ($skip, $top) is supported by application (X = true)	20130123
7	MV_SERVICE_NAME	Static Attribute	Private	☐	Type reference (TYPE)	/UI2/SERVICE_NAME		Service name	20130103
8	MV_SORT_FLAG	Instance attribute	Protected	☐	Type reference (TYPE)	/UI2/SORT_FLAG		Sort ($orderby) is supported by application (X = true)	20130123

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_CACHE_KEY	Instance method	Public	Method	Build cache key from URL	20121218
2	BUILD_CACHE_KEY_HASHED	Instance method	Public	Method	Build cache key (hash out of Gateway request)	20130213
3	BUILD_CACHE_KEY_SEMANTIC	Instance method	Public	Method	Build semantic key corresponding to hash key	20130301
4	FILTER_WITH_SEL_OPTIONS	Instance method	Protected	Method	Perform filtering using ABAP select options	20121218
5	GET_CACHE_SUPPORT_CLASS	Instance method	Public	Method	Get cache support class for a given service	20121218
6	GET_INSTANCE	Static method	Public	Method	Get singleton instance (given gateway data provider)	20121218
7	GET_SERVICE_NAME	Static method	Public	Method	Get service name	20130103
8	GET_SINGLETON	Static method	Public	Method	Get singleton instance (general)	20131211
9	PAGING	Instance method	Protected	Method	Perform paging	20130123
10	POST_PROCESS_DATA	Instance method	Public	Method	Perform filtering, sorting, paging etc on cached data	20121218
11	SET_FLAGS	Instance method	Public	Method	Set flags controlling filtering, sorting, paging	20130123
12	SORTING	Instance method	Protected	Method	Perform sorting	20130123

Events

Class /UI2/CL_CACHE_HELPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TTY_ABAP_SEL_OPTION	Protected	See coding			20121219	tty_abap_sel_option type standard table of ty_abap_sel_option with default key
2	TTY_FILTER_SEL_OPTION	Protected	See coding			20121219	tty_filter_sel_option type standard table of ty_filter_sel_option with key property
3	TTY_ORDER_BY	Protected	See coding			20121219	tty_order_by type standard table of ty_order_by with key property
4	TY_ABAP_SEL_OPTION	Protected	See coding			20121219	begin of ty_abap_sel_option, sign type ddsign, option type ddoption, low type string, high type string, end of ty_abap_sel_option
5	TY_FILTER_SEL_OPTION	Protected	See coding			20121219	begin of ty_filter_sel_option, property type string, abap_sel_options type tty_abap_sel_option, end of ty_filter_sel_option
6	TY_ORDER_BY	Protected	See coding			20121219	begin of ty_order_by, property type string, order type string, end of ty_order_by

Method Signatures

Method BUILD_CACHE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_GATEWAY_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/CL_MGW_ABS_DATA		Abstract data provider context	20121218
2	Importing	IO_TECH_REQUEST_CONTEXT	Call by reference	☑	Object reference (TYPE REF TO)	/IWBEP/IF_MGW_REQ_ENTITYSET		OData http request details	20130103
3	Importing	IV_ENTITY_SET_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Entity set name	20130103
4	Returning	RV_CACHE_KEY	Value transfer	☐	Type reference (TYPE)	STRING		Cache key	20121218

Method BUILD_CACHE_KEY on class /UI2/CL_CACHE_HELPER has no exception.

Method BUILD_CACHE_KEY_HASHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PAGING	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_PAGING		Paging structure	20130213
2	Importing	IT_ACTION_PARAMETER	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_MGW_NAME_VALUE_PAIR		Action parameters	20131212
3	Importing	IT_FILTER_SELECT_OPTIONS	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION		ABAP select options	20130213
4	Importing	IT_KEY_TAB	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_NAME_VALUE_PAIR		Table for name value pairs	20130213
5	Importing	IT_NAVIGATION_PATH	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_NAVIGATION_PATH		Table of navigation paths	20130213
6	Importing	IT_ORDER	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_SORTING_ORDER		Sorting order	20130213
7	Importing	IV_ACTION_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Action name	20131212
8	Importing	IV_CACHE_AS_ONE_BLOB	Call by reference	☑	Type reference (TYPE)	/UI2/BOOLEAN		Store complete request as one blob	20140212
9	Importing	IV_CLASS_NAME	Call by reference	☑	Type reference (TYPE)	/UI2/DPC		Class name	20130305
10	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Target entity name	20130213
11	Importing	IV_ENTITY_SET_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Target entity set name	20130213
12	Importing	IV_EXPAND	Call by reference	☑	Type reference (TYPE)	STRING		Expand statement	20131210
13	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SY-LANGU		Language	20130715
14	Importing	IV_SOURCE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Source entity name	20130213
15	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	CHAR40		Hash key	20130213

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CACHE_INVALID	☐	Cache exception	20130213

Method BUILD_CACHE_KEY_SEMANTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PAGING	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_PAGING		Paging structure	20130301
2	Importing	IT_FILTER_SELECT_OPTIONS	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION		ABAP select options	20130301
3	Importing	IT_KEY_TAB	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_NAME_VALUE_PAIR		Table for name value pairs	20130301
4	Importing	IT_NAVIGATION_PATH	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_NAVIGATION_PATH		Table of navigation paths	20130301
5	Importing	IT_ORDER	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_SORTING_ORDER		Sorting order	20130301
6	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Target entity name	20130301
7	Importing	IV_ENTITY_SET_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Target entity set name	20130301
8	Importing	IV_SOURCE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Source entity name	20130301
9	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	/UI2/SEMANTIC_CACHE_KEY		Semantic cache key in asXML format	20130301

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CACHE_INVALID	☐	Cache exception	20130301

Method FILTER_WITH_SEL_OPTIONS 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)	ANY TABLE		Original data	20121218
2	Importing	IT_FILTER_SELECT_OPTIONS	Call by reference	☐	Type reference (TYPE)	TTY_FILTER_SEL_OPTION		ABAP select options	20121218
3	Returning	RR_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Filtered data	20121218

Method FILTER_WITH_SEL_OPTIONS on class /UI2/CL_CACHE_HELPER has no exception.

Method GET_CACHE_SUPPORT_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	/UI2/CACHE_SUP		Cache support per service	20121218

Method GET_CACHE_SUPPORT_CLASS on class /UI2/CL_CACHE_HELPER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_GATEWAY_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/CL_MGW_ABS_DATA		Abstract Business Data Provider	20130103
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CACHE_HELPER		Cache utilities	20121218

Method GET_INSTANCE on class /UI2/CL_CACHE_HELPER has no exception.

Method GET_SERVICE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_GATEWAY_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/CL_MGW_ABS_DATA		Abstract data provider context	20130103
2	Returning	RV_SERVICE_NAME	Value transfer	☐	Type reference (TYPE)	/UI2/SERVICE_NAME		Cache key	20130103

Method GET_SERVICE_NAME on class /UI2/CL_CACHE_HELPER has no exception.

Method GET_SINGLETON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CACHE_HELPER		Cache utilities	20131211

Method GET_SINGLETON on class /UI2/CL_CACHE_HELPER has no exception.

Method PAGING 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)	ANY TABLE		Input/output data (sorted and paged)	20130123
2	Importing	IV_SKIP	Call by reference	☐	Type reference (TYPE)	I		Value of URL parameter $skip	20130123
3	Importing	IV_TOP	Call by reference	☐	Type reference (TYPE)	I		Value of URL parameter $top	20130123

Method PAGING on class /UI2/CL_CACHE_HELPER has no exception.

Method POST_PROCESS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_REQUEST_FIELDS	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/CL_GW_DP_REQUEST_FIELDS		UI2 Gateway data provider http request fields	20121218
2	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Cache content before post processing	20121218
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Cache content after post processing	20121218

Method POST_PROCESS_DATA on class /UI2/CL_CACHE_HELPER has no exception.

Method SET_FLAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILTER_FLAG	Call by reference	☐	Type reference (TYPE)	/UI2/FILTER_FLAG		Filtering ($filter) is supported by application (X = true)	20130123
2	Importing	IV_PAGING_FLAG	Call by reference	☐	Type reference (TYPE)	/UI2/PAGING_FLAG		Paging ($skip, $top) is supported by application (X = true)	20130123
3	Importing	IV_SORT_FLAG	Call by reference	☐	Type reference (TYPE)	/UI2/SORT_FLAG		Sort ($orderby) is supported by application (X = true)	20130123

Method SET_FLAGS on class /UI2/CL_CACHE_HELPER has no exception.

Method SORTING 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)	ANY TABLE		Input/output data (sorted and paged)	20130123
2	Importing	IT_ORDERBY	Call by reference	☐	Type reference (TYPE)	TTY_ORDER_BY		Value of URL parameter $orderby	20130123

Method SORTING on class /UI2/CL_CACHE_HELPER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100