Interface SearchHelper

All Known Implementing Classes:
DefaultSearchHelper

public interface SearchHelper
An interface for search helper functions.
  • Method Details

    • convertSort

      List<Sort> convertSort(String sort, SortDirection defaultSortDirection)
      Converts the String sort param into a list of Sort objects. The input, if not empty, should be already validated with the following format: {param}:{direction} Multiple sort parameters are allowed if the blocks are separated by comma.
      Parameters:
      sort - - the sort parameter received from the request
      defaultSortDirection - the default sort direction if not supplied in any of the sortBlocks
      Returns:
      a list of Sort objects
    • convertSortBlock

      Sort convertSortBlock(String sortBlock, SortDirection defaultSortDirection)
      Convert a sort block, i.e. {param}:{direction} into a Sort object. When a sort direction is invalid or is not provided, the sort direction is defaulted to the defaultSortDirection param.
      Parameters:
      sortBlock - a colon delimited String containing the sort field name and sorting direction
      defaultSortDirection - the default sort direction if not supplied in the sortBlock
      Returns:
      a Sort object