Package com.broadleafcommerce.dataexchange.service.product

Class ProductBatchItemHandlerHelper<T extends ComprehensiveProduct>

java.lang.Object
com.broadleafcommerce.dataexchange.service.product.ProductBatchItemHandlerHelper<T>
public class ProductBatchItemHandlerHelper<T extends ComprehensiveProduct> extends Object

  • Constructor Details

    • ProductBatchItemHandlerHelper

      public ProductBatchItemHandlerHelper()

  • Method Details

    • determineVariantOperations

      public void determineVariantOperations(HandlerArgs<T,T> args)
      Determines the operations that need to be performed on the variants of a product. This method will set the following HandlerArgs.setProperty(String, Object) properties:
      • VARIANTS_TO_CREATE - A set of correlation IDs of variants to create
      • VARIANTS_TO_UPDATE - A set of correlation IDs of variants to update
      • VARIANTS_TO_DELETE - A set of variants to delete. These are not known in the batch, so must be added to the list of children to be processed in the ProductBatchItemHandler.
      Parameters:
      args - the handler args

    • determineTagsToDelete

      public List<ProductTag> determineTagsToDelete(List<ProductTag> existingTags, @Nullable List<ProductTag> tagsToSave, Map<String,AdvancedTag> advancedTagMap, String parentCorrelationId)

    • isSameTag

      public boolean isSameTag(ProductTag existingTag, ProductTag newTag, AdvancedTag existingTagsAdvancedTag)
      Returns true if the existing tag is the same as the new tag. This is determined by the tag ID or the advanced tag name if the tag ID is not present.
      Parameters:
      existingTag - the existing tag
      newTag - the new tag
      existingTagsAdvancedTag - the advanced tag for the existing tag
      Returns:
      true if the tags are the same, false otherwise

    • findAdvancedTagForProductTag

      @Nullable public AdvancedTag findAdvancedTagForProductTag(ProductTag tag, Map<String,AdvancedTag> advancedTagMap)
      Find the advanced tag for the given product tag. Null will be returned if the advanced tag is not found.
      Parameters:
      tag - the tag to find the advanced tag for
      advancedTagMap - the map of advanced tags
      Returns:
      the advanced tag for the given product tag, or null if not found.

    • isSameVariant

      protected boolean isSameVariant(Variant existing, Variant toSave)
      Returns true if the existing variant is the same as the new variant. This is determined by comparing their variant ID, then the SKU, then the external ID, then the UPC, in that order.
      Parameters:
      existing - the existing variant
      toSave - the new variant
      Returns:
      true if the variants are the same, false otherwise

    • getExistingVariants

      protected List<Variant> getExistingVariants(BatchContext<T> batchContext, T product)

    • needsVariantCalculation

      protected boolean needsVariantCalculation(HandlerArgs<T,T> args, T product, @Nullable List<Variant> variantsToSave, List<Variant> existingVariants)
      Determines if the variant create/update operations need to be calculated. This is essentially an early return for the easy cases:
      • There are no variants to handle
      • The product is newly created, and all variants should be created/it has no variants
      • There are no existing variants, so all variants should be created
      Parameters:
      args - the handler args
      product - the product received in the batch
      variantsToSave - the variants to save
      existingVariants - the existing variants
      Returns:
      true if the variant operations need to be calculated, false otherwise

    • mapToCorrelationId

      protected Set<String> mapToCorrelationId(Collection<? extends ExchangeObject> exchangeObjects)