Package com.commercetools.api.models.product_search

Class ProductSearchResultBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductSearchResultBuilder

All Implemented Interfaces:

Builder<ProductSearchResult>

public class ProductSearchResultBuilder
extends Object
implements Builder<ProductSearchResult>

ProductSearchResultBuilder Example to create an instance using the builder pattern

     ProductSearchResult productSearchResult = ProductSearchResult.builder()
             .id("{id}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSearchResultBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSearchResult	build()	builds ProductSearchResult with checking for non-null required values
ProductSearchResult	buildUnchecked()	builds ProductSearchResult without checking for non-null required values
String	getId()	id of the Product that matches the search query.
ProductSearchMatchingVariants	getMatchingVariants()	Information about which Product Variants match the search query.
ProductProjection	getProductProjection()	Projected data of the Product with id.
ProductSearchResultBuilder	id(String id)	id of the Product that matches the search query.
ProductSearchResultBuilder	matchingVariants(ProductSearchMatchingVariants matchingVariants)	Information about which Product Variants match the search query.
ProductSearchResultBuilder	matchingVariants(Function<ProductSearchMatchingVariantsBuilder,ProductSearchMatchingVariantsBuilder> builder)	Information about which Product Variants match the search query.
static ProductSearchResultBuilder	of()	factory method for an instance of ProductSearchResultBuilder
static ProductSearchResultBuilder	of(ProductSearchResult template)	create builder for ProductSearchResult instance
ProductSearchResultBuilder	productProjection(ProductProjection productProjection)	Projected data of the Product with id.
ProductSearchResultBuilder	productProjection(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)	Projected data of the Product with id.
ProductSearchResultBuilder	withMatchingVariants(Function<ProductSearchMatchingVariantsBuilder,ProductSearchMatchingVariants> builder)	Information about which Product Variants match the search query.
ProductSearchResultBuilder	withProductProjection(Function<ProductProjectionBuilder,ProductProjection> builder)	Projected data of the Product with id.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSearchResultBuilder

public ProductSearchResultBuilder()

Method Details

id

public ProductSearchResultBuilder id(String id)

id of the Product that matches the search query.

Parameters:

id - value to be set

Returns:

Builder

matchingVariants

public ProductSearchResultBuilder matchingVariants(Function<ProductSearchMatchingVariantsBuilder,ProductSearchMatchingVariantsBuilder> builder)

Information about which Product Variants match the search query. Only present if markMatchingVariants is set to true in the ProductSearchRequest.

Parameters:

builder - function to build the matchingVariants value

Returns:

Builder

withMatchingVariants

public ProductSearchResultBuilder withMatchingVariants(Function<ProductSearchMatchingVariantsBuilder,ProductSearchMatchingVariants> builder)

Information about which Product Variants match the search query. Only present if markMatchingVariants is set to true in the ProductSearchRequest.

Parameters:

builder - function to build the matchingVariants value

Returns:

Builder

matchingVariants

public ProductSearchResultBuilder matchingVariants(@Nullable
 ProductSearchMatchingVariants matchingVariants)

Information about which Product Variants match the search query. Only present if markMatchingVariants is set to true in the ProductSearchRequest.

Parameters:

matchingVariants - value to be set

Returns:

Builder

productProjection

public ProductSearchResultBuilder productProjection(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)

Projected data of the Product with id. Only present if data integration with Product Projection parameters is requested.

Parameters:

builder - function to build the productProjection value

Returns:

Builder

withProductProjection

public ProductSearchResultBuilder withProductProjection(Function<ProductProjectionBuilder,ProductProjection> builder)

Projected data of the Product with id. Only present if data integration with Product Projection parameters is requested.

Parameters:

builder - function to build the productProjection value

Returns:

Builder

productProjection

public ProductSearchResultBuilder productProjection(@Nullable
 ProductProjection productProjection)

Projected data of the Product with id. Only present if data integration with Product Projection parameters is requested.

Parameters:

productProjection - value to be set

Returns:

Builder

getId

public String getId()

id of the Product that matches the search query.

Returns:

id

getMatchingVariants

@Nullable
public ProductSearchMatchingVariants getMatchingVariants()

Information about which Product Variants match the search query. Only present if markMatchingVariants is set to true in the ProductSearchRequest.

Returns:

matchingVariants

getProductProjection

@Nullable
public ProductProjection getProductProjection()

Projected data of the Product with id. Only present if data integration with Product Projection parameters is requested.

Returns:

productProjection

build

public ProductSearchResult build()

builds ProductSearchResult with checking for non-null required values

Specified by:

build in interface Builder<ProductSearchResult>

Returns:

ProductSearchResult

buildUnchecked

public ProductSearchResult buildUnchecked()

builds ProductSearchResult without checking for non-null required values

Returns:

ProductSearchResult

of

public static ProductSearchResultBuilder of()

factory method for an instance of ProductSearchResultBuilder

Returns:

builder

of

public static ProductSearchResultBuilder of(ProductSearchResult template)

create builder for ProductSearchResult instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder