org.brapi.v2.model

Class BrAPIPagination

java.lang.Object

org.brapi.v2.model.BrAPIPagination

Direct Known Subclasses:

BrAPIIndexPagination, BrAPITokenPagination

public abstract class BrAPIPagination
extends Object

BasePagination

Constructor Summary

Constructors

Constructor and Description
BrAPIPagination()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
abstract Integer	getCurrentPage()
Integer	getPageSize() The number of data elements returned, aka the size of the current page.
Integer	getTotalCount() The total number of elements that are available on the server and match the requested query paramters.
Integer	getTotalPages() The total number of pages of elements available on the server.
int	hashCode()
BrAPIPagination	pageSize(Integer pageSize)
abstract void	setCurrentPage(Integer page)
abstract void	setCurrentPage(String pageToken)
void	setPageSize(Integer pageSize)
void	setTotalCount(Integer totalCount)
void	setTotalPages(Integer totalPages)
String	toString()
BrAPIPagination	totalCount(Integer totalCount)
BrAPIPagination	totalPages(Integer totalPages)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BrAPIPagination

public BrAPIPagination()

Method Detail

pageSize

public BrAPIPagination pageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

The number of data elements returned, aka the size of the current page. If the requested page does not have enough elements to fill a page at the requested page size, this field should indicate the actual number of elements returned.

Returns:

pageSize

setPageSize

public void setPageSize(Integer pageSize)

totalCount

public BrAPIPagination totalCount(Integer totalCount)

getTotalCount

public Integer getTotalCount()

The total number of elements that are available on the server and match the requested query paramters.

Returns:

totalCount

setTotalCount

public void setTotalCount(Integer totalCount)

totalPages

public BrAPIPagination totalPages(Integer totalPages)

getTotalPages

public Integer getTotalPages()

The total number of pages of elements available on the server. This should be calculated with the following formula. totalPages = CEILING( totalCount / requested_page_size)

Returns:

totalPages

setTotalPages

public void setTotalPages(Integer totalPages)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setCurrentPage

public abstract void setCurrentPage(Integer page)

setCurrentPage

public abstract void setCurrentPage(String pageToken)

getCurrentPage

public abstract Integer getCurrentPage()