SAP ABAP Class IF_SQF_QUERY (Query)
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface composition (i COMPRISING i_ref)  IF_SQF_CONTENT_PROVIDER Query 20080731
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SQF_QUERY Query 20080731
Properties
Class IF_SQF_QUERY  
Short Description Query    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package      
Created 20071119   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 IF_SQF_QUERY Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class IF_SQF_QUERY has no interface implemented.
Friends
Class IF_SQF_QUERY has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_STATE Constant Public See coding Query State 20071122
2 ID Instance attribute Public Type reference (TYPE) I Id 20080314
3 PROTOCOL Instance attribute Public Object reference (TYPE REF TO) IF_SQF_PROTOCOL Protocol 20080328
4 QUERY_DATA Instance attribute Public Object reference (TYPE REF TO) IF_SQF_QUERY_DATA_CONTAINER Container for query data 20080314
5 QUERY_LIST_CONTROL Instance attribute Public Object reference (TYPE REF TO) IF_SQF_QUERY_LIST_CONTROL Control of query list 20080703
Methods
# Method Level Visibility Method type Description Created on
1 CHANGE_STATE Instance method Public Method Change State 20080703
2 CLEAR_RESULT_LIST Instance method Public Method Clear result list 20080806
3 CONTENT_PROVIDER_AVAILABLE Instance method Public Method ABAP_TRUE <=> Content provider functionality is available 20080801
4 DECLARE_PARAMETERS Instance method Public Method Declare parameter list 20080815
5 DECLARE_PARAM_AS_FLAG Instance method Public Method Declare a parameter 20080819
6 DECLARE_PARAM_BY_DATATYPE Instance method Public Method Declare a parameter 20080819
7 DECLARE_PARAM_BY_STRUCTURE Instance method Public Method Declare all fields of a structure as parameters 20080801
8 DECLARE_PARAM_BY_TABLE_FIELD Instance method Public Method Declare table field as parameter 20080801
9 DECLARE_SEPARATOR Instance method Public Method Add a separator 20080930
10 GET_DESCRIPTION Instance method Public Method Get the short description of the query 20071119
11 GET_EXECUTION_INFO Instance method Public Method Get execution details 20080925
12 GET_ID Instance method Public Method Get the query id 20071218
13 GET_PARAMETER Instance method Public Method Get parameter 20080807
14 GET_PARAMETERS Instance method Public Method Get parameters 20080801
15 GET_PARAMETER_RANGE Instance method Public Method Get parameter as range 20090203
16 GET_PARAMETER_VALUE Instance method Public Method Get parameter 20080807
17 GET_RESULT Instance method Public Method Set Result 20080808
18 GET_RESULT_LIST Instance method Public Method Get result list 20080801
19 GET_STATE Instance method Public Method Get state of the query 20071122
20 GET_TOOL Instance method Public Method Get the reference of the corresponding tool 20071123
21 GET_TOOL_NAME Instance method Public Method Get the name of the corresponding tool 20080806
22 INIT Instance method Public Method Initialize the query 20071122
23 SET_DESCRIPTION Instance method Public Method Set a short description of the query 20080801
24 SET_PARAMETER Instance method Public Method Set parameter 20080926
25 SET_PARAMETERS Instance method Public Method Set parameters 20080801
26 SET_PARAMETER_RANGE Instance method Public Method Set parameter from a range 20090203
27 SET_PARAMETER_VALUE Instance method Public Method Set parameter 20080926
28 SET_RESULT Instance method Public Method Set Result 20080808
Events
# Event Type Visibility Description Created on
1 STATE_CHANGED Instance Event
(0) 		Public
(2) 		State changed 20080703
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_OPERATION Public See coding (Operation code, Operation text) 20080115 begin of ty_operation, fcode type ui_func, text type gui_text, end of ty_operation
2 TY_OPERATION_LIST Public See coding List of Operations 20080115 ty_operation_list type standard table of ty_operation with default key
3 TY_PARAMETER Public See coding 20080801 begin of ty_parameter, def type ty_parameter_def, display_in_result type abap_bool, show_output_flag type abap_bool, allow_complex_selection type abap_bool, show_range type abap_bool, is_separator type abap_bool, texts type sqf_texts, end of ty_parameter
4 TY_PARAMETER_DEF Public See coding 20080818 begin of ty_parameter_def, " excerpt from dd03p... tabname type tabname, fieldname type fieldname, keyflag type keyflag, datatype type datatype_d, leng type ddleng, lowercase type lowercase, inttype type inttype, intlen type intlen, decimals type decimals, outputlen type outputlen, is_ddic_type type abap_bool, end of ty_parameter_def
5 TY_PARAMETER_LIST Public See coding 20080801 ty_parameter_list type standard table of ty_parameter
6 TY_RANGE Public See coding 20080801 ty_range type range of string
7 TY_RANGE_LINE Public See coding 20080801 ty_range_line type line of ty_range
8 TY_SELECTION Public See coding 20080801 begin of ty_selection, tabname type tabname, fieldname type fieldname, output type abap_bool, " abap_true <=> field is not contained in the result, and therefore not displayed hide type abap_bool, " abap_true <=> field is present in result, but hidden in the display extended type abap_bool, range type ty_range, end of ty_selection
9 TY_SELECTIONS Public See coding 20080801 ty_selections type table of ty_selection with key tabname fieldname
Method Signatures

Method CHANGE_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_NEW_STATE Call by reference Type reference (TYPE) SQF_QUERY_STATE Query State 20080703
# Exception Resumable Description Created on
1 CX_SQF_INVALID_STATE Invalid state 20080703

Method CLEAR_RESULT_LIST Signature

Method CLEAR_RESULT_LIST on class IF_SQF_QUERY has no parameter.
Method CLEAR_RESULT_LIST on class IF_SQF_QUERY has no exception.

Method CONTENT_PROVIDER_AVAILABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_CONTENT_PROVIDER_AVAILABLE Value transfer Type reference (TYPE) ABAP_BOOL 20080801

Method CONTENT_PROVIDER_AVAILABLE on class IF_SQF_QUERY has no exception.

Method DECLARE_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_PARAMETER_LIST Call by reference Type reference (TYPE) TY_PARAMETER_LIST 20080815

Method DECLARE_PARAMETERS on class IF_SQF_QUERY has no exception.

Method DECLARE_PARAM_AS_FLAG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field Name 20080819
2 Importing IM_MSGV1 Call by reference Type reference (TYPE) CLIKE 20080819
3 Importing IM_MSGV2 Call by reference Type reference (TYPE) CLIKE 20080819
4 Importing IM_MSGV3 Call by reference Type reference (TYPE) CLIKE 20080819
5 Importing IM_MSGV4 Call by reference Type reference (TYPE) CLIKE 20080819
6 Importing IM_SHOW_OUTPUT_FLAG Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080819
7 Importing IM_TEXTID Call by reference Type reference (TYPE) TEXTPOOLKY Text element key (number/selection name) 20080819
# Exception Resumable Description Created on
1 CX_SQF_QUERY_ERROR Query errors 20080819

Method DECLARE_PARAM_BY_DATATYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ALLOW_COMPLEX_SELECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080819
2 Importing IM_DATATYPE Call by reference Type reference (TYPE) DATATYPE_D Data Type in ABAP Dictionary 20080819
3 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field Name 20080819
4 Importing IM_LOWER_CASE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080923
5 Importing IM_MAX_LENGTH Call by reference Type reference (TYPE) I 20080923
6 Importing IM_MSGV1 Call by reference Type reference (TYPE) CLIKE 20080819
7 Importing IM_MSGV2 Call by reference Type reference (TYPE) CLIKE 20080819
8 Importing IM_MSGV3 Call by reference Type reference (TYPE) CLIKE 20080819
9 Importing IM_MSGV4 Call by reference Type reference (TYPE) CLIKE 20080819
10 Importing IM_RANGE_SELECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080819
11 Importing IM_SHOW_OUTPUT_FLAG Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080819
12 Importing IM_TEXTID Call by reference Type reference (TYPE) TEXTPOOLKY Text element key (number/selection name) 20080819
# Exception Resumable Description Created on
1 CX_SQF_QUERY_ERROR Query errors 20080819

Method DECLARE_PARAM_BY_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ALLOW_COMPLEX_SELECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080801
2 Importing IM_EXCLUDE_CLIENT_FIELD Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080801
3 Importing IM_RANGE_SELECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080801
4 Importing IM_SHOW_OUTPUT_FLAG Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080807
5 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table Name 20080801
# Exception Resumable Description Created on
1 CX_SQF_QUERY_ERROR Query errors 20080804

Method DECLARE_PARAM_BY_TABLE_FIELD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ALLOW_COMPLEX_SELECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080801
2 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field Name 20080801
3 Importing IM_RANGE_SELECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20080801
4 Importing IM_SHOW_OUTPUT_FLAG Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080807
5 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table Name 20080801
# Exception Resumable Description Created on
1 CX_SQF_QUERY_ERROR Query errors 20080804

Method DECLARE_SEPARATOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_CATEGORY Call by reference Type reference (TYPE) CLIKE Category 20080930
2 Importing IM_MSGV1 Call by reference Type reference (TYPE) CLIKE 20080930
3 Importing IM_MSGV2 Call by reference Type reference (TYPE) CLIKE 20080930
4 Importing IM_MSGV3 Call by reference Type reference (TYPE) CLIKE 20080930
5 Importing IM_MSGV4 Call by reference Type reference (TYPE) CLIKE 20080930
6 Importing IM_TEXTID Call by reference Type reference (TYPE) TEXTPOOLKY Text element key (number/selection name) 20080930

Method DECLARE_SEPARATOR on class IF_SQF_QUERY has no exception.

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_DESCRIPTION Value transfer Type reference (TYPE) STRING Short description 20071119

Method GET_DESCRIPTION on class IF_SQF_QUERY has no exception.

Method GET_EXECUTION_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_EXEC_MANDT Call by reference Type reference (TYPE) SY-MANDT Client ID of Current User 20080925
2 Exporting EX_EXEC_START Call by reference Type reference (TYPE) TIMESTAMP UTC Time Stamp in Short Form (YYYYMMDDhhmmss) 20100212
3 Exporting EX_EXEC_SYSTEM Call by reference Type reference (TYPE) SY-SYSID Name of the SAP System 20080925
4 Exporting EX_EXEC_TIME Call by reference Type reference (TYPE) TZNTSTMPL UTC time stamp in long form (YYYYMMDDhhmmss,mmmuuun) 20100212
5 Exporting EX_EXEC_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMP UTC Time Stamp in Short Form (YYYYMMDDhhmmss) 20080925
6 Exporting EX_EXEC_USER Call by reference Type reference (TYPE) SY-UNAME User Name 20080925

Method GET_EXECUTION_INFO on class IF_SQF_QUERY has no exception.

Method GET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_ID Value transfer Type reference (TYPE) I Query id 20071218

Method GET_ID on class IF_SQF_QUERY has no exception.

Method GET_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_PARAMETER Call by reference Type reference (TYPE) IF_SQF_QUERY=>TY_PARAMETER Web Dynpro Tools Property Box: Table with Properties 20080807
2 Exporting EX_SELECTION Call by reference Type reference (TYPE) IF_SQF_QUERY=>TY_SELECTION 20080807
3 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field name 20080807
4 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table name 20080923

Method GET_PARAMETER on class IF_SQF_QUERY has no exception.

Method GET_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_PARAMETERS Call by reference Type reference (TYPE) IF_SQF_QUERY=>TY_PARAMETER_LIST Web Dynpro Tools Property Box: Table with Properties 20080801
2 Exporting EX_SELECTIONS Call by reference Type reference (TYPE) IF_SQF_QUERY=>TY_SELECTIONS 20080804

Method GET_PARAMETERS on class IF_SQF_QUERY has no exception.

Method GET_PARAMETER_RANGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_RANGE Call by reference Type reference (TYPE) TABLE A Range 20090203
2 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field name 20090203
3 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table name 20090203

Method GET_PARAMETER_RANGE on class IF_SQF_QUERY has no exception.

Method GET_PARAMETER_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field name 20080807
2 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table name 20080923
3 Returning RE_VALUE Value transfer Type reference (TYPE) STRING 20080807

Method GET_PARAMETER_VALUE on class IF_SQF_QUERY has no exception.

Method GET_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ID Call by reference Type reference (TYPE) SOBJ_NAME Object Name in Object Directory 20080808
2 Returning RE_RESULT Value transfer Object reference (TYPE REF TO) IF_SQF_RESULT Result 20080808

Method GET_RESULT on class IF_SQF_QUERY has no exception.

Method GET_RESULT_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_RESULT_LIST Value transfer Object reference (TYPE REF TO) IF_SQF_RESULT_LIST Result list 20080801

Method GET_RESULT_LIST on class IF_SQF_QUERY has no exception.

Method GET_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_STATE Value transfer Type reference (TYPE) SQF_QUERY_STATE Query State 20071122

Method GET_STATE on class IF_SQF_QUERY has no exception.

Method GET_TOOL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 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 IF_SQF_QUERY has no exception.

Method GET_TOOL_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_TOOL_NAME Value transfer Type reference (TYPE) SOBJ_NAME Tool for the Support Query Framework 20080806

Method GET_TOOL_NAME on class IF_SQF_QUERY has no exception.

Method INIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_TOOL_NAME Call by reference Type reference (TYPE) SOBJ_NAME Object Name in Object Directory 20080805

Method INIT on class IF_SQF_QUERY has no exception.

Method SET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ID Call by reference Type reference (TYPE) TEXTPOOLID 'I' ABAP/4 text pool ID (selection text/numbered text) 20080801
2 Importing IM_KEY Call by reference Type reference (TYPE) TEXTPOOLKY Text element key (number/selection name) 20080801
3 Importing IM_MSGV1 Call by reference Type reference (TYPE) CLIKE #textid or & or Text 20080801
4 Importing IM_MSGV2 Call by reference Type reference (TYPE) CLIKE #textid or & or Text 20080801
5 Importing IM_MSGV3 Call by reference Type reference (TYPE) CLIKE #textid or & or Text 20080801
6 Importing IM_MSGV4 Call by reference Type reference (TYPE) CLIKE #textid or & or Text 20080801

Method SET_DESCRIPTION on class IF_SQF_QUERY has no exception.

Method SET_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field name 20080926
2 Importing IM_SELECTION Call by reference Type reference (TYPE) IF_SQF_QUERY=>TY_SELECTION 20080926
3 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table name 20080926

Method SET_PARAMETER on class IF_SQF_QUERY has no exception.

Method SET_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_SELECTIONS Call by reference Type reference (TYPE) IF_SQF_QUERY=>TY_SELECTIONS Web Dynpro Tools Property Box: Table with Properties 20080804
# Exception Resumable Description Created on
1 CX_SQF_INVALID_STATE Invalid state 20080801

Method SET_PARAMETER_RANGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field name 20090203
2 Importing IM_RANGE Call by reference Type reference (TYPE) TABLE A Range 20090203
3 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table name 20090203

Method SET_PARAMETER_RANGE on class IF_SQF_QUERY has no exception.

Method SET_PARAMETER_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_FIELDNAME Call by reference Type reference (TYPE) CLIKE Field name 20080926
2 Importing IM_TABNAME Call by reference Type reference (TYPE) CLIKE Table name 20080926
3 Importing IM_VALUE Call by reference Type reference (TYPE) ANY 20080926

Method SET_PARAMETER_VALUE on class IF_SQF_QUERY has no exception.

Method SET_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_DEFAULT_RESULT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 'X' : Result is to be displayed initially 20081110
2 Importing IM_ID Call by reference Type reference (TYPE) SOBJ_NAME Object Name in Object Directory 20080808
3 Importing IM_RESULT Value transfer Object reference (TYPE REF TO) IF_SQF_RESULT Result 20080808

Method SET_RESULT on class IF_SQF_QUERY has no exception.
Event Signatures

Event STATE_CHANGED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IM_ID Exporting Value transfer Type reference (TYPE) I 20080703
History
Last changed by/on SAP  20130531 
SAP Release Created in