SAP ABAP Class CL_TREX_AGGREGATE_REQ (Basis Client: Request for Aggregation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TRX-API (Application Component) TREX ABAP + JAVA API
     ⤷ STREX (Package) TREX ABAP client

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_REQUEST	TREX Request	20070528
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_SXML_READABLE	Readable from SXML Reader	20070516
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_SXML_WRITABLE	Writable to SXML Writer	20070528
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_SXML_WRITABLE_REQ	Request Writable to SXML Writer	20070528

Properties

Class	CL_TREX_AGGREGATE_REQ
Short Description	Basis Client: Request for Aggregation
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	STREX	TREX ABAP client
Created	20060117	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	CL_TREX_STRUCTURE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_TREX_REQUEST	☐	☐	TREX Request	20070528
2	IF_TREX_SXML_READABLE	☐	☐	Readable from SXML Reader	20070516
3	IF_TREX_SXML_WRITABLE	☐	☐	Writable to SXML Writer	20070528
4	IF_TREX_SXML_WRITABLE_REQ	☐	☐	Request Writable to SXML Writer	20070528

Friends

Class CL_TREX_AGGREGATE_REQ has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ATTRIBUTE_MAP	Instance attribute	Public	☐	Type reference (TYPE)	CL_TREX_STRUCTURE=>T_ATTRIBUTE_MAP			20070516
2	CALCULATION_VIEW	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20091028
3	COLUMN_METAS	Instance attribute	Public	☐	Type reference (TYPE)	CL_TREX_STRUCTURE=>T_COLUMN_METAS			20070516
4	COMMIT_ID	Instance attribute	Public	☐	Type reference (TYPE)	TREXD_TRANSACTION_ID		Transaction ID	20091123
5	C_FUNCTION_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'olapCellSearch'		20070516
6	C_HANA_VERSION	Constant	Public	☐	Type reference (TYPE)	INT1	5	version number for HANA	20120127
7	C_PERF_ID_READ	Instance attribute	Private	☐	Attribute reference (LIKE)				20070516
8	C_TREX_VERSION	Constant	Public	☐	Type reference (TYPE)	INT1	4	version number for TREX	20120127
9	DEBUG_COMMANDS	Instance attribute	Public	☐	Type reference (TYPE)	CHAR128			20080603
10	FACTOR_ATTRIBUTES	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_FACTOR_ATTRIBUTES		Factor attributes	20060814
11	FACTOR_KEY_FIGURES	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_FACTOR_KEY_FIGURES		Factor key figures	20060814
12	HAS_NULL_SID	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20070528
13	HAVING_FILTER	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100215
14	INDEX_ALIAS_OPERATIONS	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_INDEX_ALIAS_OPERATION		index Alias Operation	20060119
15	INDEX_ID	Instance attribute	Public	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070516
16	JOIN_CONDITIONS	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_STATIC_JOIN_CONDITION		static join condition	20060117
17	KEY_FIGURES	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_KEY_FIGURE		Key figure	20060117
18	NULL_SID	Instance attribute	Public	☐	Type reference (TYPE)	I			20060814
19	PLACEHOLDERS	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_PLACEHOLDERS		Placeholder	20080716
20	QUERY	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_TREX_QUERY		Query	20060117
21	QUERY_ID	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-QUERY_ID			20060117
22	REQUESTED_ATTRIBUTES	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_REQ_ATTRIBUTES_EXT		Attributes	20060117
23	REQUESTED_RESULTS	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-REQUESTED_RESULTS	6	6: Aggregate requested, 7: Federate Aggregation requested	20060117
24	REQUEST_FLAGS	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-REQUEST_FLAG_L			20091213
25	RESULT_CHUNK_SIZE	Instance attribute	Public	☐	Type reference (TYPE)	INT4		Natural number	20110407
26	RESULT_CHUNK_SIZE_ROW	Instance attribute	Public	☐	Type reference (TYPE)	INT4		HANA only: result chunk size (number of rows)	20120127
27	RESULT_FROM	Instance attribute	Public	☐	Type reference (TYPE)	I	1		20060117
28	RESULT_INDEX_NAME	Instance attribute	Public	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20091119
29	RESULT_TO	Instance attribute	Public	☐	Type reference (TYPE)	I	2147483647		20060117
30	SORT_ATTRIBUTES	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_TREX_SORT_ATTRIBUTES		Sort Attributes	20060117
31	STAGING	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060117
32	STAR_COUNT	Instance attribute	Public	☐	Type reference (TYPE)	TREXT_STAR_COUNT		Star Count	20060814
33	TOP_MAX_EQUALS	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-MAX_RESULTS			20060127
34	TOP_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-TOP_TYPE		Top Type	20060127
35	TOP_VALUE	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-TOP_VALUE			20060127
36	TRACE	Instance attribute	Public	☐	Type reference (TYPE)	NUMC2		Two-Digit Number	20060117
37	TRACE_COMPONENTS	Instance attribute	Public	☐	Type reference (TYPE)	CHAR128		128 character	20070516
38	USE_DFI	Instance attribute	Public	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN		0: false, 1: true	20070719

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_KEY_FIGURE	Instance method	Public	Method		20060814
2	ADD_PLACEHOLDER	Instance method	Public	Method		20080716
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060117
4	CREATE_SXML_WRITABLE	Static method	Public	Method		20061220
5	READ	Static method	Public	Method		20070516
6	REQUEST_ATTRIBUTE	Instance method	Public	Method		20080618
7	REQUEST_ATTRIBUTE_GRANULARITY	Instance method	Public	Method		20080804

Events

Class CL_TREX_AGGREGATE_REQ has no event.

Types

Class CL_TREX_AGGREGATE_REQ has no local type.

Method Signatures

Method ADD_KEY_FIGURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	TREXD_ATTR_NAME		Attribute name	20060814
2	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	TREXD_AGGREGATION_TYPE		Aggregation Type	20060814

Method ADD_KEY_FIGURE on class CL_TREX_AGGREGATE_REQ has no exception.

Method ADD_PLACEHOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Call by reference	☐	Type reference (TYPE)	CLIKE			20080716
2	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	CLIKE			20080716

Method ADD_PLACEHOLDER on class CL_TREX_AGGREGATE_REQ has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUERY	Call by reference	☑	Object reference (TYPE REF TO)	CL_TREX_QUERY		Query	20060117

Method CONSTRUCTOR on class CL_TREX_AGGREGATE_REQ has no exception.

Method CREATE_SXML_WRITABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE_MAP	Call by reference	☐	Type reference (TYPE)	CL_TREX_STRUCTURE=>T_ATTRIBUTE_MAP			20061220
2	Importing	CALCULATION_VIEW	Call by reference	☐	Type reference (TYPE)	STRING			20091028
3	Importing	CALC_MODEL	Call by reference	☐	Type reference (TYPE)	STRING		HANA only: calculation model	20130116
4	Importing	COLUMN_METAS	Call by reference	☐	Type reference (TYPE)	CL_TREX_STRUCTURE=>T_COLUMN_METAS			20061220
5	Importing	COMMIT_ID	Call by reference	☐	Type reference (TYPE)	TREXD_TRANSACTION_ID		Transaction ID	20091123
6	Importing	DEBUG_COMMANDS	Call by reference	☐	Type reference (TYPE)	CHAR128			20080603
7	Importing	FACTOR_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TREXT_FACTOR_ATTRIBUTES		Factor attributes	20061220
8	Importing	FACTOR_KEY_FIGURES	Call by reference	☐	Type reference (TYPE)	TREXT_FACTOR_KEY_FIGURES		Factor key figures	20061220
9	Importing	HAS_NULL_SID	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20061220
10	Importing	HAVING_FILTER	Call by reference	☐	Type reference (TYPE)	STRING			20100215
11	Importing	INDEX_ALIAS_OPERATION	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_ALIAS_OPERATION		index Alias Operation	20061220
12	Importing	INDEX_ID	Call by reference	☐	Type reference (TYPE)	STRING		Index Id	20061220
13	Importing	JOIN_CONDITIONS	Call by reference	☐	Type reference (TYPE)	TREXT_STATIC_JOIN_CONDITION		static join condition	20061220
14	Importing	KEY_FIGURES	Call by reference	☐	Type reference (TYPE)	TREXT_KEY_FIGURE		Key figure	20061220
15	Importing	NULL_SID	Call by reference	☐	Type reference (TYPE)	I			20061220
16	Importing	PLACEHOLDERS	Call by reference	☐	Type reference (TYPE)	TREXT_PLACEHOLDERS		Placeholder	20080716
17	Importing	QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search query	20061220
18	Importing	QUERY_ID	Call by reference	☐	Type reference (TYPE)	TREX_RFC-QUERY_ID		Query Id	20061220
19	Importing	REQUESTED_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TREXT_REQ_ATTRIBUTES_EXT		Attributes	20061220
20	Importing	REQUESTED_RESULTS	Call by reference	☐	Type reference (TYPE)	TREX_RFC-REQUESTED_RESULTS		1: documents 2: statistical info 3: statistical overview	20061220
21	Importing	REQUEST_FLAGS	Call by reference	☐	Type reference (TYPE)	CLIKE			20091213
22	Importing	RESULT_CHUNK_SIZE	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20110407
23	Importing	RESULT_CHUNK_SIZE_ROW	Call by reference	☐	Type reference (TYPE)	INT4		HANA only: result chunk size (number of rows)	20120127
24	Importing	RESULT_FROM	Call by reference	☐	Type reference (TYPE)	I			20061220
25	Importing	RESULT_INDEX_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Index Id	20091119
26	Importing	RESULT_TO	Call by reference	☐	Type reference (TYPE)	I			20061220
27	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	IF_TREX_SXML_WRITABLE_REQ		Request Writable to SXML Writer	20061220
28	Importing	SORT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TREXT_SORT_ATTRIBUTES		Sort attributes	20061220
29	Importing	STAGING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20061220
30	Importing	STAR_COUNT	Call by reference	☐	Type reference (TYPE)	TREXT_STAR_COUNT		Star Count	20061220
31	Importing	TOP_MAX_EQUALS	Call by reference	☐	Type reference (TYPE)	TREX_RFC-MAX_RESULTS			20061220
32	Importing	TOP_TYPE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-TOP_TYPE		Top Type	20061220
33	Importing	TOP_VALUE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-TOP_VALUE			20061220
34	Importing	TRACE	Call by reference	☐	Type reference (TYPE)	NUMC2		Two-Digit Number	20061220
35	Importing	TRACE_COMPONENTS	Call by reference	☐	Type reference (TYPE)	CHAR128		128 character	20061220
36	Importing	USE_DFI	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN		0: false, 1: true	20070719

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20120127

Method READ Signature

Method READ on class CL_TREX_AGGREGATE_REQ has no parameter.
Method READ on class CL_TREX_AGGREGATE_REQ has no exception.

Method REQUEST_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	TREXD_ATTR_NAME		Attribute name	20080618
2	Importing	NODES_AND_LEVELS	Call by reference	☑	Type reference (TYPE)	STRING			20080618

Method REQUEST_ATTRIBUTE on class CL_TREX_AGGREGATE_REQ has no exception.

Method REQUEST_ATTRIBUTE_GRANULARITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GRANULARITY	Call by reference	☐	Type reference (TYPE)	CLIKE			20080804
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	TREXD_ATTR_NAME		Attribute name	20080804

Method REQUEST_ATTRIBUTE_GRANULARITY on class CL_TREX_AGGREGATE_REQ has no exception.

History

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