Package com.broadleafcommerce.dataexchange.service.product

Class VariantBatchItemHandler<T extends Variant>

java.lang.Object

com.broadleafcommerce.dataexchange.service.AbstractBatchItemHandler<T1,T2>

com.broadleafcommerce.dataexchange.service.product.ProductRelatedBatchItemHandler<ComprehensiveProduct,T>

com.broadleafcommerce.dataexchange.service.product.VariantBatchItemHandler<T>

All Implemented Interfaces:

BatchItemHandler<ComprehensiveProduct,T>

public class VariantBatchItemHandler<T extends Variant>
extends ProductRelatedBatchItemHandler<ComprehensiveProduct,T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXISTING_VARIANT_TAGS	Existing product tags map, keyed by tag name and ID.
static final String	VARIANT_TRANSLATION_MAP

Constructor Summary

Constructors

Constructor

Description

VariantBatchItemHandler(CatalogProvider<ComprehensiveProduct,T> catalogProvider, ProductTagBatchItemHandler<ProductTag> tagBatchItemHandler, AdvancedTagProvider<AdvancedTag,ProductTag> tagProvider, List<VariantRelatedBatchItemHandler<ComprehensiveProduct,?>> childItemHandlers, ProductBatchItemHandlerHelper<ComprehensiveProduct> helper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected Function<? super Void,? extends CompletionStage<Void>>	buildSaveTagFutures(HandlerArgs<ComprehensiveProduct,T> args)
protected @NotNull Function<Void,CompletionStage<Void>>	buildSaveTranslationFutures(HandlerArgs<ComprehensiveProduct,T> args)
boolean	canHandle(ExchangeObject exchangeObject)	Determines if this handler can handle the given exchange object.
CompletableFuture<Void>	createSupplementalFutures(HandlerArgs<ComprehensiveProduct,T> args)	Create any supplemental futures that should be executed after the main future.
protected CatalogProvider<ComprehensiveProduct,T>	getCatalogProvider()
protected List<VariantRelatedBatchItemHandler<ComprehensiveProduct,?>>	getChildItemHandlers()
protected ProductBatchItemHandlerHelper<ComprehensiveProduct>	getHelper()
protected ProductTagBatchItemHandler<ProductTag>	getTagBatchItemHandler()
protected AdvancedTagProvider<AdvancedTag,ProductTag>	getTagProvider()
T	handleCreate(HandlerArgs<ComprehensiveProduct,T> args)	Handle the create operation.
T	handleDelete(HandlerArgs<ComprehensiveProduct,T> args)	Handle the delete operation.
protected CompletableFuture<Void>	handleTags(HandlerArgs<ComprehensiveProduct,T> args)
T	handleUpdate(HandlerArgs<ComprehensiveProduct,T> args)	Handle the update operation.
protected void	initTranslationsList(T savedVariant)
protected void	initVariantsList(ComprehensiveProduct savedProduct)
protected CompletableFuture<Void>	loadExistingTags(HandlerArgs<ComprehensiveProduct,T> args)
Runnable	postHandle(HandlerArgs<ComprehensiveProduct,T> args)	This method is called after the item has been saved.
protected CompletableFuture<Void>	prepareVariantTranslations(HandlerArgs<ComprehensiveProduct,T> args)
protected CompletableFuture<Void>	saveTranslationsFutures(HandlerArgs<ComprehensiveProduct,T> args)
protected Runnable	saveVariantTranslationRunnable(List<Translation> translations, Locale locale, HandlerArgs<ComprehensiveProduct,T> args)

Methods inherited from class com.broadleafcommerce.dataexchange.service.AbstractBatchItemHandler

applyHandle, applyPostOperations, buildTranslationMap, createFutureInternal, execute, execute, execute, execute, getSavedTopLevel, getTypeFactory, isNewlyCreated

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.dataexchange.service.BatchItemHandler

completedFuture, createCompletableFuture, createCompletableFuture, handle, populateCorrelationId, preHandle, retryableRunnable, retryableSupplier, shouldAbort

Field Details

VARIANT_TRANSLATION_MAP

public static final String VARIANT_TRANSLATION_MAP

See Also:

• Constant Field Values

EXISTING_VARIANT_TAGS

public static final String EXISTING_VARIANT_TAGS

Existing product tags map, keyed by tag name and ID.

See Also:

• Constant Field Values

Constructor Details

VariantBatchItemHandler

public VariantBatchItemHandler(CatalogProvider<ComprehensiveProduct,T> catalogProvider,
 ProductTagBatchItemHandler<ProductTag> tagBatchItemHandler,
 AdvancedTagProvider<AdvancedTag,ProductTag> tagProvider,
 List<VariantRelatedBatchItemHandler<ComprehensiveProduct,?>> childItemHandlers,
 ProductBatchItemHandlerHelper<ComprehensiveProduct> helper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

handleCreate

public T handleCreate(HandlerArgs<ComprehensiveProduct,T> args)

Description copied from interface: BatchItemHandler

Handle the create operation. This method is called when HandlerArgs.getOperationType() is BatchItemOperationType.CREATE.

handleUpdate

public T handleUpdate(HandlerArgs<ComprehensiveProduct,T> args)

Description copied from interface: BatchItemHandler

Handle the update operation. This method is called when HandlerArgs.getOperationType() is BatchItemOperationType.UPDATE.

handleDelete

@Nullable
public T handleDelete(HandlerArgs<ComprehensiveProduct,T> args)

Description copied from interface: BatchItemHandler

Handle the delete operation. This method is called when HandlerArgs.getOperationType() is BatchItemOperationType.DELETE.

When performing a delete, unless there is additional logic that needs to be executed, the supplier should return null.

postHandle

public Runnable postHandle(HandlerArgs<ComprehensiveProduct,T> args)

Description copied from interface: BatchItemHandler

This method is called after the item has been saved. Any items that should be done after the item is saved should be done here. At minimum, the implementation should set the savedItem result on the parent. At this point, the item is considered "done" and no high risk operations (e.g. API calls) should be done here.

Parameters:

args - the handler arguments. Returns null if no action is necessary.

initVariantsList

protected void initVariantsList(ComprehensiveProduct savedProduct)

createSupplementalFutures

public CompletableFuture<Void> createSupplementalFutures(HandlerArgs<ComprehensiveProduct,T> args)

Description copied from interface: BatchItemHandler

Create any supplemental futures that should be executed after the main future. This should be implemented to handle any child entities that need to be processed after the main entity is handled. CompletableFuture<Void> future1 = ... CompletableFuture<Void> future2 = ... return CompletableFuture.allOf(future1, future2);

NOTE: See class level documentation for important information about composing futures.

Parameters:

args - The handler arguments

Returns:

A completable future that will execute any supplemental futures. By default, this returns a completed future.

handleTags

protected CompletableFuture<Void> handleTags(HandlerArgs<ComprehensiveProduct,T> args)

buildSaveTagFutures

protected Function<? super Void,? extends CompletionStage<Void>> buildSaveTagFutures(HandlerArgs<ComprehensiveProduct,T> args)

loadExistingTags

protected CompletableFuture<Void> loadExistingTags(HandlerArgs<ComprehensiveProduct,T> args)

saveTranslationsFutures

protected CompletableFuture<Void> saveTranslationsFutures(HandlerArgs<ComprehensiveProduct,T> args)

prepareVariantTranslations

protected CompletableFuture<Void> prepareVariantTranslations(HandlerArgs<ComprehensiveProduct,T> args)

buildSaveTranslationFutures

@NotNull
protected @NotNull Function<Void,CompletionStage<Void>> buildSaveTranslationFutures(HandlerArgs<ComprehensiveProduct,T> args)

saveVariantTranslationRunnable

protected Runnable saveVariantTranslationRunnable(List<Translation> translations,
 Locale locale,
 HandlerArgs<ComprehensiveProduct,T> args)

initTranslationsList

protected void initTranslationsList(T savedVariant)

canHandle

public boolean canHandle(ExchangeObject exchangeObject)

Description copied from interface: BatchItemHandler

Determines if this handler can handle the given exchange object.

Parameters:

exchangeObject - the exchange object

Returns:

true if this handler can handle the exchange object, false otherwise

getCatalogProvider

protected CatalogProvider<ComprehensiveProduct,T> getCatalogProvider()

getChildItemHandlers

protected List<VariantRelatedBatchItemHandler<ComprehensiveProduct,?>> getChildItemHandlers()

getTagProvider

protected AdvancedTagProvider<AdvancedTag,ProductTag> getTagProvider()

getTagBatchItemHandler

protected ProductTagBatchItemHandler<ProductTag> getTagBatchItemHandler()

getHelper

protected ProductBatchItemHandlerHelper<ComprehensiveProduct> getHelper()