Package com.commercetools.history.models.change

Interface SetPricesChange

All Superinterfaces:
Change
public interface SetPricesChange extends Change

Change triggered by the Set Prices update action.

Example to create an instance using the builder pattern 

     SetPricesChange setPricesChange = SetPricesChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .catalogData("{catalogData}")
             .variant("{variant}")
             .plusAddedItems(addedItemsBuilder -> addedItemsBuilder)
             .plusRemovedItems(removedItemsBuilder -> removedItemsBuilder)
             .build()

  • Field Details

  • 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 List<Price> getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid List<Price> 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

    • getAddedItems

      @NotNull @Valid @NotNull @Valid List<Price> getAddedItems()

      Elements added to the array.

      Returns:
      addedItems

    • getRemovedItems

      @NotNull @Valid @NotNull @Valid List<Price> getRemovedItems()

      Elements removed from the array.

      Returns:
      removedItems

    • setChange

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

    • setPreviousValue

      void setPreviousValue(Price... previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setPreviousValue

      void setPreviousValue(List<Price> previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setNextValue

      void setNextValue(Price... nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setNextValue

      void setNextValue(List<Price> nextValue)

      Value after the change.

      Parameters:
      nextValue - values 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

    • setAddedItems

      void setAddedItems(Price... addedItems)

      Elements added to the array.

      Parameters:
      addedItems - values to be set

    • setAddedItems

      void setAddedItems(List<Price> addedItems)

      Elements added to the array.

      Parameters:
      addedItems - values to be set

    • setRemovedItems

      void setRemovedItems(Price... removedItems)

      Elements removed from the array.

      Parameters:
      removedItems - values to be set

    • setRemovedItems

      void setRemovedItems(List<Price> removedItems)

      Elements removed from the array.

      Parameters:
      removedItems - values to be set

    • of

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

    • of

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

    • copyDeep

      SetPricesChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static SetPricesChangeBuilder builder()
      builder factory method for SetPricesChange
      Returns:
      builder

    • builder

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

    • withSetPricesChange

      default <T> T withSetPricesChange(Function<SetPricesChange,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<SetPricesChange> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference