Package org.pipservices3.data

Interface IQuarablePageReader<T>

public interface IQuarablePageReader<T>
Interface for data processing components that can query a page of data items.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.pipservices3.commons.data.DataPage<T>
    getPageByQuery(String correlationId, String query, org.pipservices3.commons.data.PagingParams paging, org.pipservices3.commons.data.SortParams sort)
    Gets a page of data items using a query string.

  • Method Details

    • getPageByQuery

      org.pipservices3.commons.data.DataPage<T> getPageByQuery(String correlationId, String query, org.pipservices3.commons.data.PagingParams paging, org.pipservices3.commons.data.SortParams sort) throws org.pipservices3.commons.errors.ApplicationException
      Gets a page of data items using a query string.
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      query - (optional) a query string
      paging - (optional) paging parameters
      sort - (optional) sort parameters
      Returns:
      a list of items by query.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when error occured.