SAP ABAP Class CL_FPM_SEARCH_CONFIG_WRITER (Config writer class for SEARCH GUIBB)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_GUIBB (Package) Generic UI building blocks

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_CONFIG_WRITER	Configuration Rerader for OIF	20100622
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FPM_CONFIG_RW_CONSTANTS	Constants for Config Reader / Writer	20100622

Properties

Class	CL_FPM_SEARCH_CONFIG_WRITER
Short Description	Config writer class for SEARCH GUIBB
Super Class	CL_FPM_CONFIG_WRITER	Configuration Rerader for OIF
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	APB_FPM_GUIBB	Generic UI building blocks
Created	20100622	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FPM_CONFIG_RW_CONSTANTS	☐	☐	Constants for Config Reader / Writer	20100622

Friends

Class CL_FPM_SEARCH_CONFIG_WRITER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_BUTTON_ROW_ELEMENT	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_BUTTON_ROW_ELEMENT_INT			20100622
2	MT_EXCLUDED_OPERATORS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_EXCLUDED_OPERATORS_INT			20100622
3	MV_NODE_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100622
4	MV_ROOT_PATH	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100622
5	MV_SEARCH_NODE_ID	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100622
6	TS_T_BUTTON_ACTION	Instance attribute	Public	☐	Attribute reference (LIKE)				20100622
7	TS_T_OPERATORS	Instance attribute	Public	☐	Attribute reference (LIKE)				20100622

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTRIBUTES	Instance method	Public	Method		20100622
2	ADD_BUTTON_ACTION	Instance method	Public	Method	OBSOLET! ButtonRow doesn't exists anymore	20100622
3	ADD_BUTTON_ROW_ELEMENT	Instance method	Public	Method	OBSOLET! ButtonRow doesn't exists anymore	20100622
4	ADD_EXCLUDED_OPERATORS	Instance method	Public	Method		20100622
5	ADD_OPERATORS	Instance method	Public	Method		20100622
6	ADD_PARAMETER	Instance method	Public	Method		20100622
7	ADD_RESULT_GUIBB_LIST	Instance method	Public	Method		20110218
8	ADD_RESULT_TABLE	Instance method	Public	Method		20100622
9	ADD_SEARCH_GROUP	Instance method	Public	Method		20120223
10	CHECK	Instance method	Public	Method		20100622
11	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100622
12	GET_BUTTON_ROW	Instance method	Private	Method		20100622
13	GET_BUTTON_ROW_ELEMENT	Instance method	Private	Method		20100622
14	READ_BUTTON_ROW_ELEMENT	Instance method	Private	Method		20100622
15	READ_EXCLUDE_OPERATORS	Instance method	Private	Method		20100622
16	SAVE	Instance method	Public	Method		20100622
17	SET_SEARCH_ATTRIBUTES	Instance method	Public	Method		20100622
18	SET_SETTINGS_ATTRIBUTES	Instance method	Public	Method		20131223

Events

Class CL_FPM_SEARCH_CONFIG_WRITER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_ATTRIBUTES	Public	See coding			20100622	BEGIN OF ty_s_attributes , name TYPE name_komp, index TYPE fpm_index, text TYPE wdy_conf_transl_text, default_operator TYPE fpmgb_search_operator, group_id_attr TYPE fpmgb_search_group_id, input_prompt TYPE fpm_input_prompt, END OF ty_s_attributes
2	TY_S_BUTTON_ACTION	Public	Attribute reference (LIKE)			20100622
3	TY_S_BUTTON_ACTION_INT	Public	See coding			20100622	BEGIN OF ty_s_button_action_int , event_id TYPE fpmgb_s_action-event_id, text TYPE wdy_conf_transl_text, index TYPE fpmgb_s_action-index, event_parameters TYPE string, event_id_2 TYPE fpmgb_s_action-event_id, path TYPE string, END OF ty_s_button_action_int
4	TY_S_BUTTON_ROW_ELEMENT	Public	See coding			20100622	BEGIN OF ty_s_button_row_element , index TYPE fpm_index, text TYPE wdy_conf_transl_text, element_id TYPE fpm_element_id, special_properties TYPE string, display_type TYPE fpmgb_display_type, END OF ty_s_button_row_element
5	TY_S_BUTTON_ROW_ELEMENT_INT	Public	See coding			20100622	BEGIN OF ty_s_button_row_element_int , index TYPE fpm_index, text TYPE wdy_conf_transl_text, element_id TYPE fpm_element_id, special_properties TYPE string, display_type TYPE fpmgb_display_type, button_action LIKE ts_t_button_action, path TYPE string, END OF ty_s_button_row_element_int
6	TY_S_BUTTON_ROW_ELEMENT_WO_ID	Public	See coding			20100622	BEGIN OF ty_s_button_row_element_wo_id , index TYPE fpm_index, text TYPE wdy_conf_transl_text, special_properties TYPE string, display_type TYPE fpmgb_display_type, END OF ty_s_button_row_element_wo_id
7	TY_S_BUTTON_ROW_INT	Public	See coding			20100622	BEGIN OF ty_s_button_row_int , path TYPE string, END OF ty_s_button_row_int
8	TY_S_EXCLUDED_OPERATORS	Public	See coding			20100622	BEGIN OF ty_s_excluded_operators , attribute TYPE name_komp, END OF ty_s_excluded_operators
9	TY_S_EXCLUDED_OPERATORS_INT	Private	See coding			20100622	BEGIN OF ty_s_excluded_operators_int , attribute TYPE name_komp, path TYPE string, END OF ty_s_excluded_operators_int
10	TY_S_OPERATORS	Public	Attribute reference (LIKE)			20100622
11	TY_S_PARAMETERS	Public	See coding			20100622	BEGIN OF ty_s_parameters , name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, END OF ty_s_parameters
12	TY_S_PARAMETER_INT	Public	See coding			20100622	BEGIN OF ty_s_parameter_int , name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, path TYPE string, END OF ty_s_parameter_int
13	TY_S_RESULT_TABLE	Public	See coding			20100622	BEGIN OF ty_s_result_table , name TYPE name_komp, index TYPE fpm_index, header TYPE wdy_conf_transl_text, display_type TYPE fpmgb_display_type, tag_active TYPE fpmgb_tag_active, END OF ty_s_result_table
14	TY_S_SEARCH_ATTRIBUTES	Public	See coding			20100622	BEGIN OF ty_s_search_attributes , show_button_search TYPE fpmgb_show_button_search, show_button_clear TYPE fpmgb_show_button_clear, number_of_query_lines TYPE fpmgb_num_query_lines, feeder TYPE seoclsname, result_number_of_visible_rows TYPE fpmgb_search_result_num_rows, save_searches TYPE fpmgb_search_enable_save, exclude_criterias TYPE fpmgb_search_exclude_criterias, show_button_reset TYPE fpmgb_show_button_reset, max_number_of_results TYPE fpmgb_max_num_result, show_max_num_result_field TYPE fpmgb_show_max_num_result, group_same_criteria TYPE fpmgb_search_group_same_crit, allow_personalization TYPE fpmgb_search_allow_personal, aria_landmark TYPE fpm_aria_landmark, END OF ty_s_search_attributes
15	TY_S_SEARCH_PARAMETER	Public	See coding			20100622	BEGIN OF ty_s_search_parameter , name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, END OF ty_s_search_parameter
16	TY_S_SETTINGS_ATTR	Public	See coding			20131223	BEGIN OF ty_s_settings_attr, location_saved_searches TYPE wdr_so_location, check_mandatory TYPE fpmgb_check_mandatory, END OF ty_s_settings_attr
17	TY_T_ATTRIBUTES	Public	See coding			20100622	ty_t_attributes TYPE STANDARD TABLE OF ty_s_attributes
18	TY_T_BUTTON_ACTION	Public	Attribute reference (LIKE)			20100622
19	TY_T_BUTTON_ACTION_INT	Public	See coding			20100622	ty_t_button_action_int TYPE STANDARD TABLE OF ty_s_button_action_int
20	TY_T_BUTTON_ROW_ELEMENT	Public	See coding			20100622	ty_t_button_row_element TYPE STANDARD TABLE OF ty_s_button_row_element
21	TY_T_BUTTON_ROW_ELEMENT_INT	Public	See coding			20100622	ty_t_button_row_element_int TYPE STANDARD TABLE OF ty_s_button_row_element_int
22	TY_T_BUTTON_ROW_ELEMENT_WO_ID	Public	See coding			20100622	ty_t_button_row_element_wo_id TYPE STANDARD TABLE OF ty_s_button_row_element_wo_id
23	TY_T_BUTTON_ROW_INT	Public	See coding			20100622	ty_t_button_row_int TYPE STANDARD TABLE OF ty_s_button_row_int
24	TY_T_EXCLUDED_OPERATORS	Public	See coding			20100622	ty_t_excluded_operators TYPE STANDARD TABLE OF ty_s_excluded_operators
25	TY_T_EXCLUDED_OPERATORS_INT	Private	See coding			20100622	ty_t_excluded_operators_int TYPE STANDARD TABLE OF ty_s_excluded_operators_int
26	TY_T_OPERATORS	Public	Attribute reference (LIKE)			20100622
27	TY_T_PARAMETERS	Public	See coding			20100622	ty_t_parameters TYPE STANDARD TABLE OF ty_s_parameters
28	TY_T_PARAMETER_INT	Public	See coding			20100622	ty_t_parameter_int TYPE STANDARD TABLE OF ty_s_parameter_int
29	TY_T_RESULT_TABLE	Public	See coding			20100622	ty_t_result_table TYPE STANDARD TABLE OF ty_s_result_table
30	TY_T_SEARCH_ATTRIBUTES	Public	See coding			20100622	ty_t_search_attributes TYPE STANDARD TABLE OF ty_s_search_attributes
31	TY_T_SEARCH_PARAMETER	Public	See coding			20100622	ty_t_search_parameter TYPE STANDARD TABLE OF ty_s_search_parameter

Method Signatures

Method ADD_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TY_T_ATTRIBUTES		Attributes	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_BUTTON_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BUTTON_ACTION	Call by reference	☐	Type reference (TYPE)	TY_T_BUTTON_ACTION		Button Actions	20100622
2	Importing	IV_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_ELEMENT_ID		FPM: Element ID	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_BUTTON_ROW_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BUTTON_ROW_ELEMENT	Call by reference	☐	Type reference (TYPE)	TY_T_BUTTON_ROW_ELEMENT			20100622
2	Importing	IT_BUTTON_ROW_ELEMENT	Call by reference	☐	Type reference (TYPE)	TY_T_BUTTON_ROW_ELEMENT_WO_ID			20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_EXCLUDED_OPERATORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_EXCLUDED_OPERATORS	Call by reference	☐	Type reference (TYPE)	TY_T_EXCLUDED_OPERATORS		Exclude Operations	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_OPERATORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OPERATORS	Call by reference	☐	Type reference (TYPE)	TY_T_OPERATORS		Exclude Operations	20100622
2	Importing	IV_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Component name	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAMETER	Call by reference	☐	Type reference (TYPE)	TY_T_SEARCH_PARAMETER		Parameters	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_RESULT_GUIBB_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_RESULT_GUIBB_LIST	Call by reference	☐	Type reference (TYPE)	CL_FPM_SEARCH_CONFIG_READER=>TY_S_RESULT_GUIBB_LIST		Result GUIBB List	20110218

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20110218

Method ADD_RESULT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RESULT_TABLE	Call by reference	☐	Type reference (TYPE)	TY_T_RESULT_TABLE		Result Table	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method ADD_SEARCH_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH_GROUP	Call by reference	☐	Type reference (TYPE)	CL_FPM_SEARCH_CONFIG_READER=>TY_T_SEARCH_GROUP		Searcg Group	20120223

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120223

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPM_T_T100_MESSAGES		Messages exported to be dispalyed in popup	20100622
2	Exporting	EV_ERROR	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100622

Method CHECK on class CL_FPM_SEARCH_CONFIG_WRITER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_APPL_WRITER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_APPL_MODIFIER		API Change Application Configuration	20100622
2	Importing	IR_COMP_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_COMP_READER		Read Interface for the Component Configuration	20100622
3	Importing	IR_COMP_WRITER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_COMP_MODIFIER		API Change Component Configuration	20100622
4	Importing	IR_CONFIG_TOOL_COMP	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONFIG_TOOL_COMP		API Configuration Component	20100622
5	Importing	IV_CONFIGURATION_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID		Configuration Identification	20100622
6	Importing	IV_CONFIG_TYPE	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_TYPE		Type of Web Dynpro Configuration	20100622
7	Importing	IV_CREATE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method GET_BUTTON_ROW Signature

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

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method GET_BUTTON_ROW_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BUTTON_ROW_ELEMENT	Call by reference	☐	Type reference (TYPE)	TY_T_BUTTON_ROW_ELEMENT_INT		Button Row Element	20100622
2	Importing	ID_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method READ_BUTTON_ROW_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20100622
2	Importing	IV_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_ELEMENT_ID		Attribute	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method READ_EXCLUDE_OPERATORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20100622
2	Importing	IV_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Attribute	20100622

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20100622

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_ERROR	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100622

Method SAVE on class CL_FPM_SEARCH_CONFIG_WRITER has no exception.

Method SET_SEARCH_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TY_S_SEARCH_ATTRIBUTES		Attributes at node SEARCH	20100622

Method SET_SEARCH_ATTRIBUTES on class CL_FPM_SEARCH_CONFIG_WRITER has no exception.

Method SET_SETTINGS_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SETTINGS_ATTR	Call by reference	☐	Type reference (TYPE)	TY_S_SETTINGS_ATTR			20131223

Method SET_SETTINGS_ATTRIBUTES on class CL_FPM_SEARCH_CONFIG_WRITER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	703