SAP ABAP Class CL_SQF_CONTROLLER (Controller)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL (Application Component) Workbench Utilities
     ⤷ SQF_API (Package) API

Properties

Class	CL_SQF_CONTROLLER
Short Description	Controller
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SQF_API	API
Created	20071123	SAP
Last change	20110908	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_SQF_QUERY_DATA_CONTAINER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_SQF_QUERY_LIST_CONTROL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	SEOR	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SQF_CONTROLLER has no interface implemented.

Friends

Class CL_SQF_CONTROLLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALLOW_CHANGES	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL			20081210
2	ALLOW_CREATION	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL			20081210
3	ALLOW_EXECUTION	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL			20081210
4	CO_EXTERNAL_TOOL	Constant	Public	☐	Type reference (TYPE)	SOBJ_NAME	'CL_SQF_EXTERNAL_TOOL'	Object Name in Object Directory	20081007
5	FILENAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		File name	20071123
6	FULLPATH	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Full path of file	20071123
7	PACKED_XSTRING_LENGTH	Constant	Private	☐	Type reference (TYPE)	I	255	Length of short strings in packed format	20080107
8	QUERIES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SQF_QUERY_LIST		Query set	20071123
9	TOOLS	Static Attribute	Public	☐	Type reference (TYPE)	TY_TOOL_LIST		List of all existing tools	20071123
10	VERSION	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'SQF_2.0'		20080716
11	XML	Instance attribute	Private	☐	Type reference (TYPE)	TY_XML_SOURCE		XML Source	20080314

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_STANDARD_QUERIES	Instance method	Public	Method	Add all queries that have no parameters	20071123
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20071123
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20071123
4	DISPLAY_TOOL_DOCUMENTATION	Static method	Public	Method	Display class documentation of tool class	20071128
5	GENERATE_XML	Instance method	Private	Method		20080314
6	GET_CHANGEMODE	Instance method	Public	Method		20081210
7	GET_FILE_NAME	Instance method	Public	Method	Get the file name of the query set	20071123
8	GET_QUERY_LIST	Instance method	Public	Method	Get list of queries	20071123
9	GET_TOOL	Static method	Public	Method	Get reference of tool by name	20071123
10	GET_UI	Instance method	Public	Method		20080804
11	GET_XML_REPRESENTATION	Instance method	Public	Method		20080709
12	INIT_FROM_XML	Instance method	Public	Method	Initialize with XML-Stream	20080709
13	IS_TOOL_CLASS	Static method	Public	Method	Does a class represent a tool class	20071124
14	LOAD	Instance method	Public	Method	Load query set	20071123
15	NEW	Instance method	Public	Method	New query set	20071125
16	READ_QUERY	Instance method	Private	Method		20080805
17	READ_QUERY_LIST	Instance method	Private	Method		20080805
18	READ_XML	Instance method	Private	Method		20080805
19	SAVE	Instance method	Public	Method	Save query set	20071123
20	SAVE_AS	Instance method	Public	Method	Save query set using a new file name	20071123
21	SET_CHANGEMODE	Instance method	Public	Method		20081210
22	WRITE_CONTENT_PROVIDER_TO_XML	Instance method	Private	Method		20080805
23	WRITE_QUERY_DATA_TO_XML	Instance method	Private	Method		20080805
24	WRITE_QUERY_LIST_TO_XML	Instance method	Private	Method		20080805

Events

Class CL_SQF_CONTROLLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_TOOL	Public	See coding		(Tool name, Reference)	20071123	begin of ty_tool, name type sobj_name, tool type ref to if_sqf_tool, end of ty_tool
2	TY_TOOL_LIST	Public	See coding		List of tools	20071123	ty_tool_list type hashed table of ty_tool with unique key name
3	TY_XML_SOURCE	Public	Type reference (TYPE)	XSTRING	XML Source	20080107

Method Signatures

Method ADD_STANDARD_QUERIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_APPLICATION_COMPONENT	Call by reference	☑	Type reference (TYPE)	UFPS_POSID		Application component ID	20080709

Method ADD_STANDARD_QUERIES on class CL_SQF_CONTROLLER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_SQF_CONTROLLER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SQF_CONTROLLER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☑	Type reference (TYPE)	XSTRING			20080711

Method CONSTRUCTOR on class CL_SQF_CONTROLLER has no exception.

Method DISPLAY_TOOL_DOCUMENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	CLIKE		Class name of the tool	20071128

Method DISPLAY_TOOL_DOCUMENTATION on class CL_SQF_CONTROLLER has no exception.

Method GENERATE_XML Signature

Method GENERATE_XML on class CL_SQF_CONTROLLER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080805
2	CX_SXML_ILLEGAL_ARGUMENT	☐	SXML Illegal Argument Error	20090120
3	CX_SXML_NAME_ERROR	☐	SXML Name Error	20080805
4	CX_SXML_STATE_ERROR	☐	SXML State Error	20080805
5	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080314

Method GET_CHANGEMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ALLOW_CHANGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Allow changes of query parameters	20081210
2	Exporting	EX_ALLOW_CREATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Allow creation of queries	20081210
3	Exporting	EX_ALLOW_EXECUTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Allow execution of queries	20081210

Method GET_CHANGEMODE on class CL_SQF_CONTROLLER has no exception.

Method GET_FILE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_FILE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		File name	20071123

Method GET_FILE_NAME on class CL_SQF_CONTROLLER has no exception.

Method GET_QUERY_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_QUERY_LIST	Value transfer	☐	Object reference (TYPE REF TO)	CL_SQF_QUERY_LIST		Query set	20071123

Method GET_QUERY_LIST on class CL_SQF_CONTROLLER has no exception.

Method GET_TOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	SOBJ_NAME		Name of the tool	20071123
2	Returning	RE_TOOL	Value transfer	☐	Object reference (TYPE REF TO)	IF_SQF_TOOL		Tool for the Support Query Framework	20071123

Method GET_TOOL on class CL_SQF_CONTROLLER has no exception.

Method GET_UI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SQF_QUERY		Query	20080804
2	Importing	IM_TECHNOLOGY	Call by reference	☐	Type reference (TYPE)	I			20080804
3	Returning	RE_UI	Value transfer	☐	Object reference (TYPE REF TO)	I			20080804

Method GET_UI on class CL_SQF_CONTROLLER has no exception.

Method GET_XML_REPRESENTATION Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080815

Method INIT_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20080709

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Exceptions	20080709
2	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080716

Method IS_TOOL_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLASSNAME	Call by reference	☐	Type reference (TYPE)	CLIKE		Name of an ABAP OO Class	20071124
2	Returning	RE_IS_TOOL_CLASS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		'X': The class implements IF_SQF_TOOL	20071124

Method IS_TOOL_CLASS on class CL_SQF_CONTROLLER has no exception.

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20110304

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Exceptions	20071123
2	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080716

Method NEW Signature

Method NEW on class CL_SQF_CONTROLLER has no parameter.
Method NEW on class CL_SQF_CONTROLLER has no exception.

Method READ_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	CL_SQF_QUERY		Query	20080805
2	Importing	IM_READER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SXML_NESTED_XML_READER			20080805

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080815

Method READ_QUERY_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_READER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SXML_NESTED_XML_READER			20080805

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080805
2	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080805

Method READ_XML Signature

Method READ_XML on class CL_SQF_CONTROLLER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080805
2	CX_SXML_ILLEGAL_ARGUMENT	☐	SXML Illegal Argument Error	20080805
3	CX_SXML_STATE_ERROR	☐	SXML State Error	20080805
4	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080805

Method SAVE Signature

Method SAVE on class CL_SQF_CONTROLLER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Exceptions	20071123
2	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080815
3	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080314

Method SAVE_AS Signature

Method SAVE_AS on class CL_SQF_CONTROLLER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Exceptions	20071123
2	CX_SQF_XML_ERROR	☐	Error during data conversion.	20080818

Method SET_CHANGEMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ALLOW_CHANGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Allow changes of query parameters	20081210
2	Importing	IM_ALLOW_CREATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Allow creation of queries	20081210
3	Importing	IM_ALLOW_EXECUTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Allow execution of queries	20081210

Method SET_CHANGEMODE on class CL_SQF_CONTROLLER has no exception.

Method WRITE_CONTENT_PROVIDER_TO_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	CL_SQF_QUERY		Query	20080805
2	Importing	IM_WRITER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_WRITER		SXML Writer Interface	20080805

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080805

Method WRITE_QUERY_DATA_TO_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ITEM	Call by reference	☐	Type reference (TYPE)	CL_SQF_QUERY_DATA_CONTAINER=>TY_ITEM		Query	20080805
2	Importing	IM_WRITER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_WRITER		SXML Writer Interface	20080805

#	Exception	Resumable	Description	Created on
1	CX_SQF_XML_ERROR	☐	cx_sqf_xml_error	20080805
2	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080805

Method WRITE_QUERY_LIST_TO_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_WRITER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_WRITER		SXML Writer Interface	20080805

#	Exception	Resumable	Description	Created on
1	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080805

History

Last changed by/on	SAP	20110908
SAP Release Created in	711