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()	Unique identifier of the Product.
ProductSearchMatchingVariants	getMatchingVariants()	Describes the variants that matched the search criteria.
ProductProjection	getProductProjection()	Contains Product Projection data for Products matching the projection field in the Search Products request.
ProductSearchResultBuilder	id(String id)	Unique identifier of the Product.
ProductSearchResultBuilder	matchingVariants(ProductSearchMatchingVariants matchingVariants)	Describes the variants that matched the search criteria.
ProductSearchResultBuilder	matchingVariants(Function<ProductSearchMatchingVariantsBuilder,ProductSearchMatchingVariantsBuilder> builder)	Describes the variants that matched the search criteria.
static ProductSearchResultBuilder	of()	factory method for an instance of ProductSearchResultBuilder
static ProductSearchResultBuilder	of(ProductSearchResult template)	create builder for ProductSearchResult instance
ProductSearchResultBuilder	productProjection(ProductProjection productProjection)	Contains Product Projection data for Products matching the projection field in the Search Products request.
ProductSearchResultBuilder	productProjection(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)	Contains Product Projection data for Products matching the projection field in the Search Products request.
ProductSearchResultBuilder	withMatchingVariants(Function<ProductSearchMatchingVariantsBuilder,ProductSearchMatchingVariants> builder)	Describes the variants that matched the search criteria.
ProductSearchResultBuilder	withProductProjection(Function<ProductProjectionBuilder,ProductProjection> builder)	Contains Product Projection data for Products matching the projection field in the Search Products request.

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)

Unique identifier of the Product.

Parameters:

id - value to be set

Returns:

Builder

productProjection

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

Contains Product Projection data for Products matching the projection field in the Search Products request.

Parameters:

builder - function to build the productProjection value

Returns:

Builder

withProductProjection

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

Contains Product Projection data for Products matching the projection field in the Search Products request.

Parameters:

builder - function to build the productProjection value

Returns:

Builder

productProjection

public ProductSearchResultBuilder productProjection(@Nullable
 ProductProjection productProjection)

Contains Product Projection data for Products matching the projection field in the Search Products request.

Parameters:

productProjection - value to be set

Returns:

Builder

matchingVariants

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

Describes the variants that matched the search criteria.

Parameters:

builder - function to build the matchingVariants value

Returns:

Builder

withMatchingVariants

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

Describes the variants that matched the search criteria.

Parameters:

builder - function to build the matchingVariants value

Returns:

Builder

matchingVariants

public ProductSearchResultBuilder matchingVariants(@Nullable
 ProductSearchMatchingVariants matchingVariants)

Describes the variants that matched the search criteria.

Parameters:

matchingVariants - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the Product.

Returns:

id

getProductProjection

@Nullable
public ProductProjection getProductProjection()

Contains Product Projection data for Products matching the projection field in the Search Products request.

Returns:

productProjection

getMatchingVariants

@Nullable
public ProductSearchMatchingVariants getMatchingVariants()

Describes the variants that matched the search criteria.

Returns:

matchingVariants

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