Package de.hybris.platform.cockpit.services.config

Interface SearchFieldGroupConfiguration

All Known Implementing Classes:

DefaultSearchFieldGroupConfiguration

public interface SearchFieldGroupConfiguration

Represents a search field group in terms of configuration.

See Also:

SearchFieldGroup

Method Summary

Modifier and Type	Method	Description
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	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.

Method Detail

getName

java.lang.String getName()

Returns the name set for this group configuration.

Returns:

the name

isVisible

boolean isVisible()

Returns whether this groups is visible or not.

Returns:

true if visible, false otherwise

getSize

int getSize()

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

Returns:

the number of search fields directly assigned to this group

See Also:

getTotalSize()

getTotalSize

int getTotalSize()

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

Returns:

the total number of search fields held by this group and its sub groups

getParentSearchFieldGroupConfiguration

SearchFieldGroupConfiguration getParentSearchFieldGroupConfiguration()

Returns this group's parent group.

Returns:

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

getSearchFieldGroupConfigurations

java.util.List<SearchFieldGroupConfiguration> getSearchFieldGroupConfigurations()

Returns all the sub groups directly held by this SearchFieldGroupConfiguration.

Returns:

the direct sub groups of this group

See Also:

getAllSearchFieldGroupConfigurations()

getAllSearchFieldGroupConfigurations

java.util.List<SearchFieldGroupConfiguration> getAllSearchFieldGroupConfigurations()

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

Returns:

the sub groups of this SearchFieldGroupConfiguration and their sub groups

See Also:

getSearchFieldGroupConfigurations()

getSearchFieldConfigurations

java.util.List<SearchFieldConfiguration> getSearchFieldConfigurations()

Returns all search field configurations directly assigned to this SearchFieldGroupConfiguration.

Returns:

all search field configurations assigned directly to this group

See Also:

getAllSearchFieldConfigurations()

getAllSearchFieldConfigurations

java.util.List<SearchFieldConfiguration> getAllSearchFieldConfigurations()

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

Returns:

all search field configurations assigned to this group or any of its sub groups

getLabel

java.lang.String getLabel()

getLabel

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

getAllLabels

java.util.Map<LanguageModel,java.lang.String> getAllLabels()