SAP ABAP Class IF_FPM_GUIBB_SEARCH_CONFIG (default configuration)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FPM_GUIBB_LAYOUT_API_SEARCH | Layout Config Search UIBB | 20110530 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FPM_GUIBB_SEARCH_CONFIG | default config for the search uibb | 20090324 |
Properties
| Class | IF_FPM_GUIBB_SEARCH_CONFIG | |
| Short Description | default configuration | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20090323 | SAP |
| Last change | 20141120 | |
| 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_FPM_GUIBB_SEARCH_CONFIG |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class IF_FPM_GUIBB_SEARCH_CONFIG has no interface implemented.
Friends
Class IF_FPM_GUIBB_SEARCH_CONFIG has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MS_SEARCH_CONTEXT |
Instance attribute | Public | Type reference (TYPE) | TY_S_SEARCH_CONTEXT | 20130607 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_ATTRIBUTE |
Instance method | Public | Method | 20090323 | |
| 2 | ADD_PARAMETER |
Instance method | Public | Method | 20090323 | |
| 3 | ADD_RESULT_COLUMN |
Instance method | Public | Method | 20090325 | |
| 4 | ADD_RESULT_GUIBB_LIST |
Instance method | Public | Method | 20110104 | |
| 5 | ADD_SEARCH_GROUP |
Instance method | Public | Method | 20120530 | |
| 6 | GET_ATTRIBUTES |
Instance method | Public | Method | 20090323 | |
| 7 | GET_EXCLUDED_OPERATORS |
Instance method | Public | Method | 20090323 | |
| 8 | GET_PARAMETER |
Instance method | Public | Method | 20090323 | |
| 9 | GET_RESULT_COLUMNS |
Instance method | Public | Method | 20090323 | |
| 10 | GET_RESULT_GUIBB_LIST |
Instance method | Public | Method | 20120530 | |
| 11 | GET_SEARCH_GROUPS |
Instance method | Public | Method | 20120530 | |
| 12 | GET_SETTINGS |
Instance method | Public | Method | 20120529 | |
| 13 | SET_EXCLUDED_OPERATORS |
Instance method | Public | Method | 20090323 | |
| 14 | SET_SETTINGS |
Instance method | Public | Method | 20120529 |
Events
Class IF_FPM_GUIBB_SEARCH_CONFIG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_ADD_SETTINGS | Public | See coding | 20140110 | BEGIN OF ty_s_add_settings,
location_saved_searches TYPE wdr_so_location,
check_mandatory TYPE fpmgb_check_mandatory,
END OF ty_s_add_settings
|
||
| 2 | TY_S_ATTRIBUTE | Public | See coding | 20090323 | BEGIN OF ty_s_attribute,
name TYPE name_komp,
index TYPE wdy_conf_index,
element_id TYPE fpm_element_id,
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_attribute
|
||
| 3 | TY_S_EXCLUDED_OPERATOR | Public | See coding | 20090323 | BEGIN OF ty_s_excluded_operator,
name TYPE name_komp,
operators TYPE ty_t_operator,
END OF ty_s_excluded_operator
|
||
| 4 | TY_S_OPERATOR | Public | See coding | 20090323 | BEGIN OF ty_s_operator,
operator_id TYPE fpmgb_search_operator,
END OF ty_s_operator
|
||
| 5 | TY_S_PARAMETER | Public | See coding | 20090323 | BEGIN OF ty_s_parameter ,
name TYPE fpmgb_parameter_name,
value TYPE fpmgb_parameter_value,
END OF ty_s_parameter
|
||
| 6 | TY_S_RESULT_COL | Public | See coding | 20090323 | BEGIN OF ty_s_result_col,
name TYPE name_komp,
index TYPE wdy_conf_index,
header TYPE wdy_conf_transl_text,
element_id TYPE fpm_element_id,
display_type TYPE fpmgb_display_type,
tag_active TYPE fpmgb_tag_active,
width TYPE fpmgb_search_res_width,
END OF ty_s_result_col
|
||
| 7 | TY_S_RESULT_GUIBB_LIST | Public | See coding | 20120530 | BEGIN OF ty_s_result_guibb_list,
component TYPE fpm_component_name,
interface_view TYPE fpm_window_name,
config_id TYPE wdy_config_id,
config_type TYPE wdy_config_type,
config_var TYPE wdy_config_var,
instance_id TYPE fpm_instance_id,
hidden TYPE fpm_hidden,
END OF ty_s_result_guibb_list
|
||
| 8 | TY_S_SEARCH_CONTEXT | Public | See coding | 20130607 | BEGIN OF ty_s_search_context,
has_text_search TYPE abap_bool,
END OF ty_s_search_context
|
||
| 9 | TY_S_SEARCH_GROUP | Public | See coding | 20120530 | BEGIN OF ty_s_search_group,
element_id TYPE fpm_element_id,
group_id TYPE fpmgb_search_group_id,
group_title TYPE fpmgb_search_group_title,
index TYPE wdy_conf_index,
group_number_of_search_lines TYPE fpmgb_num_query_lines,
expandable TYPE fpmgb_search_expandable,
expand_on_open TYPE fpmgb_search_expand_on_open,
END OF ty_s_search_group
|
||
| 10 | TY_S_SETTINGS | Public | See coding | 20120529 | BEGIN OF ty_s_settings,
number_of_query_lines TYPE fpmgb_num_query_lines,
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_search TYPE fpmgb_show_button_search,
show_button_clear TYPE fpmgb_show_button_clear,
show_button_reset TYPE fpmgb_show_button_reset,
show_max_num_result_field TYPE fpmgb_show_max_num_result,
max_number_of_results TYPE fpmgb_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_settings
|
||
| 11 | TY_T_ATTRIBUTE | Public | See coding | 20090323 | ty_t_attribute TYPE STANDARD TABLE OF ty_s_attribute
|
||
| 12 | TY_T_EXCLUDED_OPERATOR | Public | See coding | 20090323 | ty_t_excluded_operator TYPE STANDARD TABLE OF ty_s_excluded_operator
|
||
| 13 | TY_T_OPERATOR | Public | See coding | 20090323 | ty_t_operator TYPE STANDARD TABLE OF ty_s_operator WITH DEFAULT KEY
|
||
| 14 | TY_T_PARAMETER | Public | See coding | 20090323 | ty_t_parameter TYPE STANDARD TABLE OF ty_s_parameter
|
||
| 15 | TY_T_RESULT_COL | Public | See coding | 20090323 | ty_t_result_col TYPE STANDARD TABLE OF ty_s_result_col WITH DEFAULT KEY
|
||
| 16 | TY_T_SEARCH_GROUP | Public | See coding | 20120530 | ty_t_search_group TYPE STANDARD TABLE OF ty_s_search_group WITH DEFAULT KEY
|
Method Signatures
Method ADD_ATTRIBUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_DEFAULT_OPERATOR | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_OPERATOR | GUIBB SEARCH: Search Operator | 20101221 | ||
| 2 | Importing |
IV_GROUP_ID_ATTR | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_GROUP_ID | ID of Search Group | 20120530 | ||
| 3 | Importing |
IV_INDEX | Call by reference | Type reference (TYPE) | I | WDA Configuration: Index Attribute | 20090323 | ||
| 4 | Importing |
IV_INPUT_PROMPT | Call by reference | Type reference (TYPE) | FPM_INPUT_PROMPT | FPM: Input Prompt of a UI Element | 20140303 | ||
| 5 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | NAME_KOMP | Component name | 20090323 | ||
| 6 | Importing |
IV_TEXT | Call by reference | Type reference (TYPE) | STRING | Web Dynpro: Configuration: Translatable Text | 20090323 | ||
| 7 |  Returning |
RV_ELEMENT_ID | Value transfer | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20090325 |
Method ADD_ATTRIBUTE on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method ADD_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | FPMGB_PARAMETER_NAME | Parameter name | 20090323 | ||
| 2 | Importing |
IV_VALUE | Call by reference | Type reference (TYPE) | FPMGB_PARAMETER_VALUE | Parameter name | 20090323 |
Method ADD_PARAMETER on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method ADD_RESULT_COLUMN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DISPLAY_TYPE | Call by reference | Type reference (TYPE) | FPMGB_DISPLAY_TYPE | Display Type | 20090325 | ||
| 2 | Importing |
IV_HEADER | Call by reference | Type reference (TYPE) | STRING | 20090325 | |||
| 3 | Importing |
IV_INDEX | Call by reference | Type reference (TYPE) | I | 20090325 | |||
| 4 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | NAME_KOMP | Component name | 20090325 | ||
| 5 | Importing |
IV_TAG_ACTIVE | Call by reference | Type reference (TYPE) | FPMGB_TAG_ACTIVE | Tag is Active | 20120530 | ||
| 6 | Importing |
IV_WIDTH | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_RES_WIDTH | FPM Search GUIBB: Column Width in Results List | 20120530 | ||
| 7 | Returning |
RV_ELEMENT_ID | Value transfer | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20090325 |
Method ADD_RESULT_COLUMN on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method ADD_RESULT_GUIBB_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_COMPONENT | Call by reference | Type reference (TYPE) | FPM_COMPONENT_NAME | 'FPM_LIST_UIBB_ATS' | Web Dynpro: Component Name | 20110104 | |
| 2 | Importing |
IV_CONFIG_ID | Call by reference | Type reference (TYPE) | WDY_CONFIG_ID | Configuration Identification | 20110104 | ||
| 3 | Importing |
IV_HIDDEN | Call by reference | Type reference (TYPE) | FPM_HIDDEN | Element is Hidden | 20120530 | ||
| 4 | Importing |
IV_INSTANCE_ID | Call by reference | Type reference (TYPE) | FPM_INSTANCE_ID | Instance ID of a UIBB | 20110104 | ||
| 5 | Importing |
IV_INTERFACE_VIEW | Call by reference | Type reference (TYPE) | FPM_WINDOW_NAME | 'LIST_WINDOW' | Name of a Web Dynpro Window in Floorplan Manager | 20110104 |
Method ADD_RESULT_GUIBB_LIST on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method ADD_SEARCH_GROUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_EXPANDABLE | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_EXPANDABLE | Search Criteria: Enable Expandability of Group | 20120530 | ||
| 2 | Importing |
IV_EXPAND_ON_OPEN | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_EXPAND_ON_OPEN | Search Criteria: Expand Group on Open | 20120530 | ||
| 3 | Importing |
IV_GROUP_ID | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_GROUP_ID | 20120530 | |||
| 4 | Importing |
IV_GROUP_NUMBER_OF_SRCH_LINES | Call by reference | Type reference (TYPE) | FPMGB_NUM_QUERY_LINES | Number of Visible Query Rows in GUIBB Search | 20120530 | ||
| 5 | Importing |
IV_GROUP_TITLE | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_GROUP_TITLE | Search UIBB: Group Title | 20120530 | ||
| 6 | Importing |
IV_INDEX | Call by reference | Type reference (TYPE) | WDY_CONF_INDEX | WDA Configuration: Index Attribute | 20120530 | ||
| 7 | Returning |
RV_ELEMENT_ID | Value transfer | Type reference (TYPE) | FPM_ELEMENT_ID | FPM: Element ID | 20120530 |
Method ADD_SEARCH_GROUP on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_ATTRIBUTES | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_T_ATTRIBUTE | 20090323 |
Method GET_ATTRIBUTES on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_EXCLUDED_OPERATORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_OPERATORS | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_T_OPERATOR | 20090323 | |||
| 2 | Importing |
IV_ATTR_NAME | Call by reference | Type reference (TYPE) | NAME_KOMP | Component name | 20090323 |
Method GET_EXCLUDED_OPERATORS on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
RT_PARAMETERS | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_T_PARAMETER | 20090323 |
Method GET_PARAMETER on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_RESULT_COLUMNS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_COLUMNS | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_T_RESULT_COL | 20090323 |
Method GET_RESULT_COLUMNS on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_RESULT_GUIBB_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_RESULT_GUIBB_LIST | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_S_RESULT_GUIBB_LIST | 20120530 |
Method GET_RESULT_GUIBB_LIST on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_SEARCH_GROUPS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_SEARCH_GROUP | Call by reference | Type reference (TYPE) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_T_SEARCH_GROUP | 20120530 |
Method GET_SEARCH_GROUPS on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method GET_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_ADD_SETTINGS | Call by reference | Type reference (TYPE) | TY_S_ADD_SETTINGS | 20140110 | |||
| 2 | Exporting |
ES_SETTINGS | Call by reference | Type reference (TYPE) | TY_S_SETTINGS | 20120529 |
Method GET_SETTINGS on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method SET_EXCLUDED_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) | IF_FPM_GUIBB_SEARCH_CONFIG=>TY_T_OPERATOR | 20090323 | |||
| 2 | Importing |
IV_ATTR_NAME | Call by reference | Type reference (TYPE) | NAME_KOMP | Component name | 20090323 |
Method SET_EXCLUDED_OPERATORS on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
Method SET_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ALLOW_PERSONALIZATION | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_ALLOW_PERSONAL | FPM Search: Allow Personalization | 20130228 | ||
| 2 | Importing |
IV_ARIA_LANDMARK | Call by reference | Type reference (TYPE) | FPM_ARIA_LANDMARK | Aria Landmark | 20131021 | ||
| 3 | Importing |
IV_CHECK_MANDATORY | Call by reference | Type reference (TYPE) | FPMGB_CHECK_MANDATORY | Check Mandatory Fields on Screen | 20140204 | ||
| 4 | Importing |
IV_ENABLE_EXCLUDE_CRITERIA | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_EXCLUDE_CRITERIAS | Enable Exclude Criteria Area in Search Component | 20120529 | ||
| 5 | Importing |
IV_ENABLE_SAVED_SEARCHES | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_ENABLE_SAVE | GUIBB Search: Enable Saved Searches | 20120529 | ||
| 6 | Importing |
IV_GROUP_SAME_CRITERIA | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_GROUP_SAME_CRIT | Group Same Search Criteria | 20120529 | ||
| 7 | Importing |
IV_LOCATION_SAVED_SEARCHES | Call by reference | Type reference (TYPE) | WDR_SO_LOCATION | 20140110 | |||
| 8 | Importing |
IV_MAX_NUMBER_OF_RESULTS | Call by reference | Type reference (TYPE) | FPMGB_MAX_NUM_RESULT | Maximum Number of Rows in Result List in Search GUIBB | 20120529 | ||
| 9 | Importing |
IV_NUMBER_OF_QUERY_LINES | Call by reference | Type reference (TYPE) | FPMGB_NUM_QUERY_LINES | Number of Visible Query Rows in GUIBB Search | 20120529 | ||
| 10 | Importing |
IV_RESULT_NUMBER_OF_VIS_ROWS | Call by reference | Type reference (TYPE) | FPMGB_SEARCH_RESULT_NUM_ROWS | GUIBB SEARCH: Number of Rows in Result List | 20120529 | ||
| 11 | Importing |
IV_SHOW_BUTTON_CLEAR | Call by reference | Type reference (TYPE) | FPMGB_SHOW_BUTTON_CLEAR | Show "Clear Entries" Button | 20120529 | ||
| 12 | Importing |
IV_SHOW_BUTTON_RESET | Call by reference | Type reference (TYPE) | FPMGB_SHOW_BUTTON_RESET | Show "Reset to Default" Button in GUIBB Search | 20120529 | ||
| 13 | Importing |
IV_SHOW_BUTTON_SEARCH | Call by reference | Type reference (TYPE) | FPMGB_SHOW_BUTTON_SEARCH | Show "Search" Button | 20120529 | ||
| 14 | Importing |
IV_SHOW_MAX_NUM_RESULT_FIELD | Call by reference | Type reference (TYPE) | FPMGB_SHOW_MAX_NUM_RESULT | Visibility of 'Maximum Number of Results' Field | 20120529 |
Method SET_SETTINGS on class IF_FPM_GUIBB_SEARCH_CONFIG has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in |
