Package de.aeb.xnsg.foundation.bf.paging

Class PageRequestDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.paging.PageRequestDTO

public class PageRequestDTO
extends Object

Parameters for query result pagination.

The query results are always limited in order to avoid system and communication overflow.

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	countAll	Indicates that the total number of available elements will be calculated and returned in the response.
static final String	DEFAULT_LIMIT
@Min(1L) @Max(1000L) Integer	limit	The maximum number of elements to be returned from the ordered result list.
static final int	MAX_LIMIT
static final int	MAX_OFFSET
static final int	MIN_LIMIT
static final int	MIN_OFFSET
@Min(0L) @Max(10000L) Integer	offset	The number of elements to be skipped in the ordered result list.

Constructor Summary

Constructors

Constructor	Description
PageRequestDTO()
PageRequestDTO(Integer offset, Integer limit)
PageRequestDTO(Integer offset, Integer limit, Boolean countAll)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

MIN_OFFSET

public static final int MIN_OFFSET

See Also:

• Constant Field Values

MAX_OFFSET

public static final int MAX_OFFSET

See Also:

• Constant Field Values

MIN_LIMIT

public static final int MIN_LIMIT

See Also:

• Constant Field Values

MAX_LIMIT

public static final int MAX_LIMIT

See Also:

• Constant Field Values

DEFAULT_LIMIT

public static final String DEFAULT_LIMIT

See Also:

• Constant Field Values

offset

@Min(0L)
@Max(10000L)
@DefaultValue("0")
@Nullable
@QueryParam("offset")
public @Min(0L) @Max(10000L) Integer offset

The number of elements to be skipped in the ordered result list.
Minimum: 0
Maximum: 10000

limit

@Min(1L)
@Max(1000L)
@DefaultValue("100")
@Nullable
@QueryParam("limit")
public @Min(1L) @Max(1000L) Integer limit

The maximum number of elements to be returned from the ordered result list.
Minimum: 1
Maximum: 1000

countAll

@DefaultValue("false")
@Nullable
@QueryParam("countAll")
public Boolean countAll

Indicates that the total number of available elements will be calculated and returned in the response.

See Also:

• PageResponseDTO

Constructor Details

PageRequestDTO

public PageRequestDTO()

PageRequestDTO

public PageRequestDTO(Integer offset,
 Integer limit)

PageRequestDTO

public PageRequestDTO(Integer offset,
 Integer limit,
 Boolean countAll)