Package com.commercetools.api.models.approval_rule

Interface ApprovalRulePagedQueryResponse

public interface ApprovalRulePagedQueryResponse

PagedQueryResult with results containing an array of ApprovalRule.

Example to create an instance using the builder pattern 

     ApprovalRulePagedQueryResponse approvalRulePagedQueryResponse = ApprovalRulePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getLimit

      @NotNull @NotNull Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getOffset

      @NotNull @NotNull Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getCount

      @NotNull @NotNull Long getCount()

      Actual number of results returned.

      Returns:
      count

    • getTotal

      Long getTotal()

      Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

      Returns:
      total

    • getResults

      @NotNull @Valid @NotNull @Valid List<ApprovalRule> getResults()

      Approval Rules matching the query.

      Returns:
      results

    • setLimit

      void setLimit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set

    • setOffset

      void setOffset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set

    • setCount

      void setCount(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set

    • setTotal

      void setTotal(Long total)

      Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

      Parameters:
      total - value to be set

    • setResults

      void setResults(ApprovalRule... results)

      Approval Rules matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<ApprovalRule> results)

      Approval Rules matching the query.

      Parameters:
      results - values to be set

    • of

      static ApprovalRulePagedQueryResponse of()
      factory method
      Returns:
      instance of ApprovalRulePagedQueryResponse

    • of

      static ApprovalRulePagedQueryResponse of(ApprovalRulePagedQueryResponse template)
      factory method to create a shallow copy ApprovalRulePagedQueryResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ApprovalRulePagedQueryResponse copyDeep()

    • deepCopy

      @Nullable static ApprovalRulePagedQueryResponse deepCopy(@Nullable ApprovalRulePagedQueryResponse template)
      factory method to create a deep copy of ApprovalRulePagedQueryResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ApprovalRulePagedQueryResponseBuilder builder()
      builder factory method for ApprovalRulePagedQueryResponse
      Returns:
      builder

    • builder

      static ApprovalRulePagedQueryResponseBuilder builder(ApprovalRulePagedQueryResponse template)
      create builder for ApprovalRulePagedQueryResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withApprovalRulePagedQueryResponse

      default <T> T withApprovalRulePagedQueryResponse(Function<ApprovalRulePagedQueryResponse,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ApprovalRulePagedQueryResponse> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference