de.hybris.platform.cockpit.model.advancedsearch

Interface SearchFieldGroup

All Known Implementing Classes:

DefaultSearchFieldGroup

public interface SearchFieldGroup

A search field group allows multi-level grouping of search fields and other search groups.

See Also:

SearchFieldGroupConfiguration, SearchField, AdvancedSearchModel

Method Summary

Modifier and Type	Method and Description
java.util.List<SearchFieldGroup>	getAllHiddenSearchFieldGroups() Returns a list containing this group (if hidden) and all the hidden groups held by this SearchFieldGroup and its sub groups.
java.util.List<SearchField>	getAllHiddenSearchFields() Returns all hidden search fields in this SearchFieldGroup and its sub groups.
java.util.List<SearchFieldGroup>	getAllPartiallyVisibleGroups() Returns a list containing this group (if it has hidden fields and/or groups) and all the sub groups of this group and its sub groups, which contains hidden fields or groups.
java.util.List<SearchFieldGroup>	getAllSearchFieldGroups() Returns a list containing this group and all the groups held by this SearchFieldGroup and its sub groups.
java.util.List<SearchField>	getAllSearchFields() Returns all search fields in this SearchFieldGroup and its sub groups.
java.util.List<SearchFieldGroup>	getAllVisibleSearchFieldGroups() Returns a list containing this group (if visible) and all the visible groups held by this SearchFieldGroup and its sub groups.
java.util.List<SearchField>	getAllVisibleSearchFields() Returns all visible search fields in this SearchFieldGroup and its sub groups.
java.util.List<SearchFieldGroup>	getHiddenSearchFieldGroups() Returns all the hidden sub groups directly held by this SearchFieldGroup.
java.util.List<SearchField>	getHiddenSearchFields() Returns all hidden search fields directly held by this SearchFieldGroup.
java.lang.String	getLabel() Returns the label of this search field group.
SearchFieldGroup	getParentSearchFieldGroup() Returns this group's parent group.
java.util.List<SearchFieldGroup>	getPartiallyVisibleGroups() Returns a list containing all the sub groups of this group, which contains hidden fields or groups.
java.util.List<SearchFieldGroup>	getSearchFieldGroups() Returns all the sub groups directly held by this SearchFieldGroup.
java.util.List<SearchField>	getSearchFields() Returns all search fields directly held by this SearchFieldGroup.
java.util.List<SearchFieldGroup>	getVisibleSearchFieldGroups() Returns all the visible sub groups directly held by this SearchFieldGroup.
java.util.List<SearchField>	getVisibleSearchFields() Returns all visible search fields directly held by this SearchFieldGroup.
boolean	isVisible() Returns whether this group is visible or not i.e.

Method Detail

getLabel

java.lang.String getLabel()

Returns the label of this search field group.

Returns:

the label of this group

isVisible

boolean isVisible()

Returns whether this group is visible or not i.e. if any of the fields held by this group or its sub groups are visible.

Returns:

true if this group is visible, false otherwise

getParentSearchFieldGroup

SearchFieldGroup getParentSearchFieldGroup()

Returns this group's parent group.

Returns:

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

getSearchFieldGroups

java.util.List<SearchFieldGroup> getSearchFieldGroups()

Returns all the sub groups directly held by this SearchFieldGroup.

Returns:

the direct sub groups of this group

See Also:

getVisibleSearchFieldGroups(), getHiddenSearchFieldGroups(), getAllSearchFieldGroups()

getAllSearchFieldGroups

java.util.List<SearchFieldGroup> getAllSearchFieldGroups()

Returns a list containing this group and all the groups held by this SearchFieldGroup and its sub groups.

Returns:

the sub groups of this SearchFieldGroup and their sub groups

See Also:

getAllVisibleSearchFieldGroups(), getAllHiddenSearchFieldGroups()

getVisibleSearchFieldGroups

java.util.List<SearchFieldGroup> getVisibleSearchFieldGroups()

Returns all the visible sub groups directly held by this SearchFieldGroup.

Returns:

the visible sub groups directly held by this group

See Also:

getSearchFieldGroups(), getHiddenSearchFieldGroups(), getAllVisibleSearchFieldGroups()

getAllVisibleSearchFieldGroups

java.util.List<SearchFieldGroup> getAllVisibleSearchFieldGroups()

Returns a list containing this group (if visible) and all the visible groups held by this SearchFieldGroup and its sub groups.

Returns:

the visible sub groups of this SearchFieldGroup and their sub groups

See Also:

getAllSearchFieldGroups(), getAllHiddenSearchFieldGroups(), getVisibleSearchFieldGroups()

getHiddenSearchFieldGroups

java.util.List<SearchFieldGroup> getHiddenSearchFieldGroups()

Returns all the hidden sub groups directly held by this SearchFieldGroup.

Returns:

the hidden sub groups directly held by this group

See Also:

getSearchFieldGroups(), getVisibleSearchFieldGroups(), getAllHiddenSearchFieldGroups()

getAllHiddenSearchFieldGroups

java.util.List<SearchFieldGroup> getAllHiddenSearchFieldGroups()

Returns a list containing this group (if hidden) and all the hidden groups held by this SearchFieldGroup and its sub groups.

Returns:

the hidden sub groups of this SearchFieldGroup and their sub groups

See Also:

getAllSearchFieldGroups(), getAllVisibleSearchFieldGroups(), getHiddenSearchFieldGroups()

getAllPartiallyVisibleGroups

java.util.List<SearchFieldGroup> getAllPartiallyVisibleGroups()

Returns a list containing this group (if it has hidden fields and/or groups) and all the sub groups of this group and its sub groups, which contains hidden fields or groups.

Returns:

the partially visible sub groups of this group i.e. all the groups which have hidden fields and/or sub groups

getPartiallyVisibleGroups

java.util.List<SearchFieldGroup> getPartiallyVisibleGroups()

Returns a list containing all the sub groups of this group, which contains hidden fields or groups.

Returns:

the partially visible sub groups of this group i.e. all the groups which have hidden fields and/or sub groups

getSearchFields

java.util.List<SearchField> getSearchFields()

Returns all search fields directly held by this SearchFieldGroup.

Returns:

all search fields assigned directly to this group

See Also:

getAllSearchFields(), getVisibleSearchFields(), getHiddenSearchFields()

getAllSearchFields

java.util.List<SearchField> getAllSearchFields()

Returns all search fields in this SearchFieldGroup and its sub groups.

Returns:

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

getVisibleSearchFields

java.util.List<SearchField> getVisibleSearchFields()

Returns all visible search fields directly held by this SearchFieldGroup.

Returns:

all visible search fields assigned directly to this group

See Also:

getAllVisibleSearchFields(), getSearchFields(), getHiddenSearchFields()

getAllVisibleSearchFields

java.util.List<SearchField> getAllVisibleSearchFields()

Returns all visible search fields in this SearchFieldGroup and its sub groups.

Returns:

all visible search fields assigned to this group or any of its sub groups

See Also:

getAllSearchFields(), getAllHiddenSearchFields(), getVisibleSearchFields()

getHiddenSearchFields

java.util.List<SearchField> getHiddenSearchFields()

Returns all hidden search fields directly held by this SearchFieldGroup.

Returns:

all hidden search fields assigned directly to this group

See Also:

getAllHiddenSearchFields(), getSearchFields(), getVisibleSearchFields()

getAllHiddenSearchFields

java.util.List<SearchField> getAllHiddenSearchFields()

Returns all hidden search fields in this SearchFieldGroup and its sub groups.

Returns:

all hidden search fields assigned to this group or any of its sub groups

See Also:

getAllSearchFields(), getAllVisibleSearchFields(), getHiddenSearchFields()