Package com.commercetools.history.models.change

Interface SetVariantAvailabilityChange

All Superinterfaces:
Change
public interface SetVariantAvailabilityChange extends Change

This change is initiated by background processes after the Add Quantity, Remove Quantity, or Change Quantity update action is performed.

Example to create an instance using the builder pattern 

     SetVariantAvailabilityChange setVariantAvailabilityChange = SetVariantAvailabilityChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .catalogData("{catalogData}")
             .variant("{variant}")
             .build()

  • Field Details

    • SET_VARIANT_AVAILABILITY_CHANGE

      static final String SET_VARIANT_AVAILABILITY_CHANGE
      discriminator value for SetVariantAvailabilityChange
      See Also:

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Description copied from interface: Change

      Unique discriminator value to reliably deserialize the data type.

      Specified by:
      getType in interface Change
      Returns:
      type

    • getChange

      @NotNull @NotNull String getChange()
      Description copied from interface: Change

      Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

      Records can be filtered by this value using the changes query parameter.

      Specified by:
      getChange in interface Change
      Returns:
      change

    • getPreviousValue

      @NotNull @Valid @NotNull @Valid ProductVariantAvailability getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid ProductVariantAvailability getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getCatalogData

      @NotNull @NotNull String getCatalogData()

      Product data that was updated.

      Returns:
      catalogData

    • getVariant

      @NotNull @NotNull String getVariant()

      Identifier of the updated Product Variant.

      This field holds the SKU, if defined; otherwise the key; otherwise the ID.

      Returns:
      variant

    • setChange

      void setChange(String change)
      set change
      Specified by:
      setChange in interface Change
      Parameters:
      change - value to be set

    • setPreviousValue

      void setPreviousValue(ProductVariantAvailability previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(ProductVariantAvailability nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setCatalogData

      void setCatalogData(String catalogData)

      Product data that was updated.

      Parameters:
      catalogData - value to be set

    • setVariant

      void setVariant(String variant)

      Identifier of the updated Product Variant.

      This field holds the SKU, if defined; otherwise the key; otherwise the ID.

      Parameters:
      variant - value to be set

    • of

      static SetVariantAvailabilityChange of()
      factory method
      Returns:
      instance of SetVariantAvailabilityChange

    • of

      static SetVariantAvailabilityChange of(SetVariantAvailabilityChange template)
      factory method to create a shallow copy SetVariantAvailabilityChange
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      SetVariantAvailabilityChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

      @Nullable static SetVariantAvailabilityChange deepCopy(@Nullable SetVariantAvailabilityChange template)
      factory method to create a deep copy of SetVariantAvailabilityChange
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static SetVariantAvailabilityChangeBuilder builder()
      builder factory method for SetVariantAvailabilityChange
      Returns:
      builder

    • builder

      static SetVariantAvailabilityChangeBuilder builder(SetVariantAvailabilityChange template)
      create builder for SetVariantAvailabilityChange instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withSetVariantAvailabilityChange

      default <T> T withSetVariantAvailabilityChange(Function<SetVariantAvailabilityChange,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<SetVariantAvailabilityChange> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference