de.hybris.platform.cockpit.model.advancedsearch.impl

Class DefaultSearchFieldGroup

java.lang.Object

de.hybris.platform.cockpit.model.advancedsearch.impl.DefaultSearchFieldGroup

All Implemented Interfaces:

SearchFieldGroup

public class DefaultSearchFieldGroup
extends java.lang.Object
implements SearchFieldGroup

Default SearchFieldGroup implementation.

See Also:

SearchFieldGroup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addSearchField(SearchField field) Assigns the search field field to this group if it's not already assigned to this group or any of its sub groups.
void	addSearchFieldGroup(SearchFieldGroup group) Assigns the group group to this group if it's not already assigned to this group or any of its sub groups.
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.
void	setLabel(java.lang.String name) Sets the name of this group to name.
void	setParentSearchFieldGroup(SearchFieldGroup parent) Sets this group's parent group to parent.
void	setSearchFieldGroups(java.util.List<? extends SearchFieldGroup> groups) Sets the sub groups of this group to groups.
void	setSearchFields(java.util.List<? extends SearchField> fields) Sets the search fields directly assigned to this group to the elements of fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSearchFieldGroup

public DefaultSearchFieldGroup(java.lang.String name)

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

Parameters:

name - the name

Method Detail

setLabel

public void setLabel(java.lang.String name)

Sets the name of this group to name.

Parameters:

name - the name

setSearchFields

public void setSearchFields(java.util.List<? extends SearchField> fields)

Sets the search fields directly assigned to this group to the elements of fields.

Parameters:

fields - the search fields to be directly assigned to this group

See Also:

addSearchField(SearchField)

setSearchFieldGroups

public void setSearchFieldGroups(java.util.List<? extends SearchFieldGroup> groups)

Sets the sub groups of this group to groups.

Parameters:

groups - groups to be contained in this group

addSearchField

public void addSearchField(SearchField field)

Assigns the search field field to this group if it's not already assigned to this group or any of its sub groups.

Parameters:

field - the search field to assign to this group

See Also:

setSearchFields(List)

addSearchFieldGroup

public void addSearchFieldGroup(SearchFieldGroup group)

Assigns the group group to this group if it's not already assigned to this group or any of its sub groups.

Parameters:

group - the group to assign to this group

setParentSearchFieldGroup

public void setParentSearchFieldGroup(SearchFieldGroup parent)

Sets this group's parent group to parent.

Parameters:

parent - this group's parent group

getLabel

public java.lang.String getLabel()

Description copied from interface: SearchFieldGroup

Returns the label of this search field group.

Specified by:

getLabel in interface SearchFieldGroup

Returns:

the label of this group

getParentSearchFieldGroup

public SearchFieldGroup getParentSearchFieldGroup()

Description copied from interface: SearchFieldGroup

Returns this group's parent group.

Specified by:

getParentSearchFieldGroup in interface SearchFieldGroup

Returns:

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

getSearchFieldGroups

public java.util.List<SearchFieldGroup> getSearchFieldGroups()

Description copied from interface: SearchFieldGroup

Returns all the sub groups directly held by this SearchFieldGroup.

Specified by:

getSearchFieldGroups in interface SearchFieldGroup

Returns:

the direct sub groups of this group

See Also:

SearchFieldGroup.getVisibleSearchFieldGroups(), SearchFieldGroup.getHiddenSearchFieldGroups(), SearchFieldGroup.getAllSearchFieldGroups()

getSearchFields

public java.util.List<SearchField> getSearchFields()

Description copied from interface: SearchFieldGroup

Returns all search fields directly held by this SearchFieldGroup.

Specified by:

getSearchFields in interface SearchFieldGroup

Returns:

all search fields assigned directly to this group

See Also:

SearchFieldGroup.getAllSearchFields(), SearchFieldGroup.getVisibleSearchFields(), SearchFieldGroup.getHiddenSearchFields()

isVisible

public boolean isVisible()

Description copied from interface: SearchFieldGroup

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.

Specified by:

isVisible in interface SearchFieldGroup

Returns:

true if this group is visible, false otherwise

getAllHiddenSearchFieldGroups

public java.util.List<SearchFieldGroup> getAllHiddenSearchFieldGroups()

Description copied from interface: SearchFieldGroup

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

Specified by:

getAllHiddenSearchFieldGroups in interface SearchFieldGroup

Returns:

the hidden sub groups of this SearchFieldGroup and their sub groups

See Also:

SearchFieldGroup.getAllSearchFieldGroups(), SearchFieldGroup.getAllVisibleSearchFieldGroups(), SearchFieldGroup.getHiddenSearchFieldGroups()

getAllHiddenSearchFields

public java.util.List<SearchField> getAllHiddenSearchFields()

Description copied from interface: SearchFieldGroup

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

Specified by:

getAllHiddenSearchFields in interface SearchFieldGroup

Returns:

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

See Also:

SearchFieldGroup.getAllSearchFields(), SearchFieldGroup.getAllVisibleSearchFields(), SearchFieldGroup.getHiddenSearchFields()

getAllSearchFieldGroups

public java.util.List<SearchFieldGroup> getAllSearchFieldGroups()

Description copied from interface: SearchFieldGroup

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

Specified by:

getAllSearchFieldGroups in interface SearchFieldGroup

Returns:

the sub groups of this SearchFieldGroup and their sub groups

See Also:

SearchFieldGroup.getAllVisibleSearchFieldGroups(), SearchFieldGroup.getAllHiddenSearchFieldGroups()

getAllSearchFields

public java.util.List<SearchField> getAllSearchFields()

Description copied from interface: SearchFieldGroup

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

Specified by:

getAllSearchFields in interface SearchFieldGroup

Returns:

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

getAllVisibleSearchFieldGroups

public java.util.List<SearchFieldGroup> getAllVisibleSearchFieldGroups()

Description copied from interface: SearchFieldGroup

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

Specified by:

getAllVisibleSearchFieldGroups in interface SearchFieldGroup

Returns:

the visible sub groups of this SearchFieldGroup and their sub groups

See Also:

SearchFieldGroup.getAllSearchFieldGroups(), SearchFieldGroup.getAllHiddenSearchFieldGroups(), SearchFieldGroup.getVisibleSearchFieldGroups()

getAllVisibleSearchFields

public java.util.List<SearchField> getAllVisibleSearchFields()

Description copied from interface: SearchFieldGroup

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

Specified by:

getAllVisibleSearchFields in interface SearchFieldGroup

Returns:

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

See Also:

SearchFieldGroup.getAllSearchFields(), SearchFieldGroup.getAllHiddenSearchFields(), SearchFieldGroup.getVisibleSearchFields()

getHiddenSearchFieldGroups

public java.util.List<SearchFieldGroup> getHiddenSearchFieldGroups()

Description copied from interface: SearchFieldGroup

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

Specified by:

getHiddenSearchFieldGroups in interface SearchFieldGroup

Returns:

the hidden sub groups directly held by this group

See Also:

SearchFieldGroup.getSearchFieldGroups(), SearchFieldGroup.getVisibleSearchFieldGroups(), SearchFieldGroup.getAllHiddenSearchFieldGroups()

getHiddenSearchFields

public java.util.List<SearchField> getHiddenSearchFields()

Description copied from interface: SearchFieldGroup

Returns all hidden search fields directly held by this SearchFieldGroup.

Specified by:

getHiddenSearchFields in interface SearchFieldGroup

Returns:

all hidden search fields assigned directly to this group

See Also:

SearchFieldGroup.getAllHiddenSearchFields(), SearchFieldGroup.getSearchFields(), SearchFieldGroup.getVisibleSearchFields()

getVisibleSearchFieldGroups

public java.util.List<SearchFieldGroup> getVisibleSearchFieldGroups()

Description copied from interface: SearchFieldGroup

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

Specified by:

getVisibleSearchFieldGroups in interface SearchFieldGroup

Returns:

the visible sub groups directly held by this group

See Also:

SearchFieldGroup.getSearchFieldGroups(), SearchFieldGroup.getHiddenSearchFieldGroups(), SearchFieldGroup.getAllVisibleSearchFieldGroups()

getVisibleSearchFields

public java.util.List<SearchField> getVisibleSearchFields()

Description copied from interface: SearchFieldGroup

Returns all visible search fields directly held by this SearchFieldGroup.

Specified by:

getVisibleSearchFields in interface SearchFieldGroup

Returns:

all visible search fields assigned directly to this group

See Also:

SearchFieldGroup.getAllVisibleSearchFields(), SearchFieldGroup.getSearchFields(), SearchFieldGroup.getHiddenSearchFields()

getAllPartiallyVisibleGroups

public java.util.List<SearchFieldGroup> getAllPartiallyVisibleGroups()

Description copied from interface: SearchFieldGroup

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.

Specified by:

getAllPartiallyVisibleGroups in interface SearchFieldGroup

Returns:

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

getPartiallyVisibleGroups

public java.util.List<SearchFieldGroup> getPartiallyVisibleGroups()

Description copied from interface: SearchFieldGroup

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

Specified by:

getPartiallyVisibleGroups in interface SearchFieldGroup

Returns:

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