Package com.broadleafcommerce.data.tracking.core.sort.domain

Interface Sortable

public interface Sortable
Repository domain should implement this interface in order to notify the system that they can be managed for sorting (see SortPositionRequest).
Author:
Jeff Fischer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_VALUE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default Boolean
    getSorted()
    Whether or not this instance is explicitly sorted (i.e.
    String
    getSorting()
    Get the value used for sorting
    void
    setSorting(String sorting)
    Set the value used for sorting
    default Map<String,Object>
    sortableBounds()
    A map of field names to values that will be used to construct the bounds of the sorting group to which this entity belongs.

  • Field Details

  • Method Details

    • getSorting

      String getSorting()
      Get the value used for sorting
      Returns:
      The sorting value

    • setSorting

      void setSorting(String sorting)
      Set the value used for sorting
      Parameters:
      sorting - The sorting value

    • sortableBounds

      default Map<String,Object> sortableBounds()
      A map of field names to values that will be used to construct the bounds of the sorting group to which this entity belongs. For example, when sorting CategoryProduct instances, you will want to limit the sorting calculations based on the Category to which this entity belongs. This information is most often used by SortPositionStrategy components.
      Returns:
      The restrictions that describe the bounds for the sorting group to which this instance belongs

    • getSorted

      default Boolean getSorted()
      Whether or not this instance is explicitly sorted (i.e. getSorting() is not equal to DEFAULT_VALUE).
      Returns:
      Whether or not this instance is explicitly sorted