Package io.manebot.database.search

Interface SearchResult<T>

    • Method Summary

      Modifier and Type Method Description
      SearchHandler<T> getHandler()
      Gets the search handler that build this result.
      long getPage()
      Gets the page number that the associated result set expresses.
      int getPageSize()
      Gets the maximum size of the page offered by this search result.
      Search getQuery()
      Gets the query associated with this search result.
      java.util.List<T> getResults()
      Gets the objects found on the page this search result expresses.
      default long getTotalPages()
      Gets the total number of pages expressed by this search result.
      long getTotalResults()
      Gets the count of total results found in this result.

    • Method Detail

      • getQuery

        Search getQuery()
        Gets the query associated with this search result.
        Returns:
        Search query instance.

      • getHandler

        SearchHandler<T> getHandler()
        Gets the search handler that build this result.
        Returns:
        SearchHandler instance.

      • getTotalResults

        long getTotalResults()
        Gets the count of total results found in this result.
        Returns:
        total result count.

      • getPageSize

        int getPageSize()
        Gets the maximum size of the page offered by this search result. This is usually the value supplied to maxResults in the SearchHandler.
        Returns:
        maximum page size.

      • getPage

        long getPage()
        Gets the page number that the associated result set expresses.
        Returns:
        page number.

      • getTotalPages

        default long getTotalPages()
        Gets the total number of pages expressed by this search result.
        Returns:
        page count.

      • getResults

        java.util.List<T> getResults()
        Gets the objects found on the page this search result expresses.
        Returns:
        objects found in search.