Package com.commercetools.api.models.product_selection

Class ProductSelectionProductPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.product_selection.ProductSelectionProductPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ProductSelectionProductPagedQueryResponse>

public class ProductSelectionProductPagedQueryResponseBuilder
extends Object
implements Builder<ProductSelectionProductPagedQueryResponse>

ProductSelectionProductPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ProductSelectionProductPagedQueryResponse productSelectionProductPagedQueryResponse = ProductSelectionProductPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSelectionProductPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSelectionProductPagedQueryResponseBuilder	addResults(Function<AssignedProductReferenceBuilder,AssignedProductReference> builder)	References to Products that are assigned to the ProductSelection.
ProductSelectionProductPagedQueryResponse	build()	builds ProductSelectionProductPagedQueryResponse with checking for non-null required values
ProductSelectionProductPagedQueryResponse	buildUnchecked()	builds ProductSelectionProductPagedQueryResponse without checking for non-null required values
ProductSelectionProductPagedQueryResponseBuilder	count(Long count)	Actual number of results returned.
Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
List<AssignedProductReference>	getResults()	References to Products that are assigned to the ProductSelection.
Long	getTotal()	Total number of results matching the query.
ProductSelectionProductPagedQueryResponseBuilder	limit(Long limit)	Number of results requested.
static ProductSelectionProductPagedQueryResponseBuilder	of()	factory method for an instance of ProductSelectionProductPagedQueryResponseBuilder
static ProductSelectionProductPagedQueryResponseBuilder	of(ProductSelectionProductPagedQueryResponse template)	create builder for ProductSelectionProductPagedQueryResponse instance
ProductSelectionProductPagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
ProductSelectionProductPagedQueryResponseBuilder	plusResults(AssignedProductReference... results)	References to Products that are assigned to the ProductSelection.
ProductSelectionProductPagedQueryResponseBuilder	plusResults(Function<AssignedProductReferenceBuilder,AssignedProductReferenceBuilder> builder)	References to Products that are assigned to the ProductSelection.
ProductSelectionProductPagedQueryResponseBuilder	results(AssignedProductReference... results)	References to Products that are assigned to the ProductSelection.
ProductSelectionProductPagedQueryResponseBuilder	results(List<AssignedProductReference> results)	References to Products that are assigned to the ProductSelection.
ProductSelectionProductPagedQueryResponseBuilder	setResults(Function<AssignedProductReferenceBuilder,AssignedProductReference> builder)	References to Products that are assigned to the ProductSelection.
ProductSelectionProductPagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
ProductSelectionProductPagedQueryResponseBuilder	withResults(Function<AssignedProductReferenceBuilder,AssignedProductReferenceBuilder> builder)	References to Products that are assigned to the ProductSelection.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProductSelectionProductPagedQueryResponseBuilder

public ProductSelectionProductPagedQueryResponseBuilder()

Method Details

limit

public ProductSelectionProductPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ProductSelectionProductPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ProductSelectionProductPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ProductSelectionProductPagedQueryResponseBuilder total(@Nullable
 Long total)

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Parameters:

total - value to be set

Returns:

Builder

results

public ProductSelectionProductPagedQueryResponseBuilder results(AssignedProductReference... results)

References to Products that are assigned to the ProductSelection.

Parameters:

results - value to be set

Returns:

Builder

results

public ProductSelectionProductPagedQueryResponseBuilder results(List<AssignedProductReference> results)

References to Products that are assigned to the ProductSelection.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductSelectionProductPagedQueryResponseBuilder plusResults(AssignedProductReference... results)

References to Products that are assigned to the ProductSelection.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductSelectionProductPagedQueryResponseBuilder plusResults(Function<AssignedProductReferenceBuilder,AssignedProductReferenceBuilder> builder)

References to Products that are assigned to the ProductSelection.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ProductSelectionProductPagedQueryResponseBuilder withResults(Function<AssignedProductReferenceBuilder,AssignedProductReferenceBuilder> builder)

References to Products that are assigned to the ProductSelection.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ProductSelectionProductPagedQueryResponseBuilder addResults(Function<AssignedProductReferenceBuilder,AssignedProductReference> builder)

References to Products that are assigned to the ProductSelection.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ProductSelectionProductPagedQueryResponseBuilder setResults(Function<AssignedProductReferenceBuilder,AssignedProductReference> builder)

References to Products that are assigned to the ProductSelection.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Long getLimit()

Number of results requested.

Returns:

limit

getOffset

public Long getOffset()

Number of elements skipped.

Returns:

offset

getCount

public Long getCount()

Actual number of results returned.

Returns:

count

getTotal

@Nullable
public Long getTotal()

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Returns:

total

getResults

public List<AssignedProductReference> getResults()

References to Products that are assigned to the ProductSelection.

Returns:

results

build

public ProductSelectionProductPagedQueryResponse build()

builds ProductSelectionProductPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ProductSelectionProductPagedQueryResponse>

Returns:

ProductSelectionProductPagedQueryResponse

buildUnchecked

public ProductSelectionProductPagedQueryResponse buildUnchecked()

builds ProductSelectionProductPagedQueryResponse without checking for non-null required values

Returns:

ProductSelectionProductPagedQueryResponse

of

public static ProductSelectionProductPagedQueryResponseBuilder of()

factory method for an instance of ProductSelectionProductPagedQueryResponseBuilder

Returns:

builder

of

public static ProductSelectionProductPagedQueryResponseBuilder of(ProductSelectionProductPagedQueryResponse template)

create builder for ProductSelectionProductPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder