de.hybris.platform.cockpit.services.config.impl

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

Default SearchFieldGroupConfiguration implementation.

See Also:

SearchFieldGroupConfiguration

Constructor Summary

Constructors

Constructor and Description
DefaultSearchFieldGroupConfiguration(java.lang.String name) Creates a new DefaultSearchFieldGroupConfiguration instance with the name set to name.

Method Summary

Modifier and Type	Method and Description
void	addSearchFieldConfiguration(SearchFieldConfiguration fieldConfig) Assigns the search field fieldConfig to 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 all search field configurations in this group and its sub groups.
java.util.List<SearchFieldGroupConfiguration>	getAllSearchFieldGroupConfigurations() Returns all the sub groups held by this SearchFieldGroupConfiguration and its sub groups.
java.lang.String	getLabel()
java.lang.String	getLabel(java.lang.String iso)
java.lang.String	getLabelWithFallback()
java.lang.String	getLabelWithFallback(java.lang.String iso)
java.lang.String	getName() Returns the name set for this group configuration.
SearchFieldGroupConfiguration	getParentSearchFieldGroupConfiguration() Returns this group's parent group.
java.util.List<SearchFieldConfiguration>	getSearchFieldConfigurations() Returns all search field configurations directly assigned to this SearchFieldGroupConfiguration.
java.util.List<SearchFieldGroupConfiguration>	getSearchFieldGroupConfigurations() Returns all the sub groups directly held by this SearchFieldGroupConfiguration.
int	getSize() Returns the number of search fields directly assigned by this group.
int	getTotalSize() Returns the total number search fields assigned to this group and any of its sub groups.
boolean	isVisible() Returns whether this groups is visible or not.
void	setAllLabels(java.util.Map<LanguageModel,java.lang.String> labels)
void	setName(java.lang.String name) Sets the name of this group to name.
void	setParentSearchFieldGroupConfiguration(SearchFieldGroupConfiguration parentGroup) Sets this group's parent group to parentGroup.
void	setSearchFieldConfigurations(java.util.List<SearchFieldConfiguration> searchFieldConfigs) Sets the search fields directly assigned to this group to the elements of searchFieldConfigs.
void	setSearchFieldGroupConfigurations(java.util.List<? extends SearchFieldGroupConfiguration> groupConfigs) Sets the sub groups of this group to groupConfigs.
void	setVisible(boolean visible) Sets the visibility of this group to visible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSearchFieldGroupConfiguration

public DefaultSearchFieldGroupConfiguration(java.lang.String name)

Creates a new DefaultSearchFieldGroupConfiguration instance with the name set to name.

Parameters:

name - name of this group

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of this group to name.

Parameters:

name - the name

setVisible

public void setVisible(boolean visible)

Sets the visibility of this group to visible.

Parameters:

visible - true marks this group as visible, false as invisible

setSearchFieldGroupConfigurations

public void setSearchFieldGroupConfigurations(java.util.List<? extends SearchFieldGroupConfiguration> groupConfigs)

Sets the sub groups of this group to groupConfigs.

Parameters:

groupConfigs - groups to be contained in this group

addSearchFieldConfiguration

public void addSearchFieldConfiguration(SearchFieldConfiguration fieldConfig)

Assigns the search field fieldConfig to 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 of searchFieldConfigs.

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 to parentGroup.

Parameters:

parentGroup - this group's parent group

getAllSearchFieldConfigurations

public java.util.List<SearchFieldConfiguration> getAllSearchFieldConfigurations()

Description copied from interface: SearchFieldGroupConfiguration

Returns all search field configurations in this group and its sub groups.

Specified by:

getAllSearchFieldConfigurations in interface SearchFieldGroupConfiguration

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: SearchFieldGroupConfiguration

Returns all the sub groups held by this SearchFieldGroupConfiguration and its sub groups.

Specified by:

getAllSearchFieldGroupConfigurations in interface SearchFieldGroupConfiguration

Returns:

the sub groups of this SearchFieldGroupConfiguration and their sub groups

See Also:

SearchFieldGroupConfiguration.getSearchFieldGroupConfigurations()

getName

public java.lang.String getName()

Description copied from interface: SearchFieldGroupConfiguration

Returns the name set for this group configuration.

Specified by:

getName in interface SearchFieldGroupConfiguration

Returns:

the name

getParentSearchFieldGroupConfiguration

public SearchFieldGroupConfiguration getParentSearchFieldGroupConfiguration()

Description copied from interface: SearchFieldGroupConfiguration

Returns this group's parent group.

Specified by:

getParentSearchFieldGroupConfiguration in interface SearchFieldGroupConfiguration

Returns:

this group's parent group or null if this group is a root group

getSearchFieldConfigurations

public java.util.List<SearchFieldConfiguration> getSearchFieldConfigurations()

Description copied from interface: SearchFieldGroupConfiguration

Returns all search field configurations directly assigned to this SearchFieldGroupConfiguration.

Specified by:

getSearchFieldConfigurations in interface SearchFieldGroupConfiguration

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: SearchFieldGroupConfiguration

Returns all the sub groups directly held by this SearchFieldGroupConfiguration.

Specified by:

getSearchFieldGroupConfigurations in interface SearchFieldGroupConfiguration

Returns:

the direct sub groups of this group

See Also:

SearchFieldGroupConfiguration.getAllSearchFieldGroupConfigurations()

isVisible

public boolean isVisible()

Description copied from interface: SearchFieldGroupConfiguration

Returns whether this groups is visible or not.

Specified by:

isVisible in interface SearchFieldGroupConfiguration

Returns:

true if visible, false otherwise

getSize

public int getSize()

Description copied from interface: SearchFieldGroupConfiguration

Returns the number of search fields directly assigned by this group.

Specified by:

getSize in interface SearchFieldGroupConfiguration

Returns:

the number of search fields directly assigned to this group

See Also:

SearchFieldGroupConfiguration.getTotalSize()

getTotalSize

public int getTotalSize()

Description copied from interface: SearchFieldGroupConfiguration

Returns the total number search fields assigned to this group and any of its sub groups.

Specified by:

getTotalSize in interface SearchFieldGroupConfiguration

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:

getAllLabels in interface SearchFieldGroupConfiguration

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface SearchFieldGroupConfiguration

getLabel

public java.lang.String getLabel(java.lang.String iso)

Specified by:

getLabel in interface SearchFieldGroupConfiguration

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)