Package com.io7m.idstore.database.api

Class IdDatabaseAuditListPaging

java.lang.Object

com.io7m.idstore.database.api.IdDatabaseAuditListPaging

All Implemented Interfaces:

IdDatabaseAuditListPagingType, IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

public final class IdDatabaseAuditListPaging
extends Object
implements IdDatabaseAuditListPagingType

A paging handler for audit events.

Method Summary

Modifier and Type	Method	Description
static IdDatabaseAuditListPagingType	create(IdAuditSearchParameters inParameters)	A paging handler for audit events.
int	pageCount()
List<IdAuditEvent>	pageCurrent(IdDatabaseAuditQueriesType queries)	Obtain the current page's values.
long	pageFirstOffset()
List<IdAuditEvent>	pageNext(IdDatabaseAuditQueriesType queries)	Seek to the next page and return values within that page.
boolean	pageNextAvailable()
int	pageNumber()
IdAuditSearchParameters	pageParameters()
List<IdAuditEvent>	pagePrevious(IdDatabaseAuditQueriesType queries)	Seek to the previous page and return values within that page.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.idstore.database.api.IdDatabasePagingType

pagePreviousAvailable

Method Details

create

public static IdDatabaseAuditListPagingType create(IdAuditSearchParameters inParameters)

A paging handler for audit events.

Parameters:

inParameters - The audit list parameters

Returns:

A paging handler

pageParameters

public IdAuditSearchParameters pageParameters()

Specified by:

pageParameters in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Returns:

The immutable page parameters used for the queries

pageNumber

public int pageNumber()

Specified by:

pageNumber in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Returns:

The current page number

pageFirstOffset

public long pageFirstOffset()

Specified by:

pageFirstOffset in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Returns:

The index of the first item in the current page

pageCount

public int pageCount()

Specified by:

pageCount in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Returns:

An approximate count of the number of available pages

pageNextAvailable

public boolean pageNextAvailable()

Specified by:

pageNextAvailable in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Returns:

true If the next page is currently available

pagePrevious

public List<IdAuditEvent> pagePrevious(IdDatabaseAuditQueriesType queries)
                                throws IdDatabaseException

Description copied from interface: IdDatabasePagingType

Seek to the previous page and return values within that page.

Specified by:

pagePrevious in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Parameters:

queries - The queries

Returns:

The page's results

Throws:

IdDatabaseException - On database errors

pageNext

public List<IdAuditEvent> pageNext(IdDatabaseAuditQueriesType queries)
                            throws IdDatabaseException

Description copied from interface: IdDatabasePagingType

Seek to the next page and return values within that page.

Specified by:

pageNext in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Parameters:

queries - The queries

Returns:

The page's results

Throws:

IdDatabaseException - On database errors

pageCurrent

public List<IdAuditEvent> pageCurrent(IdDatabaseAuditQueriesType queries)
                               throws IdDatabaseException

Description copied from interface: IdDatabasePagingType

Obtain the current page's values.

Specified by:

pageCurrent in interface IdDatabasePagingType<IdAuditSearchParameters,IdAuditEvent,IdDatabaseAuditQueriesType>

Parameters:

queries - The queries

Returns:

The page's results

Throws:

IdDatabaseException - On database errors