Package com.broadleafcommerce.catalog.service.product

Class SkuGenerationService<P extends Variant>

java.lang.Object

com.broadleafcommerce.catalog.service.product.SkuGenerationService<P>

@ConfigurationProperties("broadleaf.catalog.sku.generation")
public class SkuGenerationService<P extends Variant>
extends Object

Responsible for generating Skus for a OptionTemplateGroup. To customize the SKU codes that are genereated, see generateUniqueSkuCode(String).

Author:

Phillip Verheyden (phillipuniverse)

Constructor Summary

Constructors

Constructor	Description
SkuGenerationService(VariantService<P> variantSvc, ProductService<Product> productSvc, ProductOptionValueCombinationService combinationSvc, com.broadleafcommerce.common.extension.TypeFactory typeFactory, org.springframework.transaction.support.TransactionTemplate template)

Method Summary

Modifier and Type	Method	Description
protected <T extends ProductOptionValueCombination> P	buildVariant(String skuPrefix, Collection<T> valuesCombination, Product product)
<T extends ProductOptionValueCombination, C extends Collection<T>> List<P>	createAndSaveVariants(Collection<C> combinationsToCreate, Product product, String skuCodePrefix, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Creates and persists Variants for the given option combinations.
List<P>	generateSkus(String skuCodePrefix, String productId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Generate a set of Variants from a pre-configured OptionTemplateGroup.
protected String	generateUniqueSkuCode(String skuPrefix)	Extension point to customize the format of SKU codes that are generated
protected <T extends ProductOptionValueCombination> String	generateVariantName(Product product, Collection<T> valuesCombination)	Extension point to customize the variant names that are generated
protected ProductOptionValueCombinationService	getCombinationSvc()
protected OptionTemplateService<OptionTemplate>	getOptionTemplateService()
int	getPostfixCharacters()
protected ProductService<Product>	getProductSvc()
protected org.springframework.transaction.support.TransactionTemplate	getTemplate()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected VariantService<P>	getVariantSvc()
void	setOptionTemplateService(OptionTemplateService<OptionTemplate> optionTemplateService)
void	setPostfixCharacters(int postfixCharacters)

Methods inherited from class java.lang.Object

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

Constructor Details

SkuGenerationService

public SkuGenerationService(VariantService<P> variantSvc,
 ProductService<Product> productSvc,
 ProductOptionValueCombinationService combinationSvc,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 org.springframework.transaction.support.TransactionTemplate template)

Method Details

generateSkus

public List<P> generateSkus(@Nullable
 String skuCodePrefix,
 @NonNull
 String productId,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Generate a set of Variants from a pre-configured OptionTemplateGroup. Variants are only generated if the OptionTemplates that appear in the given OptionTemplateGroup are DefaultProductOptionType.VARIANT_DISTINGUISHING.

All of the Variants created as a result of this operation are saved in the backing data store

Parameters:

skuCodePrefix - an optional prefix to assign to each Variant

productId - Product to generate Skus for

context - optional context that the generated Skus should appear in

Returns:

all of the Variants that were generated

See Also:

• ProductOptionValueCombinationService

createAndSaveVariants

public <T extends ProductOptionValueCombination,
C extends Collection<T>>
List<P> createAndSaveVariants(Collection<C> combinationsToCreate,
 Product product,
 @Nullable
 String skuCodePrefix,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Creates and persists Variants for the given option combinations.

Type Parameters:

T - The type of ProductOptionValueCombination

C - The type of Collection containing ProductOptionValueCombinations.

Parameters:

combinationsToCreate - Combination of option values to create variants for.

product - The parent product

skuCodePrefix - A prefix for the SKUs for the generated variants.

contextInfo - Additional sandbox and multitenant info.

Returns:

The created Variants.

buildVariant

protected <T extends ProductOptionValueCombination>
P buildVariant(@Nullable
 String skuPrefix,
 Collection<T> valuesCombination,
 Product product)

generateUniqueSkuCode

protected String generateUniqueSkuCode(@Nullable
 String skuPrefix)

Extension point to customize the format of SKU codes that are generated

Parameters:

skuPrefix - the preconfigured prefix for a SKU

Returns:

a unique SKU code

generateVariantName

protected <T extends ProductOptionValueCombination>
String generateVariantName(Product product,
 Collection<T> valuesCombination)

Extension point to customize the variant names that are generated

Parameters:

product - the owning product

valuesCombination - the product option value combination used to generate this variant

Returns:

a name for the variant

getVariantSvc

protected VariantService<P> getVariantSvc()

getProductSvc

protected ProductService<Product> getProductSvc()

getOptionTemplateService

protected OptionTemplateService<OptionTemplate> getOptionTemplateService()

setOptionTemplateService

@Autowired
public void setOptionTemplateService(OptionTemplateService<OptionTemplate> optionTemplateService)

getCombinationSvc

protected ProductOptionValueCombinationService getCombinationSvc()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getTemplate

protected org.springframework.transaction.support.TransactionTemplate getTemplate()

setPostfixCharacters

public void setPostfixCharacters(int postfixCharacters)

getPostfixCharacters

public int getPostfixCharacters()