Package com.collibra.dgc.core.api.dto

Class PagedRequest

Object
PagedRequest
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CursorPagedRequest, FindActivitiesRequest, FindAssetTypesRequest, FindAttachmentsRequest, FindAttributeTypesRequest, FindCommentsRequest, FindComplexRelationTypesRequest, FindDataQualityRulesRequest, FindDomainTypesRequest, FindIssuesRequest, FindJdbcDriverRequest, FindJobsRequest, FindMappingsRequest, FindMostViewedAssetsRequest, FindRatingsRequest, FindRecentlyViewedAssetsRequest, FindRelationTypesRequest, FindResponsibilitiesRequest, FindRolesRequest, FindStatusesRequest, FindTagsRequest, FindTraitsRequest, FindUserGroupsForUserRequest, FindUserGroupsRequest, FindUsersRequest, FindValidationResultRequest, FindViewPermissionRequest, FindWorkflowDefinitionsRequest, FindWorkflowInstancesRequest, FindWorkflowTasksRequest, RecentlyViewedAssetsRequest
public class PagedRequest extends Object implements Serializable
The request that supports paging parameters.
See Also:

  • Field Summary Link icon

    Fields
    Modifier and Type
    Field
    Description
    protected int
    countLimit
    Allows to limit the number of elements that will be counted.
    protected int
    limit
    The maximum number of results to retrieve.
    protected int
    offset
    The first result to retrieve.

  • Constructor Summary Link icon

    Constructors
    Modifier
    Constructor
    Description
     
    PagedRequest()
     
     
    PagedRequest(int offset, int limit)
     
    protected
    PagedRequest(int offset, int limit, int countLimit)
    Creates a new PagedRequest instance.

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    int
    getCountLimit()
    Allows to limit the number of elements that will be counted.
    int
    getLimit()
    The maximum number of results to retrieve.
    int
    getOffset()
    The first result to retrieve.
    int
    hashCode()
     
    boolean
    isPagingActive()
    Deprecated.
    This method will be removed in the future.
    void
    setCountLimit(int countLimit)
    Allows to limit the number of elements that will be counted.
    void
    setLimit(int limit)
    The maximum number of results to retrieve.
    void
    setOffset(int offset)
    The first result to retrieve.
    String
    toString()
     

    Methods inherited from class Object Link icon

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details Link icon

    • offset Link icon

      @DefaultValue("0") @QueryParam("offset") protected int offset
      The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

    • limit Link icon

      @DefaultValue("0") @QueryParam("limit") @ConfiguredMaxLimit(max=1000) protected int limit
      The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

    • countLimit Link icon

      @DefaultValue("-1") @QueryParam("countLimit") protected int countLimit
      Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

  • Constructor Details Link icon

    • PagedRequest Link icon

      public PagedRequest(int offset, int limit)

    • PagedRequest Link icon

      public PagedRequest()

    • PagedRequest Link icon

      protected PagedRequest(int offset, int limit, int countLimit)
      Creates a new PagedRequest instance.
      Parameters:
      offset - The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.
      limit - The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.
      countLimit - Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

  • Method Details Link icon

    • isPagingActive Link icon

      @Deprecated public boolean isPagingActive()
      Deprecated.
      This method will be removed in the future. Please use getOffset() and getLimit().
      Returns true if paging is active, false otherwise.
      Returns:
      true if paging is active, false otherwise

    • getOffset Link icon

      public int getOffset()
      The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

    • getLimit Link icon

      public int getLimit()
      The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

    • getCountLimit Link icon

      public int getCountLimit()
      Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

    • setOffset Link icon

      public void setOffset(int offset)
      The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

    • setLimit Link icon

      public void setLimit(int limit)
      The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

    • setCountLimit Link icon

      public void setCountLimit(int countLimit)
      Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

    • equals Link icon

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual Link icon

      protected boolean canEqual(Object other)

    • hashCode Link icon

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString Link icon

      public String toString()
      Overrides:
      toString in class Object