Package com.commercetools.api.models.product_search

Class ProductSearchFacetCountValueBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductSearchFacetCountValueBuilder

All Implemented Interfaces:

Builder<ProductSearchFacetCountValue>

public class ProductSearchFacetCountValueBuilder
extends Object
implements Builder<ProductSearchFacetCountValue>

ProductSearchFacetCountValueBuilder Example to create an instance using the builder pattern

     ProductSearchFacetCountValue productSearchFacetCountValue = ProductSearchFacetCountValue.builder()
             .name("{name}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSearchFacetCountValueBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSearchFacetCountValue	build()	builds ProductSearchFacetCountValue with checking for non-null required values
ProductSearchFacetCountValue	buildUnchecked()	builds ProductSearchFacetCountValue without checking for non-null required values
ProductSearchFacetCountValueBuilder	filter(SearchQuery filter)	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetCountValueBuilder	filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	Additional filtering expression to apply to the search result before calculating the facet.
SearchQuery	getFilter()	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetCountLevelEnum	getLevel()	Specify whether to count Products (products) or Product Variants (variants).
String	getName()	Name of the count facet to appear in the ProductSearchFacetResultCount.
ProductSearchFacetScopeEnum	getScope()	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetCountValueBuilder	level(ProductSearchFacetCountLevelEnum level)	Specify whether to count Products (products) or Product Variants (variants).
ProductSearchFacetCountValueBuilder	name(String name)	Name of the count facet to appear in the ProductSearchFacetResultCount.
static ProductSearchFacetCountValueBuilder	of()	factory method for an instance of ProductSearchFacetCountValueBuilder
static ProductSearchFacetCountValueBuilder	of(ProductSearchFacetCountValue template)	create builder for ProductSearchFacetCountValue instance
ProductSearchFacetCountValueBuilder	scope(ProductSearchFacetScopeEnum scope)	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetCountValueBuilder	withFilter(Function<SearchQueryBuilder,SearchQuery> builder)	Additional filtering expression to apply to the search result before calculating the facet.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSearchFacetCountValueBuilder

public ProductSearchFacetCountValueBuilder()

Method Details

name

public ProductSearchFacetCountValueBuilder name(String name)

Name of the count facet to appear in the ProductSearchFacetResultCount.

Parameters:

name - value to be set

Returns:

Builder

scope

public ProductSearchFacetCountValueBuilder scope(@Nullable
 ProductSearchFacetScopeEnum scope)

Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

Parameters:

scope - value to be set

Returns:

Builder

filter

public ProductSearchFacetCountValueBuilder filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)

Additional filtering expression to apply to the search result before calculating the facet.

Parameters:

builder - function to build the filter value

Returns:

Builder

withFilter

public ProductSearchFacetCountValueBuilder withFilter(Function<SearchQueryBuilder,SearchQuery> builder)

Additional filtering expression to apply to the search result before calculating the facet.

Parameters:

builder - function to build the filter value

Returns:

Builder

filter

public ProductSearchFacetCountValueBuilder filter(@Nullable
 SearchQuery filter)

Additional filtering expression to apply to the search result before calculating the facet.

Parameters:

filter - value to be set

Returns:

Builder

level

public ProductSearchFacetCountValueBuilder level(@Nullable
 ProductSearchFacetCountLevelEnum level)

Specify whether to count Products (products) or Product Variants (variants).

Parameters:

level - value to be set

Returns:

Builder

getName

public String getName()

Name of the count facet to appear in the ProductSearchFacetResultCount.

Returns:

name

getScope

@Nullable
public ProductSearchFacetScopeEnum getScope()

Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

Returns:

scope

getFilter

@Nullable
public SearchQuery getFilter()

Additional filtering expression to apply to the search result before calculating the facet.

Returns:

filter

getLevel

@Nullable
public ProductSearchFacetCountLevelEnum getLevel()

Specify whether to count Products (products) or Product Variants (variants).

Returns:

level

build

public ProductSearchFacetCountValue build()

builds ProductSearchFacetCountValue with checking for non-null required values

Specified by:

build in interface Builder<ProductSearchFacetCountValue>

Returns:

ProductSearchFacetCountValue

buildUnchecked

public ProductSearchFacetCountValue buildUnchecked()

builds ProductSearchFacetCountValue without checking for non-null required values

Returns:

ProductSearchFacetCountValue

of

public static ProductSearchFacetCountValueBuilder of()

factory method for an instance of ProductSearchFacetCountValueBuilder

Returns:

builder

of

public static ProductSearchFacetCountValueBuilder of(ProductSearchFacetCountValue template)

create builder for ProductSearchFacetCountValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder