Package com.hybris.backoffice.attributechooser

Class AttributeChooserForm

java.lang.Object

com.hybris.backoffice.attributechooser.AttributeChooserForm

All Implemented Interfaces:

java.io.Serializable

public class AttributeChooserForm
extends java.lang.Object
implements java.io.Serializable

Pojo which is used to choose attributes. It has getAvailableAttributes() which contain attributes which can be chosen and getChosenAttributes() which represents chosen attributes. If isIncludeAll() is true then all attributes both from available and selected will be returned as selected through getSelectedAttributes()

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AttributeChooserForm()
AttributeChooserForm(java.util.Set<Attribute> availableAttributes, java.util.Set<Attribute> chosenAttributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.util.Set<Attribute>	getAvailableAttributes()
java.util.Set<Attribute>	getChosenAttributes()
java.util.Set<Attribute>	getSelectedAttributes()	Returns list of selected attributes.
int	hashCode()
boolean	hasPopulatedAttributes()	Tells if form has populated data getChosenAttributes() or getAvailableAttributes() is not empty.
boolean	hasSelectedAttributes()	Tells getSelectedAttributes() is not empty.
boolean	isIncludeAll()	Tells if form should return all attributes both from available and chosen as selected ones.
protected java.util.Set<Attribute>	mergeAttributes(java.util.Set<Attribute> available, java.util.Set<Attribute> choosen)
void	setAvailableAttributes(java.util.Set<Attribute> availableAttributes)	Sets list of available attributes.
void	setChosenAttributes(java.util.Set<Attribute> chosenAttributes)	Sets list of chosen attributes.
void	setIncludeAll(boolean includeAll)	Defines if form should return all attributes both from available and chosen as selected ones.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeChooserForm

public AttributeChooserForm()

AttributeChooserForm

public AttributeChooserForm(java.util.Set<Attribute> availableAttributes,
                            java.util.Set<Attribute> chosenAttributes)

Method Detail

hasPopulatedAttributes

public boolean hasPopulatedAttributes()

Tells if form has populated data getChosenAttributes() or getAvailableAttributes() is not empty.

Returns:

true if data has been populated.

hasSelectedAttributes

public boolean hasSelectedAttributes()

Tells getSelectedAttributes() is not empty.

Returns:

true if attributes are selected.

getSelectedAttributes

public java.util.Set<Attribute> getSelectedAttributes()

Returns list of selected attributes. If isIncludeAll() is true the it return merged list of getChosenAttributes() and getAvailableAttributes(). If include all is not selected it returns just getChosenAttributes()

Returns:

list of selected attributes

mergeAttributes

protected java.util.Set<Attribute> mergeAttributes(java.util.Set<Attribute> available,
                                                   java.util.Set<Attribute> choosen)

getAvailableAttributes

public java.util.Set<Attribute> getAvailableAttributes()

Returns:

list of available to choose attributes.

setAvailableAttributes

public void setAvailableAttributes(java.util.Set<Attribute> availableAttributes)

Sets list of available attributes.

Parameters:

availableAttributes - list of chosen attributes.

getChosenAttributes

public java.util.Set<Attribute> getChosenAttributes()

Returns:

list of chosen attributes.

setChosenAttributes

public void setChosenAttributes(java.util.Set<Attribute> chosenAttributes)

Sets list of chosen attributes.

Parameters:

chosenAttributes - list of chosen attributes.

isIncludeAll

public boolean isIncludeAll()

Tells if form should return all attributes both from available and chosen as selected ones.

Returns:

true if all should be included in getSelectedAttributes().

setIncludeAll

public void setIncludeAll(boolean includeAll)

Defines if form should return all attributes both from available and chosen as selected ones.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object