Package com.commercetools.sync.products.helpers

Class ProductBatchValidator

java.lang.Object

com.commercetools.sync.commons.helpers.BaseBatchValidator<com.commercetools.api.models.product.ProductDraft,ProductSyncOptions,ProductSyncStatistics>

com.commercetools.sync.products.helpers.ProductBatchValidator

public class ProductBatchValidator
extends BaseBatchValidator<com.commercetools.api.models.product.ProductDraft,ProductSyncOptions,ProductSyncStatistics>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProductBatchValidator.ReferencedKeys

Constructor Summary

Constructors

Constructor	Description
ProductBatchValidator(ProductSyncOptions syncOptions, ProductSyncStatistics syncStatistics)

Method Summary

Modifier and Type	Method	Description
static java.util.Set<java.lang.String>	getReferencedProductKeys(com.commercetools.api.models.product.ProductVariantDraft variantDraft)	Get a set of referenced product keys on all attribute drafts on the supplied Product Variant Draft.
org.apache.commons.lang3.tuple.ImmutablePair<java.util.Set<com.commercetools.api.models.product.ProductDraft>,ProductBatchValidator.ReferencedKeys>	validateAndCollectReferencedKeys(java.util.List<com.commercetools.api.models.product.ProductDraft> productDrafts)	Given the List<ProductDraft> of drafts this method attempts to validate drafts and collect referenced keys from the draft and return an ImmutablePair<Set< ProductDraft>,ProductBatchValidator.ReferencedKeys> which contains the Set of valid drafts and referenced keys within a wrapper.

Methods inherited from class com.commercetools.sync.commons.helpers.BaseBatchValidator

collectReferencedKeyFromCustomFieldsDraft, collectReferencedKeyFromResourceIdentifier, collectReferencedKeysFromAssetDrafts, handleError, handleError

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductBatchValidator

public ProductBatchValidator(@Nonnull
                             ProductSyncOptions syncOptions,
                             @Nonnull
                             ProductSyncStatistics syncStatistics)

Method Detail

validateAndCollectReferencedKeys

public org.apache.commons.lang3.tuple.ImmutablePair<java.util.Set<com.commercetools.api.models.product.ProductDraft>,ProductBatchValidator.ReferencedKeys> validateAndCollectReferencedKeys(@Nonnull
                                                                                                                                                                                                  java.util.List<com.commercetools.api.models.product.ProductDraft> productDrafts)

Given the List<ProductDraft> of drafts this method attempts to validate drafts and collect referenced keys from the draft and return an ImmutablePair<Set< ProductDraft>,ProductBatchValidator.ReferencedKeys> which contains the Set of valid drafts and referenced keys within a wrapper.

A valid product draft is one which satisfies the following conditions:

1. It is not null
2. It has a key which is not blank (null/empty)
3. It has all variants AND master variant valid
4. A variant is valid if it satisfies the following conditions:
   1. It has a key which is not blank (null/empty)
   2. It has a SKU which is not blank (null/empty)

Specified by:

validateAndCollectReferencedKeys in class BaseBatchValidator<com.commercetools.api.models.product.ProductDraft,ProductSyncOptions,ProductSyncStatistics>

Parameters:

productDrafts - the product drafts to validate and collect referenced keys.

Returns:

ImmutablePair<Set<ProductDraft>, ProductBatchValidator.ReferencedKeys> which contains the Set of valid drafts and referenced keys within a wrapper.

getReferencedProductKeys

@Nonnull
public static java.util.Set<java.lang.String> getReferencedProductKeys(@Nonnull
                                                                       com.commercetools.api.models.product.ProductVariantDraft variantDraft)

Get a set of referenced product keys on all attribute drafts on the supplied Product Variant Draft.

Note: Null attributes are skipped since they are validated at a later stage in (ProductVariantUpdateActionUtils)

Parameters:

variantDraft - the variant draft to get the referenced product keys from.

Returns:

the set of referenced product keys.