Package com.io7m.cardant.database.api

Interface CADatabasePagedQueryType<T>

Type Parameters:

T - The type of result values

All Known Subinterfaces:

CADatabaseAuditSearchType, CADatabaseFileSearchType, CADatabaseItemSearchType, CADatabaseTypeDeclarationSearchType, CADatabaseTypeScalarSearchType

All Known Implementing Classes:

CAAbstractSearch

public interface CADatabasePagedQueryType<T>

The type of paged queries.

Method Summary

Modifier and Type	Method	Description
CAPage<T>	pageCurrent(CADatabaseTransactionType transaction)	Get data for the current page.
CAPage<T>	pageNext(CADatabaseTransactionType transaction)	Get data for the next page.
CAPage<T>	pagePrevious(CADatabaseTransactionType transaction)	Get data for the previous page.

Method Details

pageCurrent

CAPage<T> pageCurrent(CADatabaseTransactionType transaction)
               throws CADatabaseException

Get data for the current page.

Parameters:

transaction - The transaction

Returns:

A page of results

Throws:

CADatabaseException - On errors

pageNext

CAPage<T> pageNext(CADatabaseTransactionType transaction)
            throws CADatabaseException

Get data for the next page. If the current page is the last page, the function acts as pageCurrent(CADatabaseTransactionType).

Parameters:

transaction - The transaction

Returns:

A page of results

Throws:

CADatabaseException - On errors

pagePrevious

CAPage<T> pagePrevious(CADatabaseTransactionType transaction)
                throws CADatabaseException

Get data for the previous page. If the current page is the first page, the function acts as pageCurrent(CADatabaseTransactionType).

Parameters:

transaction - The transaction

Returns:

A page of results

Throws:

CADatabaseException - On errors