Package com.broadleafcommerce.search.api.domain

Class SortOption

java.lang.Object

com.broadleafcommerce.search.api.domain.SortOption

All Implemented Interfaces:

Serializable

public class SortOption
extends Object
implements Serializable

A sorting option for a particular field. This sort can be performed in either ascending or descending order.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
SortOption()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getDisplayOrder()	The display order of this sort option
FieldDefinition	getField()	The field to be sorted on
String	getLabel()	The label of this search option
String	getName()	Name to use to identify the sort option.
int	hashCode()
void	setDisplayOrder(Integer displayOrder)	The display order of this sort option
void	setField(FieldDefinition field)	The field to be sorted on
void	setLabel(String label)	The label of this search option
void	setName(String name)	Name to use to identify the sort option.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SortOption

public SortOption()

Method Detail

getLabel

public String getLabel()

The label of this search option

Returns:

label of this search option

getName

public String getName()

Name to use to identify the sort option. Typically, this should correspond to a FieldDefinition.getAbbreviation().

Returns:

Name to use to identify the sort option.

getField

public FieldDefinition getField()

The field to be sorted on

Returns:

field to be sorted on

getDisplayOrder

public Integer getDisplayOrder()

The display order of this sort option

Returns:

the order to display this sort option

setLabel

public void setLabel(String label)

The label of this search option

Parameters:

label - label of this search option

setName

public void setName(String name)

Name to use to identify the sort option. Typically, this should correspond to a FieldDefinition.getAbbreviation().

Parameters:

name - Name to use to identify the sort option.

setField

public void setField(FieldDefinition field)

The field to be sorted on

Parameters:

field - field to be sorted on

setDisplayOrder

public void setDisplayOrder(Integer displayOrder)

The display order of this sort option

Parameters:

displayOrder - the order to display this sort option

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object