SAP ABAP Class CL_UPARM_QB_VIEW_MANAGER (Manages a view's rules and filters)

Hierarchy

☛ BI_CONT (Software Component) Business Intelligence Content
   ⤷ BW-BCT-PLA-RAP (Application Component) Retail Assortment Planning
     ⤷ UPARM (Package) Retail MAP Master Data Maintenance

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_UPARM_QB_VIEW_MANAGER	Represents a view to be managed by the Query Builder	20090220

Properties

Class	CL_UPARM_QB_VIEW_MANAGER
Short Description	Manages a view's rules and filters
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	20090212	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_UPARM_QB_VIEW_MANAGER	☐	☐	Represents a view to be managed by the Query Builder	20090220

Friends

Class CL_UPARM_QB_VIEW_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_ACTIVE_CONDITION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_RULE		Active Condition	20090218
2	MR_QB_VIEW	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Gives the Query Builder additional data	20090213
3	MTR_ACTIVE_EXCEPTION	Instance attribute	Private	☐	Type reference (TYPE)	UPARM_YT_QB_EXCEPTION		Active Exceptions	20090218
4	MTR_ORIGINAL_RECORD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Original Records	20090224
5	MTR_RULE	Instance attribute	Private	☐	Type reference (TYPE)	UPARM_YT_QB_RULE		Rules which have been persisted already	20090212
6	MT_KEY	Instance attribute	Private	☐	Type reference (TYPE)	UPARM_YT_QB_KEY		Key Table	20090227
7	MV_KEY_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Key Field in the structure of this view	20090223
8	MV_SILENT_MODE	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D		Silent mode for message suppression	20090609
9	MV_STATUS	Instance attribute	Private	☐	Type reference (TYPE)	IF_UPARM_QB_VIEW_MANAGER=>STATUS	'X'	Status can be Active 'X' or Inactive ''.	20090226

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_RULES	Instance method	Public	Method	Adds rules in this View Manager	20090218
2	ADD_RULES_AND_SAVE	Instance method	Public	Method	Adds rules in this View Manager and then saves them to DB	20090221
3	ADD_SIMPLE_CONDITION	Instance method	Public	Method	Adds simple active condition without saving	20090216
4	ADD_SIMPLE_EXCEPTION	Instance method	Public	Method	Adds simple active exception without saving	20090213
5	CONSTRUCTOR	Instance method	Public	Constructor	Needs View ID	20090212
6	EXECUTE_RULES	Instance method	Private	Method	Execules the rules	20090226
7	GET_CONDITIONS	Instance method	Public	Method	Returns the Conditions	20090217
8	GET_EXCEPTIONS	Instance method	Public	Method	Returns the Exceptions	20090217
9	GET_KEY_FIELD	Instance method	Public	Method	Returns the Key Field	20090223
10	GET_QB_VIEW	Instance method	Public	Method	Returns the View interface	20090213
11	LOAD_SAVED_RULES	Instance method	Private	Method	Loads Rules for the View	20090212
12	SAVE	Instance method	Private	Method	Saves the View Manager's Rules	20090216
13	TEST_PURGE_DB	Static method	Public	Method	Purges the DB	20090216
14	Z_READ_BY_ID	Static method	Public	Method	Reads a Rule by ID	20090213
15	Z_SAVE_SIMPLE_RULE	Static method	Public	Method	Builds and saves a 2 level rule w/ AND header filter	20090213
16	Z_TEST_CREATE_FILTERS	Static method	Private	Method	Recursively creates generic filters for testing	20090213
17	Z_TEST_CREATE_SIMPLE_RULE	Static method	Public	Method	Tests method create_simple_rule	20090213
18	Z_TEST_FILL_DB	Static method	Public	Method	Fills the DB with records for testing	20090216

Events

Class CL_UPARM_QB_VIEW_MANAGER has no event.

Types

Class CL_UPARM_QB_VIEW_MANAGER has no local type.

Method Signatures

Method ADD_RULES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITR_RULE	Call by reference	☐	Type reference (TYPE)	UPARM_YT_QB_RULE		List of Rules in the UI	20090218
2	Importing	IV_DELETE_EXISTING_RULES	Call by reference	☑	Type reference (TYPE)	BOOLE_D	''	Should the existing rules be deleted?	20090218

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090218

Method ADD_RULES_AND_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITR_RULE	Call by reference	☐	Type reference (TYPE)	UPARM_YT_QB_RULE		List of Rules in the UI	20090221
2	Importing	IV_DELETE_EXISTING_RULES	Call by reference	☑	Type reference (TYPE)	BOOLE_D	''	Should the existing rules be deleted?	20090221

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090221

Method ADD_SIMPLE_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_COLUMN_FILTER	Call by reference	☐	Type reference (TYPE)	UPARM_YT_COLUMN_FILTER		Table of Column Filter	20090216
2	Importing	IV_DESCR	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RULE_DESC		Description of a Rule	20090216
3	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RULE_STATE		State of the rule can be active ('X') or inactive ('')	20090216
4	Returning	RR_RULE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_RULE		Query Builder - Rule	20090216

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090216

Method ADD_SIMPLE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_EXCEPTION	Call by reference	☐	Type reference (TYPE)	UPARM_YS_EXCEPTION		Denotes a column and how it is affected by a rule when match	20090213
2	Importing	IS_STATE	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RULE_STATE		State of the rule can be active ('X') or inactive ('')	20090213
3	Importing	IT_COLUMN_FILTER	Call by reference	☐	Type reference (TYPE)	UPARM_YT_COLUMN_FILTER		Table of Column Filter	20090213
4	Importing	IV_DESCR	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RULE_DESC		Description of a Rule	20090218
5	Returning	RR_EXCEPTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_EXCEPTION		Query Builder - Exception	20090213

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090213

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_QB_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Represents a view to be managed by the Query Builder	20090213

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090212

Method EXECUTE_RULES 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	20090226
2	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	IF_UPARM_QB_VIEW_MANAGER=>ACTION		Action to be taken on records	20090226

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090226

Method GET_CONDITIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RTR_CONDITION	Value transfer	☐	Type reference (TYPE)	UPARM_YT_QB_RULE		Conditions	20090217

Method GET_CONDITIONS on class CL_UPARM_QB_VIEW_MANAGER has no exception.

Method GET_EXCEPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RTR_EXCEPTION	Value transfer	☐	Type reference (TYPE)	UPARM_YT_QB_EXCEPTION		Exceptions	20090217

Method GET_EXCEPTIONS on class CL_UPARM_QB_VIEW_MANAGER has no exception.

Method GET_KEY_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_KEY_FIELD	Value transfer	☐	Type reference (TYPE)	STRING			20090223

Method GET_KEY_FIELD on class CL_UPARM_QB_VIEW_MANAGER has no exception.

Method GET_QB_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_QB_VIEW	Value transfer	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Represents a view to be managed by the Query Builder	20090213

Method GET_QB_VIEW on class CL_UPARM_QB_VIEW_MANAGER has no exception.

Method LOAD_SAVED_RULES Signature

Method LOAD_SAVED_RULES on class CL_UPARM_QB_VIEW_MANAGER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090220

Method SAVE Signature

Method SAVE on class CL_UPARM_QB_VIEW_MANAGER has no parameter.
Method SAVE on class CL_UPARM_QB_VIEW_MANAGER has no exception.

Method TEST_PURGE_DB Signature

Method TEST_PURGE_DB on class CL_UPARM_QB_VIEW_MANAGER has no parameter.
Method TEST_PURGE_DB on class CL_UPARM_QB_VIEW_MANAGER has no exception.

Method Z_READ_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_QB_ASSISTANT	Call by reference	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Gives the Query Builder additional data	20090213
2	Importing	IV_RULE_ID	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RULE_ID		Unique Rule ID within a view	20090213
3	Returning	RR_RULE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_RULE		Query Builder - Rule	20090213

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090213

Method Z_SAVE_SIMPLE_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_QB_ASSISTANT	Call by reference	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Gives the Query Builder additional data	20090213
2	Importing	IT_COLUMN_FILTER	Call by reference	☐	Type reference (TYPE)	UPARM_YT_COLUMN_FILTER		Table of Column Filter	20090213
3	Importing	IV_DESC	Call by reference	☐	Type reference (TYPE)	UPARM_Y_RULE_DESC		Description of a Rule	20090213
4	Importing	IV_IS_ACTIVE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20090213
5	Importing	IV_VIEW_ID	Call by reference	☐	Type reference (TYPE)	UPARM_Y_VIEW_ID		View ID	20090213
6	Returning	RR_RULE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_RULE		Query Builder - Rule	20090213

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090213

Method Z_TEST_CREATE_FILTERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_QB_ASSISTANT	Call by reference	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Gives the Query Builder additional data	20090213
2	Importing	IR_RULE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_RULE		Query Builder - Rule	20090213
3	Importing	IV_NUM_OF_DEPTH_LVLS	Call by reference	☐	Type reference (TYPE)	I			20090213
4	Importing	IV_NUM_OF_FILTER_PER_LVL	Call by reference	☐	Type reference (TYPE)	I			20090213
5	Returning	RR_FILTER	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_FILTER		Query Builder - Describes the filter to apply on records	20090213

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090213

Method Z_TEST_CREATE_SIMPLE_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_QB_ASSISTANT	Call by reference	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Gives the Query Builder additional data	20090213
2	Importing	IV_NUM_OF_FILTERS	Call by reference	☑	Type reference (TYPE)	I	4		20090213
3	Returning	RR_RULE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UPARM_QB_RULE		Query Builder - Rule	20090213

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090213

Method Z_TEST_FILL_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_QB_ASSISTANT	Call by reference	☐	Object reference (TYPE REF TO)	IF_UPARM_QB_VIEW		Gives the Query Builder additional data	20090216
2	Importing	IV_NUM_OF_DEPTH_LVLS	Call by reference	☐	Type reference (TYPE)	I		Will always create at least one	20090216
3	Importing	IV_NUM_OF_FILTER_PER_LVL	Call by reference	☐	Type reference (TYPE)	I		valid only for depths > 1	20090216
4	Importing	IV_NUM_OF_RULES	Call by reference	☐	Type reference (TYPE)	I			20090216
5	Importing	IV_RULE_DESC_ABBR	Call by reference	☑	Type reference (TYPE)	UPARM_Y_RULE_DESC	'RULE '	Rule ID	20090216
6	Importing	IV_VIEW_ID	Call by reference	☑	Type reference (TYPE)	UPARM_Y_VIEW_ID	'VIEW 1'	View ID	20090216

#	Exception	Resumable	Description	Created on
1	CX_UPARM_QB_ERROR	☐	Query Builder exception	20090216

History

Last changed by/on	SAP	20141101
SAP Release Created in	705