SAP ABAP Class CL_UPARM_QB_FILTER (Query Builder - Describes the filter to apply on records)
Hierarchy
☛ BI_CONT (Software Component) Business Intelligence Content
   ⤷ BW-BCT-PLA-RAP (Application Component) Retail Assortment Planning
     ⤷ UPARM (Package) Retail MAP Master Data Maintenance
Properties
Class CL_UPARM_QB_FILTER  
Short Description Query Builder - Describes the filter to apply on records    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package UPARM   Retail MAP Master Data Maintenance 
Created 20090202   SAP 
Last change 20141101    
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_UPARM_QB_FILTER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_UPARM_QB_VIEW_MANAGER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_UPARM_QB_FILTER has no interface implemented.
Friends
Class CL_UPARM_QB_FILTER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MR_RULE Instance attribute Private Object reference (TYPE REF TO) CL_UPARM_QB_RULE Query Builder - Rule 20090210
2 MS_FILTER Instance attribute Private Type reference (TYPE) UPARM_TA_FILTER Column Filter 20090204
3 MTR_CHILD_FILTER Instance attribute Private See coding Child Filters 20090202
4 MTR_FILTERED_RECORD Instance attribute Private Object reference (TYPE REF TO) DATA Filtered Records from last execution 20090224
5 MV_RUNTIME_COL_ID Instance attribute Private Type reference (TYPE) STRING Name of the Column during runtime 20090227
Methods
# Method Level Visibility Method type Description Created on
1 ADD_CHILD_FILTER Instance method Public Method Adds a child filter to the collection 20090203
2 BETWEEN Instance method Private Method Between: Range of Values 20090211
3 BOT_N Instance method Private Method Bottom N 20090211
4 BOT_PERCENT Instance method Private Method Bottom % 20090211
5 BOT_TOTAL Instance method Private Method Bottom Total 20090211
6 CONSTRUCTOR Instance method Public Constructor Performs initialization of a filter 20090203
7 CONTAINS Instance method Private Method Contains Pattern: Masked Input: Find Pattern 20090211
8 DELETE Instance method Private Method Executes filter knowing deleted records 20090225
9 EQUAL Instance method Private Method Equal: The Specified Single Value 20090211
10 EXCLUDE_BOT_TOTAL Instance method Private Method Exclude Bottom Total 20090211
11 EXCLUDE_TOP_TOTAL Instance method Private Method Exclude Top Total 20090211
12 EXECUTE Instance method Public Method Executes all sub-filters then applies logical operation 20090202
13 FILTER Instance method Private Method Filter the records according to the filter 20090202
14 GET_CHILD_FILTERS Instance method Public Method Returns the child filters 20090204
15 GET_CHILD_HEADERS Instance method Public Method Flattens the rule's filters to the DB struc 20090217
16 GET_HEADER Instance method Public Method Returns the header of the filter 20090204
17 GREATER_OR_EQUAL Instance method Private Method Greater or Equal: Everything >= Value in Field low_value 20090211
18 GREATER_THAN Instance method Private Method Greater Than: Everything > Value in Field low_value 20090211
19 HAS_CHILD Instance method Private Method Returns True if has at least one child 20090224
20 INSERT Instance method Private Method Executes filter knowing inserted records 20090224
21 IS_ANY_CHILD_RELATIVE Instance method Private Method Returns True if any child is Relative 20090224
22 IS_RELATIVE Instance method Private Method Returns true is the operand is Relative 20090221
23 LESS_OR_EQUAL Instance method Private Method Less or Equal: Everything <= Value in Field low_value 20090211
24 LESS_THAN Instance method Private Method Less Than: Everything < Value in Field low_value 20090211
25 MODIFY Instance method Private Method Executes filter knowing modified records 20090225
26 NEW Instance method Private Method Executes filter knowing new records 20090224
27 NOT_BETWEEN Instance method Private Method Not Between: Everything Outside the Range 20090211
28 NOT_CONTAINS Instance method Private Method Not Contains Pattern: Masked Input: Reject Pattern 20090211
29 NOT_EQUAL Instance method Private Method Not Equal: Everything Apart from the Specified Single Value 20090211
30 OPERATE Instance method Private Method Applies the operand on all child records 20090202
31 TOP_N Instance method Private Method Top N 20090211
32 TOP_PERCENT Instance method Private Method Top % 20090211
33 TOP_TOTAL Instance method Private Method Top Total 20090211
34 VALIDATE Instance method Private Method Validates the filter 20090218
Events
Class CL_UPARM_QB_FILTER has no event.
Types
Class CL_UPARM_QB_FILTER has no local type.
Method Signatures

Method ADD_CHILD_FILTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_FILTER Call by reference Object reference (TYPE REF TO) CL_UPARM_QB_FILTER Query Builder - Describes the filter to apply on records 20090203

Method ADD_CHILD_FILTER on class CL_UPARM_QB_FILTER has no exception.

Method BETWEEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211

Method BETWEEN on class CL_UPARM_QB_FILTER has no exception.

Method BOT_N Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method BOT_PERCENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method BOT_TOTAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_RULE Call by reference Object reference (TYPE REF TO) CL_UPARM_QB_RULE Query Builder - Rule 20090210
2 Importing IS_FILTER Call by reference Type reference (TYPE) UPARM_TA_FILTER Filter used within a rule to filter records 20090204
3 Importing IT_FILTER Call by reference Type reference (TYPE) UPARM_YT_FILTER Table type of UPARM_TA_FILTER 20090205
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090210

Method CONTAINS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE Records which have just been 20090225
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Resulting records from the filter 20090225
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090225

Method EQUAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method EXCLUDE_BOT_TOTAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method EXCLUDE_TOP_TOTAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method EXECUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE Records which have just been 20090224
2 Importing IV_ACTION Call by reference Type reference (TYPE) IF_UPARM_QB_VIEW_MANAGER=>ACTION Action performed on records (New, Insert, Modify, Delete) 20090224
3 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Resulting records from the filter 20090209
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090203

Method FILTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_MODIFIED_RECORD Call by reference Type reference (TYPE) TABLE Records on which the Rules will be applied 20090224
2 Importing IV_RECORDS_HAVE_BEEN_DELETED Call by reference Type reference (TYPE) ABAP_BOOL '' Have any records been deleted? 20090224
3 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090210
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090202

Method GET_CHILD_FILTERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RTR_FILTER Value transfer Type reference (TYPE) UPARM_YT_QB_FILTER Table type of ref to cl_uparm_qb_filter 20090204

Method GET_CHILD_FILTERS on class CL_UPARM_QB_FILTER has no exception.

Method GET_CHILD_HEADERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FILTER Value transfer Type reference (TYPE) UPARM_YT_FILTER Table type of UPARM_TA_FILTER 20090217

Method GET_CHILD_HEADERS on class CL_UPARM_QB_FILTER has no exception.

Method GET_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_FILTER Value transfer Type reference (TYPE) UPARM_TA_FILTER Filter used within a rule to filter records 20090204

Method GET_HEADER on class CL_UPARM_QB_FILTER has no exception.

Method GREATER_OR_EQUAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method GREATER_THAN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method HAS_CHILD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_HAS_CHILD Value transfer Type reference (TYPE) ABAP_BOOL Is the filter Relative 20090224

Method HAS_CHILD on class CL_UPARM_QB_FILTER has no exception.

Method INSERT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE Records which have just been 20090224
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Resulting records from the filter 20090224
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090224

Method IS_ANY_CHILD_RELATIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RELATIVE Value transfer Type reference (TYPE) ABAP_BOOL Is the filter Relative 20090224

Method IS_ANY_CHILD_RELATIVE on class CL_UPARM_QB_FILTER has no exception.

Method IS_RELATIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RELATIVE Value transfer Type reference (TYPE) ABAP_BOOL Is the filter Relative 20090221

Method IS_RELATIVE on class CL_UPARM_QB_FILTER has no exception.

Method LESS_OR_EQUAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method LESS_THAN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method MODIFY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE Records which have just been 20090225
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Resulting records from the filter 20090225
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090225

Method NEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE Records which have just been 20090224
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Resulting records from the filter 20090224
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090224

Method NOT_BETWEEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method NOT_CONTAINS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method NOT_EQUAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method OPERATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_EXISTING_RECORDS Call by reference Type reference (TYPE) TABLE Records which have already been operated on 20090210
2 Importing IT_NEW_RECORDS Call by reference Type reference (TYPE) TABLE New records to be operated on 20090210
3 Returning RT_RECORDS Value transfer Object reference (TYPE REF TO) DATA Resulting records from operate 20090210
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090202

Method TOP_N Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method TOP_PERCENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method TOP_TOTAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RECORD Call by reference Type reference (TYPE) TABLE To be filtered 20090211
2 Returning RT_RECORD Value transfer Object reference (TYPE REF TO) DATA Filtered 20090211
# Exception Resumable Description Created on
1 CX_DYNAMIC_CHECK Exceptions with Dynamic Check Only of the RAISING Clause 20090223

Method VALIDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_RULE Call by reference Object reference (TYPE REF TO) CL_UPARM_QB_RULE Query Builder - Rule 20090218
2 Importing IS_FILTER Call by reference Type reference (TYPE) UPARM_TA_FILTER Filter used within a rule to filter records 20090218
# Exception Resumable Description Created on
1 CX_UPARM_QB_ERROR Query Builder exception 20090218
History
Last changed by/on SAP  20141101 
SAP Release Created in 705