PageControlDto (Bremersee Page Builder 1.1.0 API)

java.lang.Object
- org.bremersee.pagebuilder.model.PageControlDto

All Implemented Interfaces:

Serializable
```
public class PageControlDto
extends Object
implements Serializable
```
A PageControlDto can be used to display a PageDto on a web site.
This page control can be processed by a JAXBContext and the Jackson JSON processor.

Author:

Christian Bremer

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`PageControlDto()` Default constructor.
`PageControlDto(PageDto page, PaginationDto pagination, String pageNumberParamName, String pageSizeParamName, List<PageSizeSelectorOptionDto> pageSizeSelectorOptions, String comparatorParamName, String comparatorParamValue, boolean querySupported, String queryParamName)` Creates a page control with the given parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getComparatorParamName()` Returns the parameter name of the comparator item.
`String`	`getComparatorParamValue()` Returns the serialized value of the comparator item.
`PageDto`	`getPage()` Returns the page.
`String`	`getPageNumberParamName()` Returns the parameter name of the page number.
`List<PageRequestLinkDto>`	`getPageRequestLinks()`
`String`	`getPageSizeParamName()` Returns the parameter name of the page size.
`List<PageSizeSelectorOptionDto>`	`getPageSizeSelectorOptions()` Returns a list with page size selector options.
`PaginationDto`	`getPagination()` Returns the pagination.
`String`	`getQueryParamName()` Returns the parameter name of the query.
`int`	`hashCode()`
`boolean`	`isQuerySupported()` Returns `true` if a query field should be displayed, otherwise `false`.
`void`	`setComparatorParamName(String comparatorParamName)` Sets the parameter name of the comparator item.
`void`	`setComparatorParamValue(String comparatorParamValue)` Sets the serialized value of the comparator item.
`void`	`setPage(PageDto page)` Sets the page.
`void`	`setPageNumberParamName(String pageNumberParamName)` Sets the parameter name of page number.
`void`	`setPageRequestLinks(List<PageRequestLinkDto> pageRequestLinks)`
`void`	`setPageSizeParamName(String pageSizeParamName)` Sets the parameter name of the max results.
`void`	`setPageSizeSelectorOptions(List<PageSizeSelectorOptionDto> pageSizeSelectorOptions)` Sets the list with maximum result options.
`void`	`setPagination(PaginationDto pagination)` Sets the pagination.
`void`	`setQueryParamName(String queryParamName)` Sets the parameter name of the query.
`void`	`setQuerySupported(boolean querySupported)` Specifies whether the query field should be displayed or not.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageControlDto
```
public PageControlDto()
```
Default constructor.

PageControlDto

public PageControlDto(PageDto page,
                      PaginationDto pagination,
                      String pageNumberParamName,
                      String pageSizeParamName,
                      List<PageSizeSelectorOptionDto> pageSizeSelectorOptions,
                      String comparatorParamName,
                      String comparatorParamValue,
                      boolean querySupported,
                      String queryParamName)

Creates a page control with the given parameters.

Parameters:: page - the page; pagination - the pagination; pageNumberParamName - the parameter name of the page number; pageSizeParamName - the parameter name of the maximum results; pageSizeSelectorOptions - the options for the maximum results selector; comparatorParamName - the parameter name of the comparator item; comparatorParamValue - the value of the comparator item; querySupported - true if a query field should be displayed otherwise false; queryParamName - the parameter name of the query

Method Detail
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- getPage
```
public PageDto getPage()
```
  Returns the page.
- setPage
```
public void setPage(PageDto page)
```
  Sets the page.
- getPageRequestLinks
```
public List<PageRequestLinkDto> getPageRequestLinks()
```
- setPageRequestLinks
```
public void setPageRequestLinks(List<PageRequestLinkDto> pageRequestLinks)
```
- getPagination
```
public PaginationDto getPagination()
```
  Returns the pagination.
- setPagination
```
public void setPagination(PaginationDto pagination)
```
  Sets the pagination.
- getPageNumberParamName
```
public String getPageNumberParamName()
```
  Returns the parameter name of the page number.
- setPageNumberParamName
```
public void setPageNumberParamName(String pageNumberParamName)
```
  Sets the parameter name of page number.
- getPageSizeParamName
```
public String getPageSizeParamName()
```
  Returns the parameter name of the page size.
- setPageSizeParamName
```
public void setPageSizeParamName(String pageSizeParamName)
```
  Sets the parameter name of the max results.
- getPageSizeSelectorOptions
```
public List<PageSizeSelectorOptionDto> getPageSizeSelectorOptions()
```
  Returns a list with page size selector options.
- setPageSizeSelectorOptions
```
public void setPageSizeSelectorOptions(List<PageSizeSelectorOptionDto> pageSizeSelectorOptions)
```
  Sets the list with maximum result options.
- getComparatorParamName
```
public String getComparatorParamName()
```
  Returns the parameter name of the comparator item.
- setComparatorParamName
```
public void setComparatorParamName(String comparatorParamName)
```
  Sets the parameter name of the comparator item.
- getComparatorParamValue
```
public String getComparatorParamValue()
```
  Returns the serialized value of the comparator item.
- setComparatorParamValue
```
public void setComparatorParamValue(String comparatorParamValue)
```
  Sets the serialized value of the comparator item.
- isQuerySupported
```
public boolean isQuerySupported()
```
  Returns true if a query field should be displayed, otherwise false.
- setQuerySupported
```
public void setQuerySupported(boolean querySupported)
```
  Specifies whether the query field should be displayed or not.
- getQueryParamName
```
public String getQueryParamName()
```
  Returns the parameter name of the query.
- setQueryParamName
```
public void setQueryParamName(String queryParamName)
```
  Sets the parameter name of the query.

Class PageControlDto

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PageControlDto

PageControlDto

Method Detail

toString

hashCode

equals

getPage

setPage

getPageRequestLinks

setPageRequestLinks

getPagination

setPagination

getPageNumberParamName

setPageNumberParamName

getPageSizeParamName

setPageSizeParamName

getPageSizeSelectorOptions

setPageSizeSelectorOptions

getComparatorParamName

setComparatorParamName

getComparatorParamValue

setComparatorParamValue

isQuerySupported

setQuerySupported

getQueryParamName

setQueryParamName