Package com.commercetools.sync.products.helpers

Class AssetCustomActionBuilder

  • All Implemented Interfaces:
    GenericCustomActionBuilder<com.commercetools.api.models.product.ProductUpdateAction>
    public class AssetCustomActionBuilder
extends java.lang.Object
implements GenericCustomActionBuilder<com.commercetools.api.models.product.ProductUpdateAction>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.commercetools.api.models.product.ProductUpdateAction buildRemoveCustomTypeAction​(java.lang.Long variantId, java.lang.String assetKey)
      Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T.
      com.commercetools.api.models.product.ProductUpdateAction buildSetCustomFieldAction​(java.lang.Long variantId, java.lang.String assetKey, java.lang.String customFieldName, java.lang.Object customFieldValue)
      Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T.
      com.commercetools.api.models.product.ProductUpdateAction buildSetCustomTypeAction​(java.lang.Long variantId, java.lang.String assetKey, java.lang.String customTypeId, java.util.Map<java.lang.String,​java.lang.Object> customFieldsJsonMap)
      Creates a CTP "setCustomType" update action on the given resource T.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AssetCustomActionBuilder

        public AssetCustomActionBuilder()

    • Method Detail

      • buildRemoveCustomTypeAction

        @Nonnull
public com.commercetools.api.models.product.ProductUpdateAction buildRemoveCustomTypeAction​(@Nullable
                                                                                            java.lang.Long variantId,
                                                                                            @Nullable
                                                                                            java.lang.String assetKey)
        Description copied from interface: GenericCustomActionBuilder
        Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T. If the resource that has the custom fields is a secondary resource (e.g. price or asset) and not a primary resource (e.g Category, Product, Channel, etc..), the variantId and the objectId will be used to identify this secondary resource within its container.
        Specified by:
        buildRemoveCustomTypeAction in interface GenericCustomActionBuilder<com.commercetools.api.models.product.ProductUpdateAction>
        Parameters:
        variantId - an optional field which could be used to identify the variant that holds the a resource (e.g. asset) which has the custom fields.
        assetKey - an optional field which could be used to identify the id of the resource (e.g. asset, price, etc..) which has the custom fields.
        Returns:
        a setCustomType update action that removes the custom type from the resource it's requested on.

      • buildSetCustomTypeAction

        @Nonnull
public com.commercetools.api.models.product.ProductUpdateAction buildSetCustomTypeAction​(@Nullable
                                                                                         java.lang.Long variantId,
                                                                                         @Nullable
                                                                                         java.lang.String assetKey,
                                                                                         @Nonnull
                                                                                         java.lang.String customTypeId,
                                                                                         @Nullable
                                                                                         java.util.Map<java.lang.String,​java.lang.Object> customFieldsJsonMap)
        Description copied from interface: GenericCustomActionBuilder
        Creates a CTP "setCustomType" update action on the given resource T. If the resource that has the custom fields is a secondary resource (e.g. Price or asset) and not a primary resource (e.g Category, Product, Channel, etc..), the variantId and the objectId will be used to identify this secondary resource within its container.
        Specified by:
        buildSetCustomTypeAction in interface GenericCustomActionBuilder<com.commercetools.api.models.product.ProductUpdateAction>
        Parameters:
        variantId - an optional field which could be used to identify the variant that holds the a resource (e.g. asset) which has the custom fields.
        assetKey - an optional field which could be used to identify the id of the resource (e.g. asset, price, etc..) which has the custom fields.
        customTypeId - the id of the new custom type.
        customFieldsJsonMap - the custom fields map of JSON values.
        Returns:
        a setCustomType update action of the type of the resource it's requested on.

      • buildSetCustomFieldAction

        @Nonnull
public com.commercetools.api.models.product.ProductUpdateAction buildSetCustomFieldAction​(@Nullable
                                                                                          java.lang.Long variantId,
                                                                                          @Nullable
                                                                                          java.lang.String assetKey,
                                                                                          @Nullable
                                                                                          java.lang.String customFieldName,
                                                                                          @Nullable
                                                                                          java.lang.Object customFieldValue)
        Description copied from interface: GenericCustomActionBuilder
        Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T. If the resource that has the custom fields is a secondary resource (e.g. Price or asset) and not a primary resource (e.g Category, Product, Channel, etc..), the variantId and the objectId will be used to identify this secondary resource within its container.
        Specified by:
        buildSetCustomFieldAction in interface GenericCustomActionBuilder<com.commercetools.api.models.product.ProductUpdateAction>
        Parameters:
        variantId - an optional field which could be used to identify the variant that holds the a resource (e.g. asset) which has the custom fields.
        assetKey - an optional field which could be used to identify the id of the resource (e.g. asset, price, etc..) which has the custom fields.
        customFieldName - the name of the custom field to update.
        customFieldValue - the new JSON value of the custom field.
        Returns:
        a setCustomField update action on the provided field name, with the provided value on the resource it's requested on.