Package com.iland.core.web.rest.response.common

Class PagingParams

java.lang.Object

com.iland.core.web.rest.response.common.PagingParams

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaBackupDirectoryFilterParams, BaBackupFileFilterParams, EventFilterParams

public class PagingParams
extends Object
implements Serializable

Paging Params.

Author:

Cory Snyder

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	limit	The paging limit.
protected Long	offset	The paging offset.
protected PagingOrder	order	The order that records are returned in.

Constructor Summary

Constructors

Constructor	Description
PagingParams()	Default constructor sets the offset to 0, the limit to 25, and the order to DESC.
PagingParams(Long offset, Long limit, PagingOrder order)	Instantiates a new Paging params.

Method Summary

Modifier and Type	Method	Description
long	getLimit()	Gets limit.
long	getOffset()	Gets offset.
PagingOrder	getOrder()	Gets order.
PagingParams	setLimit(Long limit)	Sets limit.
PagingParams	setOffset(Long offset)	Sets offset.
PagingParams	setOrder(PagingOrder order)	Sets order.

Methods inherited from class java.lang.Object

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

Field Details

offset

@QueryParam("offset")
@Since(1.0)
@Expose
protected Long offset

The paging offset.

limit

@QueryParam("limit")
@Since(1.0)
@Expose
protected Long limit

The paging limit.

order

@QueryParam("order")
@Since(1.0)
@Expose
protected PagingOrder order

The order that records are returned in.

Constructor Details

PagingParams

public PagingParams()

Default constructor sets the offset to 0, the limit to 25, and the order to DESC.

PagingParams

public PagingParams(Long offset,
 Long limit,
 PagingOrder order)

Instantiates a new Paging params.

Parameters:

offset - the offset

limit - the limit

order - the order

Method Details

getOffset

public long getOffset()

Gets offset.

Returns:

the offset

getLimit

public long getLimit()

Gets limit.

Returns:

the limit

getOrder

@Nonnull
public PagingOrder getOrder()

Gets order.

Returns:

the order

setOffset

public PagingParams setOffset(Long offset)

Sets offset.

Parameters:

offset - the offset

Returns:

the offset

setLimit

public PagingParams setLimit(Long limit)

Sets limit.

Parameters:

limit - the limit

Returns:

the limit

setOrder

public PagingParams setOrder(PagingOrder order)

Sets order.

Parameters:

order - the order

Returns:

the order