Package org.fugerit.java.core.util.result

Interface PagedResult<T>

All Superinterfaces:

Result

All Known Implementing Classes:

AbstractPagedResult, DefaultPagedResult

public interface PagedResult<T>
extends Result

Field Summary

Fields

Modifier and Type	Field	Description
static Integer	ELEMENT_COUNT_UNAVAILABLE	The method getElementCount() returns this value if the element count is unavalable
static int	FIRST_PAGE_INDEX

Fields inherited from interface org.fugerit.java.core.util.result.Result

RESULT_CODE_KO, RESULT_CODE_OK

Method Summary

Modifier and Type	Method	Description
Integer	getCurrentPage()	Position of current page ( in the range 1 - n )
Integer	getCurrentPageSize()	Number of elements in current page
Long	getElementCount()	Total number of elements in all pages
Map<String,Object>	getInfo()	Additional info of this page.
Integer	getOffset()	The position of the first element of the current pages ( (currentPage-1) * perPage )
Integer	getPageCount()	Total number of pages
Iterator<Integer>	getPageCountIterator()	Iterator over page numbers ( 1 - n )
Iterator<T>	getPageElements()	Elements in the current page
List<T>	getPageElementsList()	Elements in the current page
Integer	getPerPage()	Maximum number of elements in a page
Integer	getRealCurrentPage()
Integer	getRealPerPage()
PagedResult<T>	getVirtualPage(int currentPage)
String	getVirtualSearchKey()	Virtual search key
boolean	isFirstPage()	true if this is the last page.
boolean	isFullResult()	true if the the page contains the full result
boolean	isLastPage()	true if this is the last page.
boolean	isSupportVirtualPaging()

Methods inherited from interface org.fugerit.java.core.util.result.Result

getInfoMap, getResultCode, isResultOk, setResultCode

Field Detail

FIRST_PAGE_INDEX

static final int FIRST_PAGE_INDEX

See Also:

Constant Field Values

ELEMENT_COUNT_UNAVAILABLE

static final Integer ELEMENT_COUNT_UNAVAILABLE

The method getElementCount() returns this value if the element count is unavalable

Method Detail

getOffset

Integer getOffset()

The position of the first element of the current pages ( (currentPage-1) * perPage )

Returns:

offset of the first element in this page

getPerPage

Integer getPerPage()

Maximum number of elements in a page

Returns:

maximum number of elements in a page

getElementCount

Long getElementCount()

Total number of elements in all pages

Returns:

total number of elements in all pages

getCurrentPage

Integer getCurrentPage()

Position of current page ( in the range 1 - n )

Returns:

position of current page

getPageCount

Integer getPageCount()

Total number of pages

Returns:

total number of pages

getCurrentPageSize

Integer getCurrentPageSize()

Number of elements in current page

Returns:

the size of the current page

getPageElements

Iterator<T> getPageElements()

Elements in the current page

Returns:

elements in the current page

getPageElementsList

List<T> getPageElementsList()

Elements in the current page

Returns:

elements in the current page

getPageCountIterator

Iterator<Integer> getPageCountIterator()

Iterator over page numbers ( 1 - n )

Returns:

iterator over page numbers ( 1 - n )

getInfo

Map<String,Object> getInfo()

Additional info of this page.

Returns:

info

isLastPage

boolean isLastPage()

true if this is the last page.

Returns:

true if it's the last page

isFirstPage

boolean isFirstPage()

true if this is the last page.

Returns:

true if it's the first page

getVirtualSearchKey

String getVirtualSearchKey()

Virtual search key

Returns:

the virtual search key

getRealPerPage

Integer getRealPerPage()

getRealCurrentPage

Integer getRealCurrentPage()

getVirtualPage

PagedResult<T> getVirtualPage(int currentPage)

isSupportVirtualPaging

boolean isSupportVirtualPaging()

isFullResult

boolean isFullResult()

true if the the page contains the full result

Returns:

true if the page contains the full result