Package org.apache.tapestry5.grid

# Interface GridSortModel

public interface GridSortModel
Models the sorting applied to the a `GridDataSource`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `clear()`
  `ColumnSort`
  `getColumnSort(String columnId)`
  Identifies how (or if) a column is sorted.
  `List<SortConstraint>`
  `getSortConstraints()`
  Returns a list of sort constraints, identifying which columns are sorted, and how.
  `void`
  `updateSort(String columnId)`
  Updates the column sort.

- ## Method Details

  - ### getColumnSort

    ColumnSort getColumnSort(String columnId)
    Identifies how (or if) a column is sorted.
    Parameters:
      `columnId` -
    Returns:
      the sort for the indicated column or `ColumnSort.UNSORTED` if the column is not used for sorting

  - ### updateSort

    void updateSort(String columnId)
    Updates the column sort. The receiver determines how to handle the sort request.
    Parameters:
      `columnId` - property id of column to sort on

  - ### getSortConstraints

    List<SortConstraint> getSortConstraints()
    Returns a list of sort constraints, identifying which columns are sorted, and how. May return an empty list (but won't return null).
    See Also:
      - `GridDataSource.prepare(int, int, java.util.List)`

  - ### clear

    void clear()