Package org.linuxforhealth.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
java.lang.Long	getFirstId()
java.lang.Long	getLastId()
int	getLastPageNumber()
int	getMatchCount()
int	getMaxPageIncludeCount()
int	getMaxPageSize()
int	getPageNumber()
int	getPageSize()
java.lang.Integer	getTotalCount()
boolean	isLenient()
void	setFirstId(java.lang.Long firstId)	Set the expected id of the first entry of the requested page; this id should uniquely identify a particular version of a particular resource type with a particular logical id
void	setLastId(java.lang.Long lastId)	Set the expected id of the last entry of the requested page; this id should uniquely identify a particular version of a particular resource type with a particular logical id
void	setLastPageNumber(int lastPageNumber)
void	setLenient(boolean lenient)
void	setMatchCount(int matchCount)
void	setMaxPageIncludeCount(int maxPageIncludeCount)
void	setMaxPageSize(int maxPageSize)
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 matching resources in a single page

See Also:

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

getMaxPageSize

int getMaxPageSize()

Returns:

the maximum number of matching resources allowed in a single page

See Also:

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

getMaxPageIncludeCount

int getMaxPageIncludeCount()

Returns:

the maximum number of included resources allowed in a single page

See Also:

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

getTotalCount

java.lang.Integer getTotalCount()

Returns:

the total number of matching resources for the corresponding query, or null if total count is not available

See Also:

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

getMatchCount

int getMatchCount()

Returns:

the number of matching resources returned for the corresponding query

See Also:

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

getFirstId

java.lang.Long getFirstId()

Returns:

the expected id of the first entry of the requested page; this id should uniquely identify a particular version of a particular resource type with a particular logical id

getLastId

java.lang.Long getLastId()

Returns:

the expected id of the last entry of the requested page; this id should uniquely identify a particular version of a particular resource type with a particular logical id

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 matching resources to include in a single page

See Also:

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

setMaxPageSize

void setMaxPageSize(int maxPageSize)

Parameters:

maxPageSize - the maximum number of matching resources allowed in a single page

See Also:

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

setMaxPageIncludeCount

void setMaxPageIncludeCount(int maxPageIncludeCount)

Parameters:

maxPageIncludeCount - the maximum number of included resources allowed in a single page

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

setMatchCount

void setMatchCount(int matchCount)

Parameters:

matchCount - the number of matching resources returned 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

setFirstId

void setFirstId(java.lang.Long firstId)

Set the expected id of the first entry of the requested page; this id should uniquely identify a particular version of a particular resource type with a particular logical id

Parameters:

firstId -

setLastId

void setLastId(java.lang.Long lastId)

Set the expected id of the last entry of the requested page; this id should uniquely identify a particular version of a particular resource type with a particular logical id

Parameters:

lastId -