Package com.broadleafcommerce.dataexchange.service.product

Class ProductAssetBatchItemHandler<T extends ProductAsset>

java.lang.Object
com.broadleafcommerce.dataexchange.service.AbstractBatchItemHandler<T1,T2>
com.broadleafcommerce.dataexchange.service.product.ProductRelatedBatchItemHandler<ComprehensiveProduct,T>
com.broadleafcommerce.dataexchange.service.product.ProductAssetBatchItemHandler<T>
All Implemented Interfaces:
BatchItemHandler<ComprehensiveProduct,T>
public class ProductAssetBatchItemHandler<T extends ProductAsset> extends ProductRelatedBatchItemHandler<ComprehensiveProduct,T>

  • Field Details

  • Constructor Details

    • ProductAssetBatchItemHandler

      public ProductAssetBatchItemHandler(ProductAssetProvider<T> assetProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

  • Method Details

    • 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.

    • buildVariantTranslationsMap

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

    • buildSaveTranslationFutures

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

    • initTranslationsList

      protected void initTranslationsList(ProductAsset savedAsset)

    • preHandle

      public Runnable preHandle(HandlerArgs<ComprehensiveProduct,T> args)
      Description copied from interface: BatchItemHandler
      Perform any necessary actions before the item is handled (e.g. fetching data, determining save/delete, etc.).
      Parameters:
      args - The handler arguments
      Returns:
      A runnable that will be executed before the item is handled. If no action is necessary, returns null.

    • 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.

    • 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.

    • 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

    • initAssetList

      protected void initAssetList(ComprehensiveProduct product)

    • getAssetProvider

      protected ProductAssetProvider<T> getAssetProvider()