io.oasp.module.jpa.common.api.to

Class PaginationTo

java.lang.Object

io.oasp.module.basic.common.api.to.AbstractTo

io.oasp.module.jpa.common.api.to.PaginationTo

All Implemented Interfaces:

Serializable, net.sf.mmm.util.entity.api.Entity, net.sf.mmm.util.transferobject.api.TransferObject

public class PaginationTo
extends AbstractTo

A transfer-object containing criteria for paginating queries.

Author:

henning

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PaginationTo	NO_PAGINATION Empty PaginationTo indicating no pagination.
private int	page
private static long	serialVersionUID UID for serialization.
private Integer	size
private boolean	total

Constructor Summary

Constructors

Constructor and Description
PaginationTo()

Method Summary

Methods

Modifier and Type	Method and Description
int	getPage()
Integer	getSize()
boolean	isTotal()
void	setPage(int page)
void	setSize(Integer size)
void	setTotal(boolean total)
protected void	toString(StringBuilder buffer)

Methods inherited from class io.oasp.module.basic.common.api.to.AbstractTo

toString

Methods inherited from class java.lang.Object

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

Field Detail

NO_PAGINATION

public static final PaginationTo NO_PAGINATION

Empty PaginationTo indicating no pagination.

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

size

private Integer size

See Also:

getSize()

page

private int page

See Also:

getPage()

total

private boolean total

See Also:

isTotal()

Constructor Detail

PaginationTo

public PaginationTo()

Method Detail

getSize

public Integer getSize()

Returns:

size the size of a page.

setSize

public void setSize(Integer size)

Parameters:

size - the size of a page.

getPage

public int getPage()

Returns:

page the current page.

setPage

public void setPage(int page)

Parameters:

page - the current page. Must be greater than 0.

isTotal

public boolean isTotal()

Returns:

total is true if the client requests that the server calculates the total number of entries found.

setTotal

public void setTotal(boolean total)

Parameters:

total - is true to request calculation of the total number of entries.

toString

protected void toString(StringBuilder buffer)

Overrides:

toString in class AbstractTo