Class DefaultSearchFieldGroupConfiguration
- java.lang.Object
-
- de.hybris.platform.cockpit.services.config.impl.DefaultSearchFieldGroupConfiguration
-
- All Implemented Interfaces:
SearchFieldGroupConfiguration
public class DefaultSearchFieldGroupConfiguration extends java.lang.Object implements SearchFieldGroupConfiguration
DefaultSearchFieldGroupConfigurationimplementation.- See Also:
SearchFieldGroupConfiguration
-
-
Constructor Summary
Constructors Constructor Description DefaultSearchFieldGroupConfiguration(java.lang.String name)Creates a newDefaultSearchFieldGroupConfigurationinstance with the name set toname.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSearchFieldConfiguration(SearchFieldConfiguration fieldConfig)Assigns the search fieldfieldConfigto this group if it's not already assigned to this group or any of its sub groups.java.util.Map<LanguageModel,java.lang.String>getAllLabels()java.util.List<SearchFieldConfiguration>getAllSearchFieldConfigurations()Returns allsearch field configurationsin this group and its sub groups.java.util.List<SearchFieldGroupConfiguration>getAllSearchFieldGroupConfigurations()Returns all the sub groups held by thisSearchFieldGroupConfigurationand its sub groups.java.lang.StringgetLabel()java.lang.StringgetLabel(java.lang.String iso)java.lang.StringgetLabelWithFallback()java.lang.StringgetLabelWithFallback(java.lang.String iso)java.lang.StringgetName()Returns the name set for this group configuration.SearchFieldGroupConfigurationgetParentSearchFieldGroupConfiguration()Returns this group's parent group.java.util.List<SearchFieldConfiguration>getSearchFieldConfigurations()Returns allsearch field configurationsdirectly assigned to thisSearchFieldGroupConfiguration.java.util.List<SearchFieldGroupConfiguration>getSearchFieldGroupConfigurations()Returns all the sub groups directly held by thisSearchFieldGroupConfiguration.intgetSize()Returns the number ofsearch fieldsdirectly assigned by this group.intgetTotalSize()Returns the total numbersearch fieldsassigned to this group and any of its sub groups.booleanisVisible()Returns whether this groups is visible or not.voidsetAllLabels(java.util.Map<LanguageModel,java.lang.String> labels)voidsetName(java.lang.String name)Sets the name of this group toname.voidsetParentSearchFieldGroupConfiguration(SearchFieldGroupConfiguration parentGroup)Sets this group's parent group toparentGroup.voidsetSearchFieldConfigurations(java.util.List<SearchFieldConfiguration> searchFieldConfigs)Sets the search fields directly assigned to this group to the elements ofsearchFieldConfigs.voidsetSearchFieldGroupConfigurations(java.util.List<? extends SearchFieldGroupConfiguration> groupConfigs)Sets the sub groups of this group togroupConfigs.voidsetVisible(boolean visible)Sets the visibility of this group tovisible.
-
-
-
Constructor Detail
-
DefaultSearchFieldGroupConfiguration
public DefaultSearchFieldGroupConfiguration(java.lang.String name)
Creates a newDefaultSearchFieldGroupConfigurationinstance with the name set toname.- Parameters:
name- name of this group
-
-
Method Detail
-
setName
public void setName(java.lang.String name)
Sets the name of this group toname.- Parameters:
name- the name
-
setVisible
public void setVisible(boolean visible)
Sets the visibility of this group tovisible.- Parameters:
visible-truemarks this group as visible,falseas invisible
-
setSearchFieldGroupConfigurations
public void setSearchFieldGroupConfigurations(java.util.List<? extends SearchFieldGroupConfiguration> groupConfigs)
Sets the sub groups of this group togroupConfigs.- Parameters:
groupConfigs- groups to be contained in this group
-
addSearchFieldConfiguration
public void addSearchFieldConfiguration(SearchFieldConfiguration fieldConfig)
Assigns the search fieldfieldConfigto this group if it's not already assigned to this group or any of its sub groups.- Parameters:
fieldConfig- the search field to assign to this group- See Also:
setSearchFieldConfigurations(List)
-
setSearchFieldConfigurations
public void setSearchFieldConfigurations(java.util.List<SearchFieldConfiguration> searchFieldConfigs)
Sets the search fields directly assigned to this group to the elements ofsearchFieldConfigs.- Parameters:
searchFieldConfigs- the search fields to be directly assigned to this group- See Also:
addSearchFieldConfiguration(SearchFieldConfiguration)
-
setParentSearchFieldGroupConfiguration
public void setParentSearchFieldGroupConfiguration(SearchFieldGroupConfiguration parentGroup)
Sets this group's parent group toparentGroup.- Parameters:
parentGroup- this group's parent group
-
getAllSearchFieldConfigurations
public java.util.List<SearchFieldConfiguration> getAllSearchFieldConfigurations()
Description copied from interface:SearchFieldGroupConfigurationReturns allsearch field configurationsin this group and its sub groups.- Specified by:
getAllSearchFieldConfigurationsin interfaceSearchFieldGroupConfiguration- Returns:
- all search field configurations assigned to this group or any of its sub groups
-
getAllSearchFieldGroupConfigurations
public java.util.List<SearchFieldGroupConfiguration> getAllSearchFieldGroupConfigurations()
Description copied from interface:SearchFieldGroupConfigurationReturns all the sub groups held by thisSearchFieldGroupConfigurationand its sub groups.- Specified by:
getAllSearchFieldGroupConfigurationsin interfaceSearchFieldGroupConfiguration- Returns:
- the sub groups of this
SearchFieldGroupConfigurationand their sub groups - See Also:
SearchFieldGroupConfiguration.getSearchFieldGroupConfigurations()
-
getName
public java.lang.String getName()
Description copied from interface:SearchFieldGroupConfigurationReturns the name set for this group configuration.- Specified by:
getNamein interfaceSearchFieldGroupConfiguration- Returns:
- the name
-
getParentSearchFieldGroupConfiguration
public SearchFieldGroupConfiguration getParentSearchFieldGroupConfiguration()
Description copied from interface:SearchFieldGroupConfigurationReturns this group's parent group.- Specified by:
getParentSearchFieldGroupConfigurationin interfaceSearchFieldGroupConfiguration- Returns:
- this group's parent group or
nullif this group is a root group
-
getSearchFieldConfigurations
public java.util.List<SearchFieldConfiguration> getSearchFieldConfigurations()
Description copied from interface:SearchFieldGroupConfigurationReturns allsearch field configurationsdirectly assigned to thisSearchFieldGroupConfiguration.- Specified by:
getSearchFieldConfigurationsin interfaceSearchFieldGroupConfiguration- Returns:
- all search field configurations assigned directly to this group
- See Also:
SearchFieldGroupConfiguration.getAllSearchFieldConfigurations()
-
getSearchFieldGroupConfigurations
public java.util.List<SearchFieldGroupConfiguration> getSearchFieldGroupConfigurations()
Description copied from interface:SearchFieldGroupConfigurationReturns all the sub groups directly held by thisSearchFieldGroupConfiguration.- Specified by:
getSearchFieldGroupConfigurationsin interfaceSearchFieldGroupConfiguration- Returns:
- the direct sub groups of this group
- See Also:
SearchFieldGroupConfiguration.getAllSearchFieldGroupConfigurations()
-
isVisible
public boolean isVisible()
Description copied from interface:SearchFieldGroupConfigurationReturns whether this groups is visible or not.- Specified by:
isVisiblein interfaceSearchFieldGroupConfiguration- Returns:
trueif visible,falseotherwise
-
getSize
public int getSize()
Description copied from interface:SearchFieldGroupConfigurationReturns the number ofsearch fieldsdirectly assigned by this group.- Specified by:
getSizein interfaceSearchFieldGroupConfiguration- Returns:
- the number of search fields directly assigned to this group
- See Also:
SearchFieldGroupConfiguration.getTotalSize()
-
getTotalSize
public int getTotalSize()
Description copied from interface:SearchFieldGroupConfigurationReturns the total numbersearch fieldsassigned to this group and any of its sub groups.- Specified by:
getTotalSizein interfaceSearchFieldGroupConfiguration- Returns:
- the total number of search fields held by this group and its sub groups
-
getAllLabels
public java.util.Map<LanguageModel,java.lang.String> getAllLabels()
- Specified by:
getAllLabelsin interfaceSearchFieldGroupConfiguration
-
getLabel
public java.lang.String getLabel()
- Specified by:
getLabelin interfaceSearchFieldGroupConfiguration
-
getLabel
public java.lang.String getLabel(java.lang.String iso)
- Specified by:
getLabelin interfaceSearchFieldGroupConfiguration
-
setAllLabels
public void setAllLabels(java.util.Map<LanguageModel,java.lang.String> labels)
-
getLabelWithFallback
public java.lang.String getLabelWithFallback()
-
getLabelWithFallback
public java.lang.String getLabelWithFallback(java.lang.String iso)
-
-