SAP ABAP Class CL_CRM_BOL_DQUERY_SERVICE (BOL - Query-Service)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-GOL-BOL (Application Component) Business Object Layer
     ⤷ CRM_BOL (Package) CRM Business Object Layer

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CRM_BOL_ABSTR_BO	Abstract Basis Class for BOL Business Objects	20060207

Properties

Class	CL_CRM_BOL_DQUERY_SERVICE
Short Description	BOL - Query-Service
Super Class	CL_CRM_BOL_ABSTR_BO	Abstract Basis Class for BOL Business Objects
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	CRM_BOL	CRM Business Object Layer
Created	20060207	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)
2	CL_CRM_GENIL_MODEL_SERVICE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_CRM_BOL_DQUERY_SERVICE has no interface implemented.

Friends

Class CL_CRM_BOL_DQUERY_SERVICE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONV_CLEAR_SELECTION_PARAM	Constant	Public	☐	Type reference (TYPE)	CHAR10	'CLRSELPARM'	Character Field Length = 10	20070226
2	HANDLE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_GENIL_HANDLE_DQUERY_RESULT		Handle for assync. query result	20080407
3	QUERY_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		Query Service Name	20060207
4	QUERY_PARAMS	Instance attribute	Protected	☐	Type reference (TYPE)	CRMT_NAME_VALUE_PAIR_TAB		Name-Value Tab for Query Parameters	20060207
5	QUERY_PARAM_STRUCT_REF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	GENILT_QUERY_PARAMETERS		Ref to Query Header	20060220
6	SAVING	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Currently saving the query	20090609
7	SELECTION_PARAM_COL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BOL_BO_COL		BO Collection for Selection Paramters	20060220
8	SELECTION_PARAM_STRUCT_REF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Selection parameter structure	20080521
9	STD_SELECTION_PARAMS_ONLY	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Accept non-standard Selection Parameters	20070218
10	VIEW_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	CRMT_VIEW_NAME		UI View Name	20060207
11	WILDCARD	Constant	Public	☐	Type reference (TYPE)	C	'*'		20090513

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SELECTION_PARAM	Instance method	Public	Method	Adds a Selection Parameter to the Bol Collection	20060208
2	ADJUST_SELECTION_PARAMS	Instance method	Public	Method	Adjusts selection criteria to be passed to the GenIL	20060824
3	CHECK_PARAMETERS_SET	Instance method	Public	Method	Checks Whether Query Parameters Were Set	20060220
4	CHECK_SELECTION_PARAMS	Instance method	Public	Method	Checks the selection criteria	20060824
5	CLEAR_QUERY_PARAMETER_VALUES	Instance method	Public	Method	Löscht die Werte aller Query Parameter	20060522
6	CLEAR_SELECTION_PARAM_VALUE	Instance method	Public	Method	Deletes High and Low Values of all Selection Criteria	20070914
7	CLEAR_SELECTION_PARAM_VALUES	Instance method	Public	Method	Deletes High and Low Values of all Selection Criteria	20070226
8	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20060207
9	DELETE_EMPTY_SELECTION_PARAMS	Instance method	Public	Method	Deletes empty selection parameters	20060719
10	DELETE_QUERY_TEMPLATE	Static method	Public	Method	Deletes query parameters that were saved	20060220
11	GET_INSTANCE	Static method	Public	Method	Factory Method for Generating a Query Service Instance	20060207
12	GET_QUERY_PARAMS	Instance method	Protected	Method	Get the Query Params (Max Hits, Match Type etc..)	20060207
13	GET_QUERY_RESULT	Instance method	Public	Method	Returns Result / Criteria Filtering and Adjustments On	20060207
14	GET_RESULT	Instance method	Public	Method	Returns Result / Criteria Filtering and Adjustments Off	20090527
15	GET_SELECTION_PARAMS	Instance method	Public	Method	Gets the Selection Parameters as a Bol Collection	20060209
16	GET_SELECTION_PARAM_TABLE	Instance method	Protected	Method	Gets the Selection Parameters as a Table	20060209
17	INSERT_SELECTION_PARAM	Instance method	Public	Method		20060221
18	LOAD_QUERY_TEMPLATE	Static method	Public	Method	Returns Query Result	20060220
19	REQUEST_HIT_COUNT	Instance method	Public	Method	Starts an search to retrieve the hit count	20080407
20	REQUEST_RESULT	Instance method	Public	Method	Starts a query	20080407
21	RETRIEVE_HIT_COUNT	Instance method	Public	Method	Retrieve hit count	20080407
22	RETRIEVE_RESULT	Instance method	Public	Method	Retrieve query result asynchronously	20080407
23	SAVE_QUERY_AS_TEMPLATE	Instance method	Public	Method	Returns Query Result	20060220
24	SET_QUERY_PARAMETERS	Instance method	Public	Method	Set the Query Params (Max Hits, Match Type etc..)	20060207
25	SET_STD_SELECTION_PARAMS_ONLY	Instance method	Public	Method	Accept non-standard Selection Parameters	20070218
26	SET_VIEW_NAME	Instance method	Public	Method	Set View That Is to Be Read as Query Result	20060207

Events

#	Event	Type	Visibility	Description	Created on
1	QUERY_EXECUTED	Instance Event (0)	Public (2)		20070307

Types

Class CL_CRM_BOL_DQUERY_SERVICE has no local type.

Method Signatures

Method ADD_SELECTION_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTR_NAME	Call by reference	☑	Type reference (TYPE)	NAME_KOMP		Component name	20060208
2	Importing	IV_HIGH	Call by reference	☑	Type reference (TYPE)	STRING			20060208
3	Importing	IV_LOW	Call by reference	☑	Type reference (TYPE)	STRING			20060208
4	Importing	IV_OPTION	Call by reference	☑	Type reference (TYPE)	BAPIOPTION		Selection operator OPTION for range tables	20060217
5	Importing	IV_SIGN	Call by reference	☑	Type reference (TYPE)	BAPISIGN		Inclusion/exclusion criterion SIGN for range tables	20060208

Method ADD_SELECTION_PARAM on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method ADJUST_SELECTION_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PARAMS	Call by reference	☑	Type reference (TYPE)	GENILT_SELECTION_PARAMETER_TAB		Selection criteria to be used for advanced query	20060824
2	Exporting	ET_PARAMS_TO_BE_ADJUSTED	Call by reference	☐	Type reference (TYPE)	GENILT_SELECTION_PARAMETER_TAB		Selection criteria, which should be adjusted	20060824
3	Importing	IV_ADJUST_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Flag to cancel automatic adjustment of criteria	20060824

Method ADJUST_SELECTION_PARAMS on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method CHECK_PARAMETERS_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PARAMS_SET	Value transfer	☐	Type reference (TYPE)	CRMT_BOOLEAN			20060220

Method CHECK_PARAMETERS_SET on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method CHECK_SELECTION_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PARAMS	Call by reference	☑	Type reference (TYPE)	GENILT_SELECTION_PARAMETER_TAB		Selection criteria	20060824
2	Exporting	ET_UNEXPECTED_PARAMS	Call by reference	☐	Type reference (TYPE)	GENILT_SELECTION_PARAMETER_TAB		Selection critieria, which did not pass the check	20060824
3	Exporting	EV_UNEXPECTED_PARAMS_FILTERED	Value transfer	☐	Type reference (TYPE)	I		Number of unexpected selection criteria filtered	20060824
4	Importing	IV_FILTER_EMPTY_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Filter selection criteria containing empty values	20060824
5	Importing	IV_FILTER_UNEXPECTED_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Filter selection criteria, which did not pass the check	20060824

Method CHECK_SELECTION_PARAMS on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method CLEAR_QUERY_PARAMETER_VALUES Signature

Method CLEAR_QUERY_PARAMETER_VALUES on class CL_CRM_BOL_DQUERY_SERVICE has no parameter.
Method CLEAR_QUERY_PARAMETER_VALUES on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method CLEAR_SELECTION_PARAM_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADJUSTMENTS	Call by reference	☑	Object reference (TYPE REF TO)	CRMT_REGEX_CONVERSION_TAB		Regular Expression Based Conversions	20070914
2	Importing	IV_SELECTION_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	IF_BOL_SELECTION_PARAM		Interface for Access to Central Object Model	20070914

Method CLEAR_SELECTION_PARAM_VALUE on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method CLEAR_SELECTION_PARAM_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADJUSTMENTS	Call by reference	☑	Object reference (TYPE REF TO)	CRMT_REGEX_CONVERSION_TAB		Regular Expression Based Conversions	20070227

Method CLEAR_SELECTION_PARAM_VALUES on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20060207

#	Exception	Resumable	Description	Created on
1	CX_CRM_UNSUPPORTED_OBJECT	☐	Ausnahme: Objekt nicht unterstützt	20060207

Method DELETE_EMPTY_SELECTION_PARAMS Signature

Method DELETE_EMPTY_SELECTION_PARAMS on class CL_CRM_BOL_DQUERY_SERVICE has no parameter.
Method DELETE_EMPTY_SELECTION_PARAMS on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method DELETE_QUERY_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	GENIL_DQUERY_HANDLE		ID for Adv. Querys	20060220

Method DELETE_QUERY_TEMPLATE on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20060207
2	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_DQUERY_SERVICE		BOL query service	20060207

#	Exception	Resumable	Description	Created on
1	CX_CRM_UNSUPPORTED_OBJECT	☐	Exception: Object Not Supported	20081205

Method GET_QUERY_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	GENILT_QUERY_PARAMETERS		Parametertabelle von Name-Wert-Paaren	20060207

Method GET_QUERY_PARAMS on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method GET_QUERY_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_REQUEST_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	CRMT_ATTR_NAME_TAB		Table of Attribute Names	20121203
2	Importing	IV_ADD_QRESOBJ_2_BOL_BUFFER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20080515
3	Importing	IV_ADJUST_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Automatically adjust selection criteria	20090527
4	Importing	IV_EXCEPTION_IF_ERROR_DETECTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Exception if error detected, error message otherwise	20090527
5	Importing	IV_EXEC_FOR_UNEXPECTED_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Execute query even se parameter check has failed	20090527
6	Importing	IV_FILTER_EMPTY_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Filter selection criteria containing empty values	20090527
7	Importing	IV_FILTER_UNEXPECTED_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Filter selection criteria, which have not passed the check	20090527
8	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BOL_ENTITY_COL		Header Structure for RFC Data Container	20060207

Method GET_QUERY_RESULT on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method GET_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADD_QRESOBJ_2_BOL_BUFFER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090527
2	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BOL_ENTITY_COL		Header Structure for RFC Data Container	20090527

Method GET_RESULT on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method GET_SELECTION_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BOL_BO_COL		BO Collection	20060209

Method GET_SELECTION_PARAMS on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method GET_SELECTION_PARAM_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	GENILT_SELECTION_PARAMETER_TAB			20060220

Method GET_SELECTION_PARAM_TABLE on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method INSERT_SELECTION_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTR_NAME	Call by reference	☑	Type reference (TYPE)	NAME_KOMP		Component name	20060221
2	Importing	IV_HIGH	Call by reference	☑	Type reference (TYPE)	STRING			20060221
3	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX			20060221
4	Importing	IV_LOW	Call by reference	☑	Type reference (TYPE)	STRING			20060221
5	Importing	IV_OPTION	Call by reference	☑	Type reference (TYPE)	BAPIOPTION		Selection operator OPTION for range tables	20060221
6	Importing	IV_SIGN	Call by reference	☑	Type reference (TYPE)	BAPISIGN		Inclusion/exclusion criterion SIGN for range tables	20060221
7	Returning	RV_SELECTION_PARAM	Value transfer	☐	Object reference (TYPE REF TO)	IF_BOL_SELECTION_PARAM		Interface for Access to Central Object Model	20070914

Method INSERT_SELECTION_PARAM on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method LOAD_QUERY_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	GENIL_DQUERY_HANDLE		ID for Adv. Querys	20060220
2	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_DQUERY_SERVICE		Header Structure for RFC Data Container	20060220

Method LOAD_QUERY_TEMPLATE on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method REQUEST_HIT_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RESULT_FILTERED_BY	Call by reference	☑	Type reference (TYPE)	CRMT_NAME_VALUE_PAIR_TAB		Sorting	20080409

Method REQUEST_HIT_COUNT on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method REQUEST_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RESULT_FILTERED_BY	Call by reference	☑	Type reference (TYPE)	CRMT_NAME_VALUE_PAIR_TAB		Fitering	20080407
2	Importing	IT_RESULT_SORTED_BY	Call by reference	☑	Type reference (TYPE)	CRMT_BOL_SORT_STATE_TAB		Sorting	20080407
3	Importing	IV_RESULT_STARTS_AT_INDEX	Call by reference	☐	Type reference (TYPE)	GENILT_UNSIGNED_INT4	1	Result starts at index	20080407

Method REQUEST_RESULT on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method RETRIEVE_HIT_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMEOUT_SECONDS	Call by reference	☐	Type reference (TYPE)	GENILT_UNSIGNED_INT4	0	Unsigned Integer	20080407
2	Returning	RV_HIT_COUNT	Value transfer	☐	Type reference (TYPE)	GENILT_UNSIGNED_INT4		Result	20080407

#	Exception	Resumable	Description	Created on
1	CX_CRM_BOL_NOT_READY	☐	Result not yet available	20080407

Method RETRIEVE_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADD_QRESOBJ_2_BOL_BUFFER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20080515
2	Importing	IV_TIMEOUT_SECONDS	Call by reference	☐	Type reference (TYPE)	GENILT_UNSIGNED_INT4	0	Unsigned Integer	20080407
3	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_BOL_ENTITY_COL		Result	20080407

#	Exception	Resumable	Description	Created on
1	CX_CRM_BOL_NOT_READY	☐	Result not yet available	20080407

Method SAVE_QUERY_AS_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILTER_EMPTY_PARAMS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Filter empty selection criteria before saving query	20060830
2	Importing	IV_OVERWRITE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Eventually overwrite if query is already existing	20060220
3	Importing	IV_QUERY_ID	Call by reference	☐	Type reference (TYPE)	GENIL_DQUERY_HANDLE		Id for advanced searches	20060220

Method SAVE_QUERY_AS_TEMPLATE on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method SET_QUERY_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAMETERS	Call by reference	☐	Type reference (TYPE)	CRMT_NAME_VALUE_PAIR_TAB		Parameter Table of Name Value Pairs	20060207
2	Importing	IV_CONVERT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Flag: Convert Parameter List to Parameter Structure	20060207

Method SET_QUERY_PARAMETERS on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method SET_STD_SELECTION_PARAMS_ONLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STD_SELECTION_PARAMS_ONLY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070218

Method SET_STD_SELECTION_PARAMS_ONLY on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Method SET_VIEW_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VIEW_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_VIEW_NAME		UI View Name	20060207

Method SET_VIEW_NAME on class CL_CRM_BOL_DQUERY_SERVICE has no exception.

Event Signatures

Event QUERY_EXECUTED Signature
Event QUERY_EXECUTED on class CL_CRM_BOL_DQUERY_SERVICE has no parameter.

History

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