SAP ABAP Class /BCV/CL_QRM_CACHE (Query result caching)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-BCV (Application Component) Business Context Viewer
     ⤷ /BCV/QRM (Package) BCV Query Management Layer

Properties

Class	/BCV/CL_QRM_CACHE
Short Description	Query result caching
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/BCV/QRM	BCV Query Management Layer
Created	20090113	SAP
Last change	20130531	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)

Interfaces

Class /BCV/CL_QRM_CACHE has no interface implemented.

Friends

Class /BCV/CL_QRM_CACHE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DEFAULT_DURATION	Constant	Private	☐	Type reference (TYPE)	/BCV/QRM_CACHE_DURATION	'10000'	Cache duration	20090123
2	GC_RELID	Constant	Private	☐	Type reference (TYPE)	/BCV/QRM_RELATION_ID	'ST'	Relation ID	20090121
3	GC_RESULT_ID	Constant	Private	☐	Type reference (TYPE)	STRING	'RESULT_ID'		20090116
4	GC_STATUS_CACHED	Constant	Public	☐	Type reference (TYPE)	/BCV/QRM_CACHE_STATUS	'C'	Cache status	20090119
5	GC_STATUS_UNCACHED	Constant	Public	☐	Type reference (TYPE)	/BCV/QRM_CACHE_STATUS	'U'	Cache status	20090119
6	GC_TIME_END	Constant	Private	☐	Type reference (TYPE)	STRING	'TIME_END'		20090123
7	GC_TIME_START	Constant	Private	☐	Type reference (TYPE)	STRING	'TIME_START'		20090116
8	GC_VARIABLE_DATA	Constant	Private	☐	Type reference (TYPE)	STRING	'VARIABLE_DATA'		20090116
9	GT_DURATION	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/T_QRM_CACHE_DURATION		Query cache durations	20090430
10	GV_AUTO_DELETE	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/QRM_CACHE_AUTO_DELETE	ABAP_TRUE	Automatical cache clean up	20090210
11	GV_DURATION	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/QRM_CACHE_DURATION	'10000'	Cache duration	20090210
12	GV_TIME_NOW	Static Attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		Now	20090121

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAN_UP	Static method	Private	Method	Clean up the users cache if possible	20090121
2	CREATE_HASH_KEY	Static method	Private	Method	Create hash key	20090119
3	CREATE_ID	Static method	Private	Method	Create ID	20090122
4	CREATE_REQRES	Static method	Private	Method	Create mapping between REQUEST_ID and RESULT_ID	20090116
5	CREATE_RESULT	Static method	Public	Method	Create result	20090212
6	CREATE_STRUCTURE	Static method	Private	Method	Create workarea for cache data	20090116
7	CREATE_TABLE	Static method	Private	Method	Create internal table for cache data	20090116
8	DELETE_BY_DATE	Static method	Public	Method	Delete cache data that was created before a given date	20090126
9	DELETE_BY_QUERY	Static method	Public	Method	Delete cache data for given queries	20090304
10	DELETE_BY_SEARCH_ID	Static method	Public	Method	Delete cache data for given search IDs	20090309
11	DELETE_BY_USER	Static method	Public	Method	Delete expired cache data of given user	20090126
12	DELETE_BY_USER2	Static method	Public	Method	Delete all cache data of given user	20090210
13	DELETE_DATA	Static method	Private	Method	Delete the cache data from the database	20090304
14	DELETE_ORPHANS	Static method	Public	Method	Delete orphaned cache data	20090126
15	GET_DURATION	Static method	Private	Method	Get duration of cache validity period	20090119
16	GET_RESULT	Static method	Public	Method	Get result	20090212
17	GET_RESULT_ID	Static method	Private	Method	Get result ID	20090114
18	GET_TIME_END	Static method	Private	Method	Get expiry time of cache data	20090114
19	GET_TIME_NOW	Static method	Private	Method	Get TIME_NOW	20090123
20	GET_TIME_START	Static method	Private	Method	Get creation time of cache data	20090119
21	IS_VALID	Static method	Private	Method	Check if given time is still in validity period	20090119
22	LOCK	Static method	Private	Method	Lock cache	20090122
23	SET_DURATION	Static method	Private	Method	Set duration of cache validity period	20090429
24	SET_TIME_NOW	Static method	Private	Method	Set TIME_NOW	20090121
25	SKIP	Static method	Private	Method	Skip caching?	20090123
26	SPLIT_REQUEST	Static method	Public	Method	Split requests into new and old ones	20090116
27	UNLOCK	Static method	Private	Method	Unlock cache	20090122

Events

Class /BCV/CL_QRM_CACHE has no event.

Types

Class /BCV/CL_QRM_CACHE has no local type.

Method Signatures

Method CLEAN_UP Signature

Method CLEAN_UP on class /BCV/CL_QRM_CACHE has no parameter.
Method CLEAN_UP on class /BCV/CL_QRM_CACHE has no exception.

Method CREATE_HASH_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20090119
2	Returning	RV_HASH_KEY	Value transfer	☐	Type reference (TYPE)	/BCV/QRM_CACHE_HASH_KEY		Hash key	20090119

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090120

Method CREATE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	/BCV/QRM_ID		ID	20090122

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090122

Method CREATE_REQRES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ID	Call by reference	☑	Type reference (TYPE)	/BCV/QRM_CACHE_ID		Cache ID	20090121
2	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090304
3	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_REQUEST_ID		Query Request ID	20090116
4	Importing	IV_RESULT_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_RESULT_ID		Result ID	20090116
5	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_CACHE_STATUS		Cache status	20090119

Method CREATE_REQRES on class /BCV/CL_QRM_CACHE has no exception.

Method CREATE_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_RESULT	Call by reference	☑	Type reference (TYPE)	INDEX TABLE			20090212
2	Importing	IT_EXCEPTION	Call by reference	☑	Type reference (TYPE)	/BCV/T_FND_EXCEPTION		Exeptions table	20090212
3	Importing	IT_MESSAGE	Call by reference	☑	Type reference (TYPE)	/BCV/T_FND_MESSAGES		Messages	20090212
4	Importing	IT_METADATA	Call by reference	☑	Type reference (TYPE)	/BCV/T_QRM_QUERY_RES_ATTR_EXT			20090212
5	Importing	IV_QUERY	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_ID			20090212
6	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_REQUEST_ID			20090212

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090212

Method CREATE_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_STRUCTURE	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Reference to cache structure	20090116
2	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090119

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090120

Method CREATE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_TABLE	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Reference to cache table	20090116
2	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090119

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090120

Method DELETE_BY_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIME_START	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_CACHE_TIME_START		Timestamp when cache was created	20090126

Method DELETE_BY_DATE on class /BCV/CL_QRM_CACHE has no exception.

Method DELETE_BY_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUERY_ID	Call by reference	☐	Type reference (TYPE)	/BCV/T_QRM_QUERY_ID		Query ID Table	20090304

Method DELETE_BY_QUERY on class /BCV/CL_QRM_CACHE has no exception.

Method DELETE_BY_SEARCH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	/BCV/T_SIN_SEARCH_ID		Search ID Table	20090309

Method DELETE_BY_SEARCH_ID on class /BCV/CL_QRM_CACHE has no exception.

Method DELETE_BY_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_CACHE_UNAME	SY-UNAME	User Name	20090126

Method DELETE_BY_USER on class /BCV/CL_QRM_CACHE has no exception.

Method DELETE_BY_USER2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_CACHE_UNAME	SY-UNAME	User Name	20090210

Method DELETE_BY_USER2 on class /BCV/CL_QRM_CACHE has no exception.

Method DELETE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CACHE_ID	Call by reference	☐	Type reference (TYPE)	/BCV/T_QRM_CACHE_ID		Table of cache IDs	20090304
2	Importing	IT_REQRES	Call by reference	☑	Type reference (TYPE)	/BCV/T_QRM_REQRES		Mapping table between query requests and results	20090304
3	Importing	IT_RESULT_ID	Call by reference	☑	Type reference (TYPE)	/BCV/T_QRM_RESULT_ID		Table of result IDs	20090304

Method DELETE_DATA on class /BCV/CL_QRM_CACHE has no exception.

Method DELETE_ORPHANS Signature

Method DELETE_ORPHANS on class /BCV/CL_QRM_CACHE has no parameter.
Method DELETE_ORPHANS on class /BCV/CL_QRM_CACHE has no exception.

Method GET_DURATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DURATION	Value transfer	☐	Type reference (TYPE)	/BCV/QRM_CACHE_DURATION		Cache duration	20090119

Method GET_DURATION on class /BCV/CL_QRM_CACHE has no exception.

Method GET_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_RESULT	Call by reference	☐	Type reference (TYPE)	/BCV/S_QRM_RESULT		Query result cache	20090212
2	Exporting	ET_METADATA	Call by reference	☐	Type reference (TYPE)	/BCV/T_QRM_QUERY_RES_ATTR_EXT		Query Result Attribute Table (external view)	20090212
3	Exporting	EV_FOUND	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20090212
4	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090212
5	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_REQUEST_ID		Query Request ID	20090212

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090212

Method GET_RESULT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_REQUEST_ID		Query Request ID	20090114
2	Returning	RV_RESULT_ID	Value transfer	☐	Type reference (TYPE)	/BCV/QRM_RESULT_ID		Result ID	20090114

Method GET_RESULT_ID on class /BCV/CL_QRM_CACHE has no exception.

Method GET_TIME_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIME_END	Value transfer	☐	Type reference (TYPE)	/BCV/QRM_CACHE_TIME_END		Timestamp when cache validity expires	20090114

Method GET_TIME_END on class /BCV/CL_QRM_CACHE has no exception.

Method GET_TIME_NOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIME_NOW	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		Now	20090123

Method GET_TIME_NOW on class /BCV/CL_QRM_CACHE has no exception.

Method GET_TIME_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIME_START	Value transfer	☐	Type reference (TYPE)	/BCV/QRM_CACHE_TIME_START		Timestamp when cache was created	20090119

Method GET_TIME_START on class /BCV/CL_QRM_CACHE has no exception.

Method IS_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIME_END	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_CACHE_TIME_END		Timestamp when cache validity expires	20090123
2	Returning	RV_VALID	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20090119

Method IS_VALID on class /BCV/CL_QRM_CACHE has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_KEY	Call by reference	☑	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20090122
2	Importing	IV_QUERY_ID	Call by reference	☑	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090122
3	Importing	IV_UNAME	Call by reference	☑	Type reference (TYPE)	/BCV/QRM_CACHE_UNAME		User Name	20090122

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090122

Method SET_DURATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_KEY	Call by reference	☐	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20090429
2	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090429

Method SET_DURATION on class /BCV/CL_QRM_CACHE has no exception.

Method SET_TIME_NOW Signature

Method SET_TIME_NOW on class /BCV/CL_QRM_CACHE has no parameter.
Method SET_TIME_NOW on class /BCV/CL_QRM_CACHE has no exception.

Method SKIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SKIP	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20090123

Method SKIP on class /BCV/CL_QRM_CACHE has no exception.

Method SPLIT_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQUEST_NEW	Call by reference	☐	Type reference (TYPE)	/BCV/T_QRM_QUERY_REQUEST		Query request table	20090116
2	Exporting	ET_REQUEST_OLD	Call by reference	☐	Type reference (TYPE)	/BCV/T_QRM_QUERY_REQUEST		Query request table	20090116
3	Importing	IT_REQUEST	Call by reference	☐	Type reference (TYPE)	/BCV/T_QRM_QUERY_REQUEST		Query request table	20090116
4	Importing	IV_REFRESH	Call by reference	☐	Type reference (TYPE)	/BCV/QRM_CACHE_REFRESH	ABAP_FALSE	Refresh cache	20090119

#	Exception	Resumable	Description	Created on
1	/BCV/CX_QRM_CACHE	☐	Exception class for QRM Cache	20090120

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT_KEY	Call by reference	☑	Type reference (TYPE)	/BCV/FND_CONTEXT_KEY		Context Key	20090122
2	Importing	IV_QUERY_ID	Call by reference	☑	Type reference (TYPE)	/BCV/QRM_QUERY_ID		Query ID	20090122
3	Importing	IV_UNAME	Call by reference	☑	Type reference (TYPE)	/BCV/QRM_CACHE_UNAME		User Name	20090122

Method UNLOCK on class /BCV/CL_QRM_CACHE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	702