Package com.ibm.fhir.core.context

Interface FHIRPagingContext

All Known Subinterfaces:

FHIRHistoryContext, FHIRSearchContext

All Known Implementing Classes:

FHIRHistoryContextImpl, FHIRPagingContextImpl, FHIRSearchContextImpl

public interface FHIRPagingContext

The paging context for given request

Method Summary

Modifier and Type	Method	Description
int	getLastPageNumber()
int	getPageNumber()
int	getPageSize()
int	getTotalCount()
boolean	isLenient()
void	setLastPageNumber(int lastPageNumber)
void	setLenient(boolean lenient)
void	setPageNumber(int pageNumber)
void	setPageSize(int pageSize)
void	setTotalCount(int totalCount)

Method Detail

getLastPageNumber

int getLastPageNumber()

Returns:

the last page number

getPageNumber

int getPageNumber()

Returns:

the current page number

getPageSize

int getPageSize()

Returns:

the number of resources in a single page

See Also:

https://www.hl7.org/fhir/r4/search.html#count

getTotalCount

int getTotalCount()

Returns:

the total number of matching resources for the corresponding query

See Also:

https://www.hl7.org/fhir/r4/search.html#count

setLastPageNumber

void setLastPageNumber(int lastPageNumber)

Parameters:

lastPageNumber - the last page of results that can be requested for the corresponding query

setPageNumber

void setPageNumber(int pageNumber)

Parameters:

pageNumber - the current page number

setPageSize

void setPageSize(int pageSize)

Parameters:

pageSize - the number of resources to include in a single page

See Also:

https://www.hl7.org/fhir/r4/search.html#count

setTotalCount

void setTotalCount(int totalCount)

Parameters:

totalCount - the total number of matching resources for the corresponding query

See Also:

https://www.hl7.org/fhir/r4/search.html#count

isLenient

boolean isLenient()

Returns:

whether the request should be handled with leniency

setLenient

void setLenient(boolean lenient)

Parameters:

lenient - whether the request should be handled with leniency