Package com.sodius.oslc.app.jazz.model

Interface QueryResultSet

  • public interface QueryResultSet
    The list of results of a query execution.
    Since:
    1.1.0
    See Also:
    ExecuteQuery

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Query getFirstPage()
      Returns a query which allow getting the first page of the query results.
      Query getLastPage()
      Returns a query which allow getting the last page of the query results.
      Query getNextPage()
      Returns a query which allow getting the next page of the query results.
      long getPageSize()
      Returns the size of the paging, which is the maximum number of item per page the response can contain.
      Query getPreviousPage()
      Returns a query which allow getting the previous page of the query results.
      List<QueryResult> getResults()
      Returns the list of results.
      long getStartIndex()
      Returns the index of the first item in the results regarding the total number of items matching the query, when paging is used.
      long getTotalResults()
      Returns the total number of items matching the query.

    • Method Detail

      • getResults

        List<QueryResult> getResults()
        Returns the list of results.

        The query response might use paging, in which case the getNextPage() method can be used to retrieve the next page of results.

        Returns:
        the list of results.
        See Also:
        getTotalResults(), getNextPage()

      • getTotalResults

        long getTotalResults()
        Returns the total number of items matching the query. This number might be different from the number of results in the getResults() method if the query uses paging.
        Returns:
        the total number of items matching the query.

      • getStartIndex

        long getStartIndex()
        Returns the index of the first item in the results regarding the total number of items matching the query, when paging is used.
        Returns:
        the index of the first item in the results.

      • getPageSize

        long getPageSize()
        Returns the size of the paging, which is the maximum number of item per page the response can contain.
        Returns:
        the size of the paging.

      • getFirstPage

        Query getFirstPage()
        Returns a query which allow getting the first page of the query results.
        Returns:
        a query to get the first page of the query results, null if none.
        See Also:
        ExecuteQuery

      • getLastPage

        Query getLastPage()
        Returns a query which allow getting the last page of the query results.
        Returns:
        a query to get the last page of the query results, null if none.
        See Also:
        ExecuteQuery

      • getNextPage

        Query getNextPage()
        Returns a query which allow getting the next page of the query results.
        Returns:
        a query to get the next page of the query results, null if none.
        See Also:
        ExecuteQuery

      • getPreviousPage

        Query getPreviousPage()
        Returns a query which allow getting the previous page of the query results.
        Returns:
        a query to get the previous page of the query results, null if none.
        See Also:
        ExecuteQuery