Interface SearchFieldGroupConfiguration
-
- All Known Implementing Classes:
DefaultSearchFieldGroupConfiguration
public interface SearchFieldGroupConfigurationRepresents a search field group in terms of configuration.- See Also:
SearchFieldGroup
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.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.
-
-
-
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:
trueif visible,falseotherwise
-
getSize
int getSize()
Returns the number ofsearch fieldsdirectly assigned by this group.- Returns:
- the number of search fields directly assigned to this group
- See Also:
getTotalSize()
-
getTotalSize
int getTotalSize()
Returns the total numbersearch fieldsassigned 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
nullif this group is a root group
-
getSearchFieldGroupConfigurations
java.util.List<SearchFieldGroupConfiguration> getSearchFieldGroupConfigurations()
Returns all the sub groups directly held by thisSearchFieldGroupConfiguration.- Returns:
- the direct sub groups of this group
- See Also:
getAllSearchFieldGroupConfigurations()
-
getAllSearchFieldGroupConfigurations
java.util.List<SearchFieldGroupConfiguration> getAllSearchFieldGroupConfigurations()
Returns all the sub groups held by thisSearchFieldGroupConfigurationand its sub groups.- Returns:
- the sub groups of this
SearchFieldGroupConfigurationand their sub groups - See Also:
getSearchFieldGroupConfigurations()
-
getSearchFieldConfigurations
java.util.List<SearchFieldConfiguration> getSearchFieldConfigurations()
Returns allsearch field configurationsdirectly assigned to thisSearchFieldGroupConfiguration.- Returns:
- all search field configurations assigned directly to this group
- See Also:
getAllSearchFieldConfigurations()
-
getAllSearchFieldConfigurations
java.util.List<SearchFieldConfiguration> getAllSearchFieldConfigurations()
Returns allsearch field configurationsin 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()
-
-