Returns the list of current page items.
Custom implementation can be added here, based on the page provider properties, parameters and
WhereClauseDefinition on the
PageProviderDefinition, as well as search document, sort
information, etc...
Implementation of this method usually consists in setting a non-null value to a field caching current items, and
nullifying this field by overriding
#pageChanged() and
#refresh().
Fields
#errorMessage and
#error can also be filled to provide accurate feedback in case an error
occurs during the search.
When items are retrieved, a call to
#setResultsCount(long) should be made to ensure proper pagination as
implemented in this abstract class. The implementation in
CoreQueryAndFetchPageProvider is a good example
when the total results count is known.
If for performance reasons, for instance, the number of results cannot be known, a fall-back strategy can be
applied to provide the "next" button but not the "last" one, by calling
#getCurrentHigherNonEmptyPageIndex() and
#setCurrentHigherNonEmptyPageIndex(int). In this case,
CoreQueryDocumentPageProvider is a good example.