Package ca.uhn.fhir.rest.server

Interface IPagingProvider

All Known Implementing Classes:

BasePagingProvider, FifoMemoryPagingProvider

public interface IPagingProvider

Method Summary

Modifier and Type	Method	Description
int	getDefaultPageSize()
int	getMaximumPageSize()
IBundleProvider	retrieveResultList(RequestDetails theRequestDetails, String theSearchId)	Retrieve a result list by ID
default IBundleProvider	retrieveResultList(RequestDetails theRequestDetails, String theSearchId, String thePageId)	Retrieve a result list by ID
String	storeResultList(RequestDetails theRequestDetails, IBundleProvider theList)	Stores a result list and returns an ID with which that list can be returned

Method Detail

getDefaultPageSize

int getDefaultPageSize()

getMaximumPageSize

int getMaximumPageSize()

retrieveResultList

IBundleProvider retrieveResultList(@Nullable
                                   RequestDetails theRequestDetails,
                                   @Nonnull
                                   String theSearchId)

Retrieve a result list by ID

Note that the theRequest parameter was added to this method in HAPI FHIR 4.0.0. Existing implementations may choose to add this parameter and not use it if needed.

retrieveResultList

default IBundleProvider retrieveResultList(@Nullable
                                           RequestDetails theRequestDetails,
                                           @Nonnull
                                           String theSearchId,
                                           String thePageId)

Retrieve a result list by ID

Note that the theRequest parameter was added to this method in HAPI FHIR 4.0.0. Existing implementations may choose to add this parameter and not use it if needed.

storeResultList

String storeResultList(@Nullable
                       RequestDetails theRequestDetails,
                       IBundleProvider theList)

Stores a result list and returns an ID with which that list can be returned

Parameters:

theRequestDetails - The server request being made (may be null)