Interface ProductTypePagedQueryResponse
- All Superinterfaces:
ResourcePagedQueryResponse<ProductType>
- All Known Implementing Classes:
ProductTypePagedQueryResponseImpl
PagedQueryResult with results containing an array of ProductType.
Example to create an instance using the builder pattern
ProductTypePagedQueryResponse productTypePagedQueryResponse = ProductTypePagedQueryResponse.builder()
.limit(0.3)
.offset(0.3)
.count(0.3)
.plusResults(resultsBuilder -> resultsBuilder)
.build()
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for ProductTypePagedQueryResponsebuilder
(ProductTypePagedQueryResponse template) create builder for ProductTypePagedQueryResponse instancedeepCopy
(ProductTypePagedQueryResponse template) factory method to create a deep copy of ProductTypePagedQueryResponse@NotNull Long
getCount()
Actual number of results returned.@NotNull Long
getLimit()
Number of results requested.@NotNull Long
Number of elements skipped.@NotNull @Valid List<ProductType>
ProductTypes matching the query.getTotal()
Total number of results matching the query.of()
factory methodof
(ProductTypePagedQueryResponse template) factory method to create a shallow copy ProductTypePagedQueryResponsevoid
Actual number of results returned.void
Number of results requested.void
Number of elements skipped.void
setResults
(ProductType... results) ProductTypes matching the query.void
setResults
(List<ProductType> results) ProductTypes matching the query.void
Total number of results matching the query.static com.fasterxml.jackson.core.type.TypeReference<ProductTypePagedQueryResponse>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.ResourcePagedQueryResponse
getPageIndex, getTotalPages, head, isFirst, isLast
-
Method Details
-
getLimit
Number of results requested.
- Specified by:
getLimit
in interfaceResourcePagedQueryResponse<ProductType>
- Returns:
- limit
-
getOffset
Number of elements skipped.
- Specified by:
getOffset
in interfaceResourcePagedQueryResponse<ProductType>
- Returns:
- offset
-
getCount
Actual number of results returned.
- Specified by:
getCount
in interfaceResourcePagedQueryResponse<ProductType>
- Returns:
- count
-
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.- Specified by:
getTotal
in interfaceResourcePagedQueryResponse<ProductType>
- Returns:
- total
-
getResults
ProductTypes matching the query.
- Specified by:
getResults
in interfaceResourcePagedQueryResponse<ProductType>
- Returns:
- results
-
setLimit
Number of results requested.
- Parameters:
limit
- value to be set
-
setOffset
Number of elements skipped.
- Parameters:
offset
- value to be set
-
setCount
Actual number of results returned.
- Parameters:
count
- value to be set
-
setTotal
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
ProductTypes matching the query.
- Parameters:
results
- values to be set
-
setResults
ProductTypes matching the query.
- Parameters:
results
- values to be set
-
of
factory method- Returns:
- instance of ProductTypePagedQueryResponse
-
of
factory method to create a shallow copy ProductTypePagedQueryResponse- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
@Nullable static ProductTypePagedQueryResponse deepCopy(@Nullable ProductTypePagedQueryResponse template) factory method to create a deep copy of ProductTypePagedQueryResponse- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for ProductTypePagedQueryResponse- Returns:
- builder
-
builder
create builder for ProductTypePagedQueryResponse instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withProductTypePagedQueryResponse
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-