Interface SearchFieldGroupConfiguration
- All Known Implementing Classes:
DefaultSearchFieldGroupConfiguration
public interface SearchFieldGroupConfiguration
Represents a search field group in terms of configuration.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns allsearch field configurationsin this group and its sub groups.Returns all the sub groups held by thisSearchFieldGroupConfigurationand its sub groups.getLabel()getName()Returns the name set for this group configuration.Returns this group's parent group.Returns allsearch field configurationsdirectly assigned to thisSearchFieldGroupConfiguration.Returns all the sub groups directly held by thisSearchFieldGroupConfiguration.intgetSize()Returns the number ofsearch fieldsdirectly assigned by this group.intReturns the total numbersearch fieldsassigned to this group and any of its sub groups.booleanReturns whether this groups is visible or not.
-
Method Details
-
getName
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
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
List<SearchFieldGroupConfiguration> getSearchFieldGroupConfigurations()Returns all the sub groups directly held by thisSearchFieldGroupConfiguration.- Returns:
- the direct sub groups of this group
- See Also:
-
getAllSearchFieldGroupConfigurations
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:
-
getSearchFieldConfigurations
List<SearchFieldConfiguration> getSearchFieldConfigurations()Returns allsearch field configurationsdirectly assigned to thisSearchFieldGroupConfiguration.- Returns:
- all search field configurations assigned directly to this group
- See Also:
-
getAllSearchFieldConfigurations
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
String getLabel() -
getLabel
-
getAllLabels
Map<LanguageModel,String> getAllLabels()
-