Package com.broadleafcommerce.search.api.domain

Class SortOption

java.lang.Object
com.broadleafcommerce.search.api.domain.SortOption
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
public class SortOption extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
A sorting option for a particular field. This sort can be performed in either ascending or descending order.

Since 2.1.0-GA, SortOptions are managed as independent entities from FieldDefinitions rather than being embedded.

See Also:

  • Constructor Details

    • SortOption

      public SortOption()

  • Method Details

    • getFieldDefinitionId

      public String getFieldDefinitionId()

    • getFieldIndexableType

      public String getFieldIndexableType()

    • getId

      public String getId()
      The context ID of the sort option.
      Returns:
      the context ID of the sort option

    • 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 FieldRef getField()
      The field to be sorted on. Only id, indexableType, and label are serialized in API responses.
      Returns:
      field to be sorted on

    • getVariantType

      public String getVariantType()
      The field variant type which should be sorted on.

    • getDisplayOrder

      public Integer getDisplayOrder()
      The display order of this sort option
      Returns:
      the order to display this sort option

    • getAttributes

      public Map<String,Object> getAttributes()
      Miscellaneous attributes for this sort option.
      Returns:
      Miscellaneous attributes for this sort option.

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The context ID of the sort option.
      Parameters:
      id - the context ID of the 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(FieldRef field)
      The field to be sorted on. Only id, indexableType, and label are serialized in API responses.
      Parameters:
      field - field to be sorted on

    • setVariantType

      public void setVariantType(String variantType)
      The field variant type which should 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

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Miscellaneous attributes for this sort option.
      Parameters:
      attributes - Miscellaneous attributes for this sort option.

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this 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

    • toString

      public String toString()
      Overrides:
      toString in class Object