Package com.broadleafcommerce.dataexchange.service.provider

Interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

All Known Implementing Classes:

ExternalCatalogProvider

public interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

Interface for interacting with catalog data, typically by making remote calls.

Author:

Kelly Tisdell (ktisdell)

Method Summary

Modifier and Type	Method	Description
T1	createProduct(T1 product, BatchContext<?> batchContext)
T2	createVariant(T1 product, T2 variant, BatchContext<?> batchContext)
void	deleteVariant(String productId, String variantId, BatchContext<?> context)
T1	generateOptions(GenerateProductOption generateProductOption, BatchContext<?> batchContext)
DataDrivenEnumResponse	readDataDrivenEnums(DataDrivenEnumRequestFilters filters, BatchContext<?> batchContext)	Fetches a list of DataDrivenEnums based on the provided filters.
List<OptionTemplateGroup>	readOptionTemplateGroups(cz.jirutka.rsql.parser.ast.Node node, BatchContext<?> batchContext)
List<OptionTemplateGroup>	readOptionTemplateGroupsByNameIn(Collection<String> names, BatchContext<?> batchContext)
List<OptionTemplate>	readOptionTemplates(cz.jirutka.rsql.parser.ast.Node node, BatchContext<?> batchContext)
List<OptionTemplate>	readOptionTemplatesByNameIn(Collection<String> names, BatchContext<?> batchContext)
T1	readProductById(String productId, BatchContext<?> batchContext)
ProductList<T1>	readProducts(List<T1> requestedProducts, BatchContext<?> batchContext)	Fetches a list of Products based on externalId, SKU, or URI.
ProductList<T1>	readProducts(org.springframework.util.MultiValueMap<String,String> params, BatchContext<?> context)
T2	readVariant(String productId, String variantId, BatchContext<?> context)
T2	readVariantById(String productId, String variantId, BatchContext<?> batchContext)
List<T2>	readVariants(List<T1> products, BatchContext<?> batchContext)
List<T2>	readVariantsForProduct(T1 products, BatchContext<?> batchContext)
List<Translation>	saveProductTranslations(T1 product, Locale locale, List<Translation> translations, BatchContext<?> batchContext)	Saves translations, specifically for a Product.
List<Translation>	saveVariantTranslations(T1 product, T2 variant, Locale locale, List<Translation> translations, BatchContext<?> batchContext)
T1	updateProduct(T1 product, BatchContext<?> batchContext)
T2	updateVariant(T1 product, T2 variant, BatchContext<?> batchContext)

Method Details

readProducts

ProductList<T1> readProducts(List<T1> requestedProducts,
 BatchContext<?> batchContext)

Fetches a list of Products based on externalId, SKU, or URI. This is to find existing products for update.

Parameters:

requestedProducts -

batchContext -

Returns:

readProducts

ProductList<T1> readProducts(@Nullable
 org.springframework.util.MultiValueMap<String,String> params,
 @Nullable
 BatchContext<?> context)

readProductById

T1 readProductById(String productId,
 BatchContext<?> batchContext)

createProduct

T1 createProduct(T1 product,
 BatchContext<?> batchContext)

updateProduct

T1 updateProduct(T1 product,
 BatchContext<?> batchContext)

generateOptions

T1 generateOptions(GenerateProductOption generateProductOption,
 BatchContext<?> batchContext)

readVariantById

T2 readVariantById(String productId,
 String variantId,
 BatchContext<?> batchContext)

readVariant

T2 readVariant(String productId,
 String variantId,
 BatchContext<?> context)

deleteVariant

void deleteVariant(String productId,
 String variantId,
 BatchContext<?> context)

saveProductTranslations

List<Translation> saveProductTranslations(T1 product,
 Locale locale,
 List<Translation> translations,
 BatchContext<?> batchContext)

Saves translations, specifically for a Product.

Parameters:

product - the product for which to save translations

locale - the locale for the translations - must be the same for all

translations - the list of translations

batchContext - the batch context including the ContextInfo

Returns:

the list of translations

readVariants

List<T2> readVariants(List<T1> products,
 BatchContext<?> batchContext)

readVariantsForProduct

List<T2> readVariantsForProduct(T1 products,
 BatchContext<?> batchContext)

createVariant

T2 createVariant(T1 product,
 T2 variant,
 BatchContext<?> batchContext)

updateVariant

T2 updateVariant(T1 product,
 T2 variant,
 BatchContext<?> batchContext)

saveVariantTranslations

List<Translation> saveVariantTranslations(T1 product,
 T2 variant,
 Locale locale,
 List<Translation> translations,
 BatchContext<?> batchContext)

readDataDrivenEnums

DataDrivenEnumResponse readDataDrivenEnums(DataDrivenEnumRequestFilters filters,
 BatchContext<?> batchContext)

Fetches a list of DataDrivenEnums based on the provided filters.

Parameters:

filters - the filters to apply

batchContext - the batch context

Returns:

the list of DataDrivenEnums

readOptionTemplateGroups

List<OptionTemplateGroup> readOptionTemplateGroups(cz.jirutka.rsql.parser.ast.Node node,
 BatchContext<?> batchContext)

readOptionTemplates

List<OptionTemplate> readOptionTemplates(cz.jirutka.rsql.parser.ast.Node node,
 BatchContext<?> batchContext)

readOptionTemplateGroupsByNameIn

List<OptionTemplateGroup> readOptionTemplateGroupsByNameIn(Collection<String> names,
 BatchContext<?> batchContext)

readOptionTemplatesByNameIn

List<OptionTemplate> readOptionTemplatesByNameIn(Collection<String> names,
 BatchContext<?> batchContext)