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

Class ObjectPagingParams

java.lang.Object
com.iland.core.web.rest.response.common.ObjectPagingParams
All Implemented Interfaces:
Serializable
public class ObjectPagingParams extends Object implements Serializable
Object Paging Params.
Author:
Collin Snyder
See Also:

  • Field Details

    • page

      @QueryParam("page") @Since(1.0) @Expose protected Long page
      The page number. The index of the first page is 1. If the specified page number is larger than number of actual pages, the response will return as an empty list.

    • pageSize

      @QueryParam("pageSize") @Since(1.0) @Expose protected Long pageSize
      The page size. The number of objects per page.

    • filter

      @QueryParam("filter") @Since(1.0) @Expose protected String filter
      The filter. The filter on the names of the objects. If no filter is specified, all objects will be returned for the member type.

  • Constructor Details

    • ObjectPagingParams

      public ObjectPagingParams()
      Default constructor sets the page to 1, the pageSize to 25.

    • ObjectPagingParams

      public ObjectPagingParams(Long page, Long pageSize)
      Instantiates a new Paging params.
      Parameters:
      page - the offset
      pageSize - the limit

    • ObjectPagingParams

      public ObjectPagingParams(Long page, Long pageSize, String filter)
      Instantiates a new Paging params.
      Parameters:
      page - the offset
      pageSize - the limit
      filter - the filter

  • Method Details

    • getPage

      public long getPage()
      Gets page.
      Returns:
      the offset

    • getPageSize

      public long getPageSize()
      Gets page size.
      Returns:
      the limit

    • getFilter

      public String getFilter()
      Gets filter.
      Returns:
      the filter

    • setPage

      public ObjectPagingParams setPage(Long page)
      Sets page.
      Parameters:
      page - the offset
      Returns:
      the offset

    • setPageSize

      public ObjectPagingParams setPageSize(Long pageSize)
      Sets page size.
      Parameters:
      pageSize - the limit
      Returns:
      the limit

    • setFilter

      public ObjectPagingParams setFilter(String filter)
      Sets filter.
      Parameters:
      filter - the filter