Package com.ibm.fhir.core.context.impl

Class FHIRPagingContextImpl

java.lang.Object

com.ibm.fhir.core.context.impl.FHIRPagingContextImpl

All Implemented Interfaces:

FHIRPagingContext

Direct Known Subclasses:

FHIRHistoryContextImpl, FHIRSearchContextImpl

public class FHIRPagingContextImpl
extends java.lang.Object
implements FHIRPagingContext

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DEFAULT_LAST_PAGE_NUMBER
protected int	lastPageNumber
protected boolean	lenient
protected int	matchCount
protected int	maxPageIncludeCount
protected int	maxPageSize
protected int	pageNumber
protected int	pageSize
protected java.lang.Integer	totalCount

Constructor Summary

Constructors

Constructor	Description
FHIRPagingContextImpl()	Create a FHIRPagingContextImpl with the default values:

Method Summary

Modifier and Type	Method	Description
int	getLastPageNumber()
int	getMatchCount()
int	getMaxPageIncludeCount()
int	getMaxPageSize()
int	getPageNumber()
int	getPageSize()
java.lang.Integer	getTotalCount()
boolean	isLenient()
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)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LAST_PAGE_NUMBER

protected static final int DEFAULT_LAST_PAGE_NUMBER

See Also:

Constant Field Values

lastPageNumber

protected int lastPageNumber

pageNumber

protected int pageNumber

pageSize

protected int pageSize

maxPageSize

protected int maxPageSize

maxPageIncludeCount

protected int maxPageIncludeCount

totalCount

protected java.lang.Integer totalCount

matchCount

protected int matchCount

lenient

protected boolean lenient

Constructor Detail

FHIRPagingContextImpl

public FHIRPagingContextImpl()

Create a FHIRPagingContextImpl with the default values:

 page number: 1
 page size: 10
 max page size: 1000
 max page include count: 1000
 last page: 214748364
 

Method Detail

getLastPageNumber

public int getLastPageNumber()

Specified by:

getLastPageNumber in interface FHIRPagingContext

Returns:

the last page number

getPageNumber

public int getPageNumber()

Specified by:

getPageNumber in interface FHIRPagingContext

Returns:

the current page number

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface FHIRPagingContext

Returns:

the number of matching resources in a single page

See Also:

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

getMaxPageSize

public int getMaxPageSize()

Specified by:

getMaxPageSize in interface FHIRPagingContext

Returns:

the maximum number of matching resources allowed in a single page

See Also:

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

getMaxPageIncludeCount

public int getMaxPageIncludeCount()

Specified by:

getMaxPageIncludeCount in interface FHIRPagingContext

Returns:

the maximum number of included resources allowed in a single page

See Also:

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

getTotalCount

public java.lang.Integer getTotalCount()

Specified by:

getTotalCount in interface FHIRPagingContext

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

public int getMatchCount()

Specified by:

getMatchCount in interface FHIRPagingContext

Returns:

the number of matching resources returned for the corresponding query

See Also:

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

setLastPageNumber

public void setLastPageNumber(int lastPageNumber)

Specified by:

setLastPageNumber in interface FHIRPagingContext

Parameters:

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

setPageNumber

public void setPageNumber(int pageNumber)

Specified by:

setPageNumber in interface FHIRPagingContext

Parameters:

pageNumber - the current page number

setPageSize

public void setPageSize(int pageSize)

Specified by:

setPageSize in interface FHIRPagingContext

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

public void setMaxPageSize(int maxPageSize)

Specified by:

setMaxPageSize in interface FHIRPagingContext

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

public void setMaxPageIncludeCount(int maxPageIncludeCount)

Specified by:

setMaxPageIncludeCount in interface FHIRPagingContext

Parameters:

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

setTotalCount

public void setTotalCount(int totalCount)

Specified by:

setTotalCount in interface FHIRPagingContext

Parameters:

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

See Also:

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

setMatchCount

public void setMatchCount(int matchCount)

Specified by:

setMatchCount in interface FHIRPagingContext

Parameters:

matchCount - the number of matching resources returned for the corresponding query

See Also:

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

isLenient

public boolean isLenient()

Specified by:

isLenient in interface FHIRPagingContext

Returns:

whether the request should be handled with leniency

setLenient

public void setLenient(boolean lenient)

Specified by:

setLenient in interface FHIRPagingContext

Parameters:

lenient - whether the request should be handled with leniency