org.javaswift.joss.model

Interface PaginationMap

All Known Implementing Classes:

AbstractListHolderPaginationMap, AbstractPaginationMap, AccountPaginationMap, ContainerDirectoryPaginationMap, ContainerPaginationMap

public interface PaginationMap

Map for a ListHolder on a list of ListSubject. The map holds a mapping for a page number to a marker, which is used by the interface of the OpenStack API for pagination purposes. The PaginationMap is drawn up in one go, which -- regrettably -- is a necessity because of the marker-mechanism. When the underlying data changes and this needs to be reflected by the client, a new map must be generated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMarker(java.lang.Integer page) Gets the marker text (ie, the name of the last record of the previous page) for navigating to another page.
int	getNumberOfPages() Returns the number of pages
int	getNumberOfRecords() Returns the number of records
int	getPageSize() Returns the page size
java.lang.String	getPrefix() Returns the prefix which is used to search the records

Method Detail

getMarker

java.lang.String getMarker(java.lang.Integer page)

Gets the marker text (ie, the name of the last record of the previous page) for navigating to another page. The OpenStack API requires this information (why don't they use a regular offset?).

Parameters:

page - the page to get the appropriate marker for

Returns:

the marker for the required page

getNumberOfPages

int getNumberOfPages()

Returns the number of pages

Returns:

number of pages

getPageSize

int getPageSize()

Returns the page size

Returns:

page size

getNumberOfRecords

int getNumberOfRecords()

Returns the number of records

Returns:

the number of records

getPrefix

java.lang.String getPrefix()

Returns the prefix which is used to search the records

Returns:

the prefix