org.seedstack.crud.rest

Class PaginationParams

java.lang.Object

org.seedstack.crud.rest.PaginationParams

public class PaginationParams
extends Object

Groups all JAX-RS query parameters supporting the various pagination modes (attribute based, offset-based and page-based).

Constructor Summary

Constructors

Constructor and Description
PaginationParams()

Method Summary

Modifier and Type	Method and Description
String	getAttribute() If pagination is attribute-based, returns the attribute that should be used.
Long	getLimit() Returns the limit if it has been specified.
Long	getOffset() If pagination is offset-based, returns the number of items to skip.
Long	getPage() If pagination is page-based, returns the index of the page.
String	getValue() If pagination is attribute-based, returns the value that should act as the upper value.
boolean	hasLimit() Returns true if a limit has been specified.
boolean	hasPagination() Returns if pagination should be enabled.
boolean	isAttributeBased() Returns if pagination is attribute based.
boolean	isOffsetBased() Returns if pagination is offset based.
boolean	isPageBased() Returns if pagination is page based.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginationParams

public PaginationParams()

Method Detail

getAttribute

public String getAttribute()

If pagination is attribute-based, returns the attribute that should be used.

Returns:

the path to the attribute used for attribute-based pagination.

getLimit

public Long getLimit()

Returns the limit if it has been specified.

Returns:

the limit if specified, null otherwise.

getOffset

public Long getOffset()

If pagination is offset-based, returns the number of items to skip.

Returns:

the number of items to skip.

getPage

public Long getPage()

If pagination is page-based, returns the index of the page. Whether this index is 0-based or 1-based, depends on the business framework configuration.

Returns:

the index of the page.

getValue

public String getValue()

If pagination is attribute-based, returns the value that should act as the upper value.

Returns:

the value used as the upper value for attribute-based pagination.

hasLimit

public boolean hasLimit()

Returns true if a limit has been specified.

Returns:

true if a limit has been specified, false otherwise.

hasPagination

public boolean hasPagination()

Returns if pagination should be enabled.

Returns:

true if pagination should be enabled, false otherwise.

isAttributeBased

public boolean isAttributeBased()

Returns if pagination is attribute based.

Returns:

true if pagination is attribute based, false otherwise.

isOffsetBased

public boolean isOffsetBased()

Returns if pagination is offset based.

Returns:

true if pagination is offset based, false otherwise.

isPageBased

public boolean isPageBased()

Returns if pagination is page based.

Returns:

true if pagination is page based, false otherwise.