Interface for data processing components that can retrieve a page of data items by a filter.
Description
The IFilteredPageReader interface is used by data processing components that can retrieve a page of data items through the use of a filter.
Instance methods
get_page_by_filter
Gets a page of data items using filter parameters.
get_page_by_filter(correlation_id: Optional[str], filter: Optional[FilterParams], paging: Optional[PagingParams], sort: Optional[SortParams] = None): DataPage
- correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.
- filter: Optional[FilterParams] - (optional) filter parameters
- paging: Optional[PagingParams] - (optional) paging parameters
- sort: Optional[SortParams] - (optional) sort parameters
- returns: DataPage - list of items