SAP ABAP Class CL_RSDR_AT_QUERY (Definition of an abstract Query Object)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT (Application Component) OLAP Technology
     ⤷ RSDRP (Package) Data Manager Query Handler

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSDR_AT_OBJ	Definition of an abstract Object with Result Data	20020910

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSDR_AT_QUERY_SQL	Definition of an SQL Query Object	20020910
2	Inheritance (c INHERITING FROM c_ref)	CL_RSDR_AT_QUERY_VIRTUAL	Definition of an Virtual Query Object	20020910

Properties

Class	CL_RSDR_AT_QUERY
Short Description	Definition of an abstract Query Object
Super Class	CL_RSDR_AT_OBJ	Definition of an abstract Object with Result Data
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	RSDRP	Data Manager Query Handler
Created	20020910	SAP
Last change	20140121	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	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RSD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	RSDRC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	RSDRP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSDR_AT_QUERY has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_RSDRP_AT_QUERY_RFC	☐	20031021	Class extension of RSDRP function group
2	CL_RSDR_AT_POSTPROC	☐	20020910	Generic Postprocessing Object
3	CL_RSDR_AT_QUERY_HANDLER	☐	20040513	Query Handler for Atomic Queries

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_NO_RESULT	Instance attribute	Public	☑	Type reference (TYPE)	RS_BOOL		No result set for query available	20020910
2	N_SLOTNR	Instance attribute	Public	☑	Type reference (TYPE)	I		Number of Slot	20060327
3	N_T_MSG	Instance attribute	Public	☑	Type reference (TYPE)	RS_T_MSG		Error Messages occurred during execution	20040319
4	O_EXEC_ESTIMATE	Instance attribute	Protected	☐	Type reference (TYPE)	I		Estimate for Execution effort	20040510
5	O_RFC_CALL	Instance attribute	Protected	☐	Type reference (TYPE)	RS_BOOL		Called via RFC	20030424
6	O_R_STAT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_RSDD_STATDM		Data Manager Statistics Object	20040504
7	O_R_STAT_ACCESS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_RSDD_STATDM_ACCESS		Single Data Manager Statistics Access Record	20040506
8	P_T_XDATA	Instance attribute	Private	☐	Type reference (TYPE)	TN_T_XDATA		t_data table in packed compressed form	20030314
9	P_XMSG	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING		Execution Messages in packed form	20020910

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Create query object	20020910
2	CREATE_RT_DATA	Static method	Protected	Method	Generate component description of s_data type	20031016
3	EXECUTE_RFC_PACK	Instance method	Protected	Method	Execute a query packaged and store packages in packed form	20030314
4	GET_COMPONENTS	Instance method	Protected	Method	Generate component description of s_data type	20031016
5	GET_DATA_PACKAGED	Instance method	Public	Method	Returns the query result; Result is per default clear in obj	20030314
6	GET_EXEC_ESTIMATE	Instance method	Protected	Method	Get an abstract estimate for the execution effort	20040510
7	PACK	Instance method	Protected	Method	packs the attributes for sending via RFC	20020910
8	PACK_DATA	Instance method	Protected	Method	Exports the data for sending via RFC	20020910
9	PACK_SPLITPACK	Instance method	Protected	Method	packs the splitpack for sending via RFC	20020910
10	PACK_STATS	Instance method	Protected	Method	packs the splitpack for sending via RFC	20040506
11	SET_ENH_DB_OPT	Instance method	Public	Method	Set Usage of Enhanced db optimizer features (before execute)	20050127
12	SET_RFC_DATA	Static method	Private	Method	Set data for serial exec, compression and packaged read	20031008
13	SET_RFC_DATA_EXT	Instance method	Protected	Method	Set data for serial exec, compression and packaged read	20031008
14	SET_SLOTNR	Instance method	Protected	Method	Set Slotnr for Statistics During Parallel Execution	20060327
15	UNPACK_DATA	Instance method	Private	Method	unpacks xdata ...	20020911
16	UPDATE	Instance method	Protected	Method	updates attributes with results from an rfc query execution	20020910
17	UPDATE_STATS	Instance method	Protected	Method	updates statistics with results from quer execution	20040506
18	WRITE_MESSAGES	Instance method	Protected	Method	unpacks the msgs created during RFC execution and writes the	20020910
19	WRITE_MESSAGES_TO_HANDLER	Instance method	Protected	Method	unpacks the msgs created during RFC execution and writes the	20050221

Events

Class CL_RSDR_AT_QUERY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TN_T_QUERY	Public	See coding		Table of query objects	20030926	tn_t_query type standard table of ref to CL_RSDR_AT_QUERY

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INFOPROV	Call by reference	☑	Type reference (TYPE)	RSINFOPROV		Infocube of the query	20020910
2	Importing	I_NO_RESULT	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	If true, no result table needed	20020910
3	Importing	I_RFC_UID	Call by reference	☑	Type reference (TYPE)	RSDRP_UID		UID if object copied	20020910
4	Importing	I_RT_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Reference to Query result table	20020910
5	Importing	I_R_STAT	Call by reference	☑	Object reference (TYPE REF TO)	CL_RSDD_STATDM		DM Statistik -Erfassung	20040504
6	Importing	I_SERIAL_ONLY	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Serial Execution only ?	20031007
7	Importing	I_SX_SPLITPACK	Call by reference	☑	Type reference (TYPE)	RSDR0_SX_SPLITPACK		Splitpack for Query	20020910
8	Importing	I_T_SAMPLE_DATA	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE		Query Result Table Type	20031008
9	Importing	I_USE_TDATA	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	If true, use i_t_data as type reference	20030314
10	Importing	I_XCODE	Call by reference	☑	Type reference (TYPE)	XSTRING		Code that contains form get_ref_t_data	20021001

Method CONSTRUCTOR on class CL_RSDR_AT_QUERY has no exception.

Method CREATE_RT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_RT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Reference to t_data structure	20031016
2	Importing	I_XCODE	Call by reference	☐	Type reference (TYPE)	XSTRING		Xstring with s_data description	20031016

Method CREATE_RT_DATA on class CL_RSDR_AT_QUERY has no exception.

Method EXECUTE_RFC_PACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_STATUS	Call by reference	☐	Type reference (TYPE)	TN_QUERY_STATUS		Status of Query	20030314
2	Exporting	E_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Double packed t_xdata structure	20030314
3	Importing	I_PKGSIZE	Value transfer	☑	Type reference (TYPE)	I	1000	Package Size for packaged read	20030314

#	Exception	Resumable	Description	Created on
1	CX_RSDRP_DATA_NOT_ASSIGNED	☐	Access to not yet assigned query result data	20030314
2	CX_RSDRS_STMT_TOO_LONG	☐	Cube is locked (due to condensing, ...)	20030925
3	CX_RSDR_CUBE_LOCKED	☐	Cube is locked (due to condensing, ...)	20030925
4	CX_RS_ACCESS_ERROR	☐	Fehler beim Zugriff	20030314
5	CX_RS_EXISTING	☐	Objekt existiert bereits	20030314
6	CX_RS_NOT_FOUND	☐	Objekt nicht gefunden	20030314
7	CX_RS_VCUBE_READ_ERROR	☐	Fehler beim Lesen aus einem Virtuellen Cube	20030314
8	CX_STATIC_CHECK	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20030314

Method GET_COMPONENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XCODE	Call by reference	☐	Type reference (TYPE)	XSTRING		xstring with s_data description	20031016
2	Importing	I_RT_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Sample data to get description for	20031021

#	Exception	Resumable	Description	Created on
1	CX_RSDRP_DATA_NOT_ASSIGNED	☐	Access to not yet assigned query result data	20031016

Method GET_DATA_PACKAGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_END_OF_DATA	Call by reference	☐	Type reference (TYPE)	RS_BOOL		End of Data reached ?	20030314
2	Exporting	E_RT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		reference to result data inside object	20030314
3	Exporting	E_SX_SPLITPACK	Call by reference	☐	Type reference (TYPE)	RSDR0_SX_SPLITPACK		splitpack	20030314
4	Exporting	E_T_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		query result table	20030314

#	Exception	Resumable	Description	Created on
1	CX_RSDR_CUBE_LOCKED	☐	Cube is locked (due to condensing, ...)	20040426
2	CX_RS_ACTION_NOT_ALLOWED	☐	Query does not have any result data	20030314
3	CX_RS_ERROR	☐	BW: Allgemeine Fehlerklasse	20050125

Method GET_EXEC_ESTIMATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ESTIMATE	Value transfer	☐	Type reference (TYPE)	I		Estimate for execution effort	20040510

#	Exception	Resumable	Description	Created on
1	CX_RS_ACTION_NOT_ALLOWED	☐	Die Aktion ist an dieser Stelle nicht erlaubt	20040511

Method PACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_INFOPROV	Call by reference	☐	Type reference (TYPE)	RSINFOPROV		Infoprovider	20020910
2	Exporting	E_TYPE	Call by reference	☐	Type reference (TYPE)	RSDRP_QUERY_TYPE		Type of Query	20020910
3	Exporting	E_UID	Call by reference	☐	Type reference (TYPE)	RSDRP_UID		UID	20020910
4	Exporting	E_XDEFINITION	Call by reference	☐	Type reference (TYPE)	XSTRING		packed query definition	20020910

Method PACK on class CL_RSDR_AT_QUERY has no exception.

Method PACK_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING		packed query result table	20030314

#	Exception	Resumable	Description	Created on
1	CX_RSDRP_DATA_NOT_ASSIGNED	☐	Result data area not assigned inside object	20020920
2	CX_RS_ACTION_NOT_ALLOWED	☐	Query does not have any result data	20020913

Method PACK_SPLITPACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XSPLITPACK	Call by reference	☐	Type reference (TYPE)	XSTRING		packed splitpack	20020910

Method PACK_SPLITPACK on class CL_RSDR_AT_QUERY has no exception.

Method PACK_STATS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XSTATS	Call by reference	☐	Type reference (TYPE)	XSTRING		packed dm access statistics	20040506

Method PACK_STATS on class CL_RSDR_AT_QUERY has no exception.

Method SET_ENH_DB_OPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ENH_DB_OPT	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Use enhanced db optimizer features	20050127

Method SET_ENH_DB_OPT on class CL_RSDR_AT_QUERY has no exception.

Method SET_RFC_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_RT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Reference to Data (if set)	20031008
2	Importing	I_RT_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Reference to Query result table	20031008
3	Importing	I_XCODE	Call by reference	☑	Type reference (TYPE)	XSTRING		Code that contains form get_ref_t_data	20031008

Method SET_RFC_DATA on class CL_RSDR_AT_QUERY has no exception.

Method SET_RFC_DATA_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XCODE	Call by reference	☑	Type reference (TYPE)	XSTRING		Code that contains form get_ref_t_data	20031008

Method SET_RFC_DATA_EXT on class CL_RSDR_AT_QUERY has no exception.

Method SET_SLOTNR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SLOTNR	Call by reference	☐	Type reference (TYPE)	I			20060327

Method SET_SLOTNR on class CL_RSDR_AT_QUERY has no exception.

Method UNPACK_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Result data (if it has not been provided earlier)	20030314

#	Exception	Resumable	Description	Created on
1	CX_RSDRP_DATA_NOT_ASSIGNED	☐	Access to not yet assigned query result data	20020913

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ROWS_FETCHED	Call by reference	☐	Type reference (TYPE)	I		Number of Rows fetched	20030317
2	Importing	I_SUBRC	Call by reference	☐	Type reference (TYPE)	RSDRP_RC		Return Code of RFC execution	20020910
3	Importing	I_T_DATA	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE		Query Result Table	20020910
4	Importing	I_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Result data in packed form	20030314
5	Importing	I_XMSG	Call by reference	☐	Type reference (TYPE)	XSTRING		Messages in packed form	20020910
6	Importing	I_XSPLITPACK	Call by reference	☑	Type reference (TYPE)	XSTRING		Packed splitpack for Query	20020910
7	Importing	I_XSTATS	Call by reference	☐	Type reference (TYPE)	XSTRING		Statistics Data	20040506

Method UPDATE on class CL_RSDR_AT_QUERY has no exception.

Method UPDATE_STATS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XSTATS	Call by reference	☐	Type reference (TYPE)	XSTRING		Flattened DMSTAT_ACCESS object	20040506

Method UPDATE_STATS on class CL_RSDR_AT_QUERY has no exception.

Method WRITE_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_MSG	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT		Message to append to last message	20040921
2	Importing	I_WITH_QUERY_MSG	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Add msg describing query uid ?	20040921
3	Returning	R_R_MSG	Value transfer	☐	Object reference (TYPE REF TO)	CX_ROOT		BW Exception mit generischer Nachricht (keine spez. Attrib.)	20040921

Method WRITE_MESSAGES on class CL_RSDR_AT_QUERY has no exception.

Method WRITE_MESSAGES_TO_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_WITH_QUERY_MSG	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Add msg describing query uid ?	20050221

Method WRITE_MESSAGES_TO_HANDLER on class CL_RSDR_AT_QUERY has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	400