|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ExperimentalApi public interface PaginationService
Provided paginated access to Model data.
Method Summary | ||
---|---|---|
|
doPaginationRequest(LimitedRequest pageRequest,
PaginationBatch<H> fetchBatch,
com.google.common.base.Function<? super H,M> modelConverter)
Perform a pagination request, this will execute the fetchBatch function as many times as necessary to retrieve the page of results. |
Method Detail |
---|
<H,M> PageResponse<M> doPaginationRequest(LimitedRequest pageRequest, PaginationBatch<H> fetchBatch, com.google.common.base.Function<? super H,M> modelConverter)
com.atlassian.confluence.api.model.pagination.LimitedRequest.getMaxLimit()
results
from the datasource. FetchBatch will be executed in a new transaction for each batch to prevent excessive memory usage.
It is expected that any permission checking is performed in the PaginationTemplate.
The PaginationService is responsible for ensuring that enough results are returned from the PaginationTemplate to fulfill the request. The PaginationTemplate should not treat the pageRequest getStart and getLimit values as user specific indexes, only results the user can see should be returned. If a user does not have permission to see any results in the requested range an empty list should be returned in the response and the hasMore flag set if there are more results still to check. The pagination service will call again if more results are required.
pageRequest
- - a request for a range of datafetchBatch
- - the function to supply the resultsmodelConverter
- - a function to convert from the supplied object to a model object, this will be executed within a transaction.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |