Package com.commercetools.api.models.product_search

Class ProductSearchFacetRangesValueBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductSearchFacetRangesValueBuilder

All Implemented Interfaces:

Builder<ProductSearchFacetRangesValue>

public class ProductSearchFacetRangesValueBuilder
extends Object
implements Builder<ProductSearchFacetRangesValue>

ProductSearchFacetRangesValueBuilder Example to create an instance using the builder pattern

     ProductSearchFacetRangesValue productSearchFacetRangesValue = ProductSearchFacetRangesValue.builder()
             .name("{name}")
             .field("{field}")
             .plusRanges(rangesBuilder -> rangesBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSearchFacetRangesValueBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSearchFacetRangesValueBuilder	addRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRange> builder)	Define ranges for the facet.
ProductSearchFacetRangesValue	build()	builds ProductSearchFacetRangesValue with checking for non-null required values
ProductSearchFacetRangesValue	buildUnchecked()	builds ProductSearchFacetRangesValue without checking for non-null required values
ProductSearchFacetRangesValueBuilder	field(String field)	The searchable Product field to facet on.
ProductSearchFacetRangesValueBuilder	fieldType(SearchFieldType fieldType)	If the field is not standard, this must be the Attribute type.
ProductSearchFacetRangesValueBuilder	filter(SearchQuery filter)	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetRangesValueBuilder	filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	Additional filtering expression to apply to the search result before calculating the facet.
String	getField()	The searchable Product field to facet on.
SearchFieldType	getFieldType()	If the field is not standard, this must be the Attribute type.
SearchQuery	getFilter()	Additional filtering expression to apply to the search result before calculating the facet.
String	getLanguage()	String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47.
ProductSearchFacetCountLevelEnum	getLevel()	Specify whether to count Products (products) or Product Variants (variants).
String	getName()	Name of the ranges facet to appear in the ProductSearchFacetResultBucket.
List<ProductSearchFacetRangesFacetRange>	getRanges()	Define ranges for the facet.
ProductSearchFacetScopeEnum	getScope()	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetRangesValueBuilder	language(String language)	String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47.
ProductSearchFacetRangesValueBuilder	level(ProductSearchFacetCountLevelEnum level)	Specify whether to count Products (products) or Product Variants (variants).
ProductSearchFacetRangesValueBuilder	name(String name)	Name of the ranges facet to appear in the ProductSearchFacetResultBucket.
static ProductSearchFacetRangesValueBuilder	of()	factory method for an instance of ProductSearchFacetRangesValueBuilder
static ProductSearchFacetRangesValueBuilder	of(ProductSearchFacetRangesValue template)	create builder for ProductSearchFacetRangesValue instance
ProductSearchFacetRangesValueBuilder	plusRanges(ProductSearchFacetRangesFacetRange... ranges)	Define ranges for the facet.
ProductSearchFacetRangesValueBuilder	plusRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRangeBuilder> builder)	Define ranges for the facet.
ProductSearchFacetRangesValueBuilder	ranges(ProductSearchFacetRangesFacetRange... ranges)	Define ranges for the facet.
ProductSearchFacetRangesValueBuilder	ranges(List<ProductSearchFacetRangesFacetRange> ranges)	Define ranges for the facet.
ProductSearchFacetRangesValueBuilder	scope(ProductSearchFacetScopeEnum scope)	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetRangesValueBuilder	setRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRange> builder)	Define ranges for the facet.
ProductSearchFacetRangesValueBuilder	withFilter(Function<SearchQueryBuilder,SearchQuery> builder)	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetRangesValueBuilder	withRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRangeBuilder> builder)	Define ranges for the facet.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSearchFacetRangesValueBuilder

public ProductSearchFacetRangesValueBuilder()

Method Details

name

public ProductSearchFacetRangesValueBuilder name(String name)

Name of the ranges facet to appear in the ProductSearchFacetResultBucket.

Parameters:

name - value to be set

Returns:

Builder

scope

public ProductSearchFacetRangesValueBuilder 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 ProductSearchFacetRangesValueBuilder 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 ProductSearchFacetRangesValueBuilder 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 ProductSearchFacetRangesValueBuilder 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 ProductSearchFacetRangesValueBuilder level(@Nullable
 ProductSearchFacetCountLevelEnum level)

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

Parameters:

level - value to be set

Returns:

Builder

field

public ProductSearchFacetRangesValueBuilder field(String field)

The searchable Product field to facet on.

Parameters:

field - value to be set

Returns:

Builder

ranges

public ProductSearchFacetRangesValueBuilder ranges(ProductSearchFacetRangesFacetRange... ranges)

Define ranges for the facet.

Parameters:

ranges - value to be set

Returns:

Builder

ranges

public ProductSearchFacetRangesValueBuilder ranges(List<ProductSearchFacetRangesFacetRange> ranges)

Define ranges for the facet.

Parameters:

ranges - value to be set

Returns:

Builder

plusRanges

public ProductSearchFacetRangesValueBuilder plusRanges(ProductSearchFacetRangesFacetRange... ranges)

Define ranges for the facet.

Parameters:

ranges - value to be set

Returns:

Builder

plusRanges

public ProductSearchFacetRangesValueBuilder plusRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRangeBuilder> builder)

Define ranges for the facet.

Parameters:

builder - function to build the ranges value

Returns:

Builder

withRanges

public ProductSearchFacetRangesValueBuilder withRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRangeBuilder> builder)

Define ranges for the facet.

Parameters:

builder - function to build the ranges value

Returns:

Builder

addRanges

public ProductSearchFacetRangesValueBuilder addRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRange> builder)

Define ranges for the facet.

Parameters:

builder - function to build the ranges value

Returns:

Builder

setRanges

public ProductSearchFacetRangesValueBuilder setRanges(Function<ProductSearchFacetRangesFacetRangeBuilder,ProductSearchFacetRangesFacetRange> builder)

Define ranges for the facet.

Parameters:

builder - function to build the ranges value

Returns:

Builder

language

public ProductSearchFacetRangesValueBuilder language(@Nullable
 String language)

String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

Parameters:

language - value to be set

Returns:

Builder

fieldType

public ProductSearchFacetRangesValueBuilder fieldType(@Nullable
 SearchFieldType fieldType)

If the field is not standard, this must be the Attribute type.

Parameters:

fieldType - value to be set

Returns:

Builder

getName

public String getName()

Name of the ranges facet to appear in the ProductSearchFacetResultBucket.

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

getField

public String getField()

The searchable Product field to facet on.

Returns:

field

getRanges

public List<ProductSearchFacetRangesFacetRange> getRanges()

Define ranges for the facet.

Returns:

ranges

getLanguage

@Nullable
public String getLanguage()

String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

Returns:

language

getFieldType

@Nullable
public SearchFieldType getFieldType()

If the field is not standard, this must be the Attribute type.

Returns:

fieldType

build

public ProductSearchFacetRangesValue build()

builds ProductSearchFacetRangesValue with checking for non-null required values

Specified by:

build in interface Builder<ProductSearchFacetRangesValue>

Returns:

ProductSearchFacetRangesValue

buildUnchecked

public ProductSearchFacetRangesValue buildUnchecked()

builds ProductSearchFacetRangesValue without checking for non-null required values

Returns:

ProductSearchFacetRangesValue

of

public static ProductSearchFacetRangesValueBuilder of()

factory method for an instance of ProductSearchFacetRangesValueBuilder

Returns:

builder

of

public static ProductSearchFacetRangesValueBuilder of(ProductSearchFacetRangesValue template)

create builder for ProductSearchFacetRangesValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder