Package de.xima.fc.dao

Class PageQuery

java.lang.Object

de.xima.fc.dao.PageQuery

All Implemented Interfaces:

Serializable

public class PageQuery
extends Object
implements Serializable

DTO for a page query.

Since:

8.4.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PageQuery.Builder

Method Summary

Modifier and Type	Method	Description
static PageQuery.Builder	builder()	Creates a new builder for a page request.
static PageQuery	forOffset(int pageSize, int offset)	Creates a new page request.
static PageQuery	forPage(int page, int pageSize)	Creates a new page request.
static PageQuery	forPageAndOffset(int page, int pageSize, int offset)	Creates a new page request.
int	getFirstResult()
int	getMaxResults()
int	getOffset()
int	getPage()
int	getPageSize()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static PageQuery.Builder builder()

Creates a new builder for a page request.

Returns:

A new builder for a page request.

forOffset

public static PageQuery forOffset(int pageSize,
                                  int offset)

Creates a new page request.

Parameters:

pageSize - The number of entities to retrieve.

offset - The offset of the entities to retrieve.

Returns:

A new page request.

forPage

public static PageQuery forPage(int page,
                                int pageSize)

Creates a new page request.

Parameters:

page - The page number to retrieve.

pageSize - The number of entities to retrieve.

Returns:

A new page request.

forPageAndOffset

public static PageQuery forPageAndOffset(int page,
                                         int pageSize,
                                         int offset)

Creates a new page request.

Parameters:

page - The page number to retrieve.

pageSize - The number of entities to retrieve.

offset - The offset of the entities to retrieve.

Returns:

A new page request.

getFirstResult

public int getFirstResult()

Returns:

The first result to retrieve.

getMaxResults

public int getMaxResults()

Returns:

The number of entities to retrieve.

getOffset

public int getOffset()

Returns:

The offset of the entities to retrieve.

getPage

public int getPage()

Returns:

The page number to retrieve.

getPageSize

public int getPageSize()

Returns:

The number of entities to retrieve.