Package com.broadleafcommerce.catalog.web.endpoint.dto

Class ProductConsolidationRequest

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.dto.ProductConsolidationRequest

All Implemented Interfaces:

Serializable

public class ProductConsolidationRequest
extends Object
implements Serializable

The request DTO for the product consolidation flow.

This is helpful to configure what data to and not to gather for each request to avoid consuming unnecessary resources.

Since:

2.1.1, 2.0.2

Author:

Sunny Yu

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_INFO_KEY

Constructor Summary

Constructors

Constructor	Description
ProductConsolidationRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAdditionalAttributes()	Additional attributes.
int	hashCode()
boolean	isIncludeAllProductAssets()	Determines whether the product consolidation flow should include all ProductAssets.
boolean	isIncludeCategoryProducts()	Determines whether the product consolidation flow should include all CategoryProducts.
boolean	isIncludeOptionTemplates()	Determines whether the product consolidation flow should include all OptionTemplates.
boolean	isIncludePrimaryProductAssets()	Determines whether the product consolidation flow should include all Primary ProductAssets.
boolean	isIncludeProductTags()	Determines whether the product consolidation flow should include all ProductTags.
boolean	isIncludeVariants()	Determines whether the product consolidation flow should include all Variants.
void	setAdditionalAttributes(Map<String,Object> additionalAttributes)	Additional attributes.
void	setIncludeAllProductAssets(boolean includeAllProductAssets)	Determines whether the product consolidation flow should include all ProductAssets.
void	setIncludeCategoryProducts(boolean includeCategoryProducts)	Determines whether the product consolidation flow should include all CategoryProducts.
void	setIncludeOptionTemplates(boolean includeOptionTemplates)	Determines whether the product consolidation flow should include all OptionTemplates.
void	setIncludePrimaryProductAssets(boolean includePrimaryProductAssets)	Determines whether the product consolidation flow should include all Primary ProductAssets.
void	setIncludeProductTags(boolean includeProductTags)	Determines whether the product consolidation flow should include all ProductTags.
void	setIncludeVariants(boolean includeVariants)	Determines whether the product consolidation flow should include all Variants.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONTEXT_INFO_KEY

public static final String CONTEXT_INFO_KEY

See Also:

• Constant Field Values

Constructor Details

ProductConsolidationRequest

public ProductConsolidationRequest()

Method Details

isIncludeAllProductAssets

public boolean isIncludeAllProductAssets()

Determines whether the product consolidation flow should include all ProductAssets.

See Also:

• AllAssetsProductConsolidationContributor

isIncludePrimaryProductAssets

public boolean isIncludePrimaryProductAssets()

Determines whether the product consolidation flow should include all Primary ProductAssets.

See Also:

• PrimaryAssetProductConsolidationContributor

isIncludeCategoryProducts

public boolean isIncludeCategoryProducts()

Determines whether the product consolidation flow should include all CategoryProducts.

See Also:

• CategoryProductConsolidationContributor

isIncludeOptionTemplates

public boolean isIncludeOptionTemplates()

Determines whether the product consolidation flow should include all OptionTemplates.

See Also:

• OptionTemplateProductConsolidationContributor

isIncludeProductTags

public boolean isIncludeProductTags()

Determines whether the product consolidation flow should include all ProductTags.

See Also:

• ProductTagConsolidationContributor

isIncludeVariants

public boolean isIncludeVariants()

Determines whether the product consolidation flow should include all Variants.

See Also:

• VariantProductConsolidationContributor

getAdditionalAttributes

public Map<String,Object> getAdditionalAttributes()

Additional attributes.

setIncludeAllProductAssets

public void setIncludeAllProductAssets(boolean includeAllProductAssets)

Determines whether the product consolidation flow should include all ProductAssets.

See Also:

• AllAssetsProductConsolidationContributor

setIncludePrimaryProductAssets

public void setIncludePrimaryProductAssets(boolean includePrimaryProductAssets)

Determines whether the product consolidation flow should include all Primary ProductAssets.

See Also:

• PrimaryAssetProductConsolidationContributor

setIncludeCategoryProducts

public void setIncludeCategoryProducts(boolean includeCategoryProducts)

Determines whether the product consolidation flow should include all CategoryProducts.

See Also:

• CategoryProductConsolidationContributor

setIncludeOptionTemplates

public void setIncludeOptionTemplates(boolean includeOptionTemplates)

Determines whether the product consolidation flow should include all OptionTemplates.

See Also:

• OptionTemplateProductConsolidationContributor

setIncludeProductTags

public void setIncludeProductTags(boolean includeProductTags)

Determines whether the product consolidation flow should include all ProductTags.

See Also:

• ProductTagConsolidationContributor

setIncludeVariants

public void setIncludeVariants(boolean includeVariants)

Determines whether the product consolidation flow should include all Variants.

See Also:

• VariantProductConsolidationContributor

setAdditionalAttributes

public void setAdditionalAttributes(Map<String,Object> additionalAttributes)

Additional attributes.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object