SAP ABAP Class /PLMB/CL_SPI_QUERY_BY_VIEW (Executes an SPI query using a database view)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-SPI (Application Component) Service Provider Infrastructure
     ⤷ /PLMB/BA_SPI_SERVICES (Package) Service Provider Infrastructure: Services

Properties

Class	/PLMB/CL_SPI_QUERY_BY_VIEW
Short Description	Executes an SPI query using a database view
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/PLMB/BA_SPI_SERVICES	Service Provider Infrastructure: Services
Created	20130717	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ABAP_STRUCTDESCR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class /PLMB/CL_SPI_QUERY_BY_VIEW has no interface implemented.

Friends

Class /PLMB/CL_SPI_QUERY_BY_VIEW has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_AUTHORIZATION_CHECK	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/PLMB/IF_SPI_QUERY_AUTH		SPI query authorization checks	20130722
2	MT_COMP_NAME_MAPPING	Instance attribute	Private	☐	Type reference (TYPE)	GTY_T_COMP_NAME_MAPPING		Mapping table between node and view fieldnames	20130722
3	MV_VIEW_NAME	Instance attribute	Private	☐	Type reference (TYPE)	TABNAME		Database view which will be queried	20130722

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_NUMBER_OF_RESULTS	Instance method	Private	Method	Makes sure the requested number of results is returned	20130722
2	CHECK_AUTHORIZATION	Instance method	Private	Method	Checks if the user has authorizations for the found objects	20130722
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130722
4	ESTIMATE_NUMBER_OF_ROWS	Instance method	Private	Method	Determines how many rows should be selected	20130722
5	FILTER_RESULTS	Instance method	Private	Method	Filters unwanted objects from the results	20130722
6	GENERATE_KEY_FIELDS	Instance method	Private	Method	Generates the key fields for the SQL SELECT statement	20130722
7	GENERATE_ORDER_BY_CLAUSE	Instance method	Private	Method	Generates the ORDER BY clause for the SQL SELECT statement	20130722
8	GENERATE_WHERE_CLAUSE	Instance method	Private	Method	Generates the WHERE clause for the SQL SELECT statement	20130722
9	GET_MAPPED_VIEW_COMPONENT	Instance method	Private	Method	Returns corresponding view component given a node component	20130722
10	QUERY	Instance method	Public	Method	Executes the query	20130722
11	VALIDATE_QUERY_PARAMETERS	Instance method	Private	Method	Validate query parameters	20130722

Events

Class /PLMB/CL_SPI_QUERY_BY_VIEW has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTY_S_COMP_NAME_MAPPING	Public	See coding		Mapping between node and view fieldnames	20130722	BEGIN OF gty_s_comp_name_mapping, comp_name_node TYPE string, comp_name_view TYPE string, END OF gty_s_comp_name_mapping
2	GTY_T_COMP_NAME_MAPPING	Public	See coding		Mapping table between node and view fieldnames	20130722	gty_t_comp_name_mapping TYPE HASHED TABLE OF gty_s_comp_name_mapping WITH UNIQUE KEY comp_name_node

Method Signatures

Method ADJUST_NUMBER_OF_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE_ID	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Result Node ID	20130722
2	Importing	IV_REQU_NUMBER_OF_RESULTS	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_NUMBER_OF_ROWS		Maximum Number of Rows to Be Returned	20130722

Method ADJUST_NUMBER_OF_RESULTS on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method CHECK_AUTHORIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE_ID	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Objects which will be checked (only authed objects remain)	20130722
2	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
3	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_FAILED_IND		Failed Indicator	20130722
4	Exporting	EV_OBJECTS_FILTERED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		true = object(s) have been filtered	20130722

Method CHECK_AUTHORIZATION on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_AUTHORIZATION_CHECK	Call by reference	☑	Object reference (TYPE REF TO)	/PLMB/IF_SPI_QUERY_AUTH		SPI query authorization checks	20130722
2	Importing	IT_COMP_NAME_MAPPING	Call by reference	☑	Type reference (TYPE)	GTY_T_COMP_NAME_MAPPING		Mapping table between node and view fieldnames	20130722
3	Importing	IV_VIEW_NAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Database view which will be queried	20130722

Method CONSTRUCTOR on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method ESTIMATE_NUMBER_OF_ROWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTEMPT	Call by reference	☐	Type reference (TYPE)	SYINDEX		Number of select attempts	20130722
2	Importing	IV_REQUESTED_NUMBER_OF_ROWS	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_NUMBER_OF_ROWS		Maximum Number of Rows to Be Returned	20130722
3	Returning	RV_ESTIMATED_NUMBER_OF_ROWS	Value transfer	☐	Type reference (TYPE)	/PLMB/SPI_NUMBER_OF_ROWS		Maximum Number of Rows to Be Returned	20130722

Method ESTIMATE_NUMBER_OF_ROWS on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method FILTER_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NODE_ID	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Result Node IDs	20130722
2	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
3	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_FAILED_IND		Failed Indicator	20130722
4	Exporting	EV_OBJECTS_FILTERED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		true = object(s) have been filtered	20130722
5	Importing	IT_FILTER_NODE_ID	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		List of Node IDs to Which Result Should be Restricted	20130722

Method FILTER_RESULTS on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method GENERATE_KEY_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_FAILED_IND		Failed Indicator	20130722
3	Exporting	EV_KEY_FIELDS	Call by reference	☐	Type reference (TYPE)	STRING		Key fields for the SELECT statement	20130722
4	Importing	IT_NODE_ID	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Result Node ID	20130722

Method GENERATE_KEY_FIELDS on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method GENERATE_ORDER_BY_CLAUSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_FAILED_IND		Failed Indicator	20130722
3	Exporting	EV_ORDER_BY_CLAUSE	Call by reference	☐	Type reference (TYPE)	STRING		ORDER BY clause for the SELECT statement	20130722
4	Importing	IT_SORT_ORDER	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_SORTORDER		Sort order	20130722

Method GENERATE_ORDER_BY_CLAUSE on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method GENERATE_WHERE_CLAUSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_FAILED_IND		Failed Indicator	20130722
3	Exporting	EV_WHERE_CLAUSE	Call by reference	☐	Type reference (TYPE)	STRING		WHERE clause for the SELECT statement	20130722
4	Importing	IT_SEL_PARAM	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_SELECTION_PARAM		Selection Criteria for Queries	20130722

Method GENERATE_WHERE_CLAUSE on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method GET_MAPPED_VIEW_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMP_NAME_NODE	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Component name for node	20130722
2	Returning	RV_COMP_NAME_VIEW	Value transfer	☐	Type reference (TYPE)	STRING		Component name in database view	20130722

Method GET_MAPPED_VIEW_COMPONENT on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
2	Exporting	ET_NODE_ID	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Result Node ID	20130722
3	Exporting	EV_SEVERITY	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_MSG_SEVERITY		Message Severity	20130722
4	Importing	IS_OPTIONS	Call by reference	☑	Type reference (TYPE)	/PLMB/S_SPI_QUERY_OPTIONS		Query options	20130722
5	Importing	IT_FILTER_NODE_ID	Call by reference	☑	Type reference (TYPE)	INDEX TABLE		List of Node IDs to Which Result Should be Restricted	20130722
6	Importing	IT_SEL_PARAM	Call by reference	☑	Type reference (TYPE)	/PLMB/T_SPI_SELECTION_PARAM		Selection Criteria for Queries	20130722

Method QUERY on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

Method VALIDATE_QUERY_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_MSG		Message	20130722
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	/PLMB/SPI_FAILED_IND		Failed Indicator	20130722
3	Importing	IS_OPTIONS	Call by reference	☐	Type reference (TYPE)	/PLMB/S_SPI_QUERY_OPTIONS		Query options	20130722
4	Importing	IT_SEL_PARAM	Call by reference	☐	Type reference (TYPE)	/PLMB/T_SPI_SELECTION_PARAM		Selection Criteria for Queries	20130722

Method VALIDATE_QUERY_PARAMETERS on class /PLMB/CL_SPI_QUERY_BY_VIEW has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in