Package com.commercetools.api.models.message

Interface InventoryEntryQuantitySetMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
All Known Implementing Classes:
InventoryEntryQuantitySetMessagePayloadImpl
public interface InventoryEntryQuantitySetMessagePayload extends MessagePayload

Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action. Inventory changes as a result of Order creation do not trigger this message.

Example to create an instance using the builder pattern 

     InventoryEntryQuantitySetMessagePayload inventoryEntryQuantitySetMessagePayload = InventoryEntryQuantitySetMessagePayload.builder()
             .oldQuantityOnStock(0.3)
             .newQuantityOnStock(0.3)
             .oldAvailableQuantity(0.3)
             .newAvailableQuantity(0.3)
             .build()

  • Field Details

    • INVENTORY_ENTRY_QUANTITY_SET

      static final String INVENTORY_ENTRY_QUANTITY_SET
      discriminator value for InventoryEntryQuantitySetMessagePayload
      See Also:

  • Method Details

    • getOldQuantityOnStock

      @NotNull @NotNull Long getOldQuantityOnStock()

      Quantity on stock for the InventoryEntry before the quantity was updated.

      Returns:
      oldQuantityOnStock

    • getNewQuantityOnStock

      @NotNull @NotNull Long getNewQuantityOnStock()

      Quantity on stock for the InventoryEntry after the quantity was updated.

      Returns:
      newQuantityOnStock

    • getOldAvailableQuantity

      @NotNull @NotNull Long getOldAvailableQuantity()

      Available quantity for the InventoryEntry before the quantity was updated.

      Returns:
      oldAvailableQuantity

    • getNewAvailableQuantity

      @NotNull @NotNull Long getNewAvailableQuantity()

      Available quantity for the InventoryEntry after the quantity was updated.

      Returns:
      newAvailableQuantity

    • getSupplyChannel

      @Valid @Valid ChannelReference getSupplyChannel()

      Reference to the Channel where the InventoryEntry quantity was set.

      Returns:
      supplyChannel

    • setOldQuantityOnStock

      void setOldQuantityOnStock(Long oldQuantityOnStock)

      Quantity on stock for the InventoryEntry before the quantity was updated.

      Parameters:
      oldQuantityOnStock - value to be set

    • setNewQuantityOnStock

      void setNewQuantityOnStock(Long newQuantityOnStock)

      Quantity on stock for the InventoryEntry after the quantity was updated.

      Parameters:
      newQuantityOnStock - value to be set

    • setOldAvailableQuantity

      void setOldAvailableQuantity(Long oldAvailableQuantity)

      Available quantity for the InventoryEntry before the quantity was updated.

      Parameters:
      oldAvailableQuantity - value to be set

    • setNewAvailableQuantity

      void setNewAvailableQuantity(Long newAvailableQuantity)

      Available quantity for the InventoryEntry after the quantity was updated.

      Parameters:
      newAvailableQuantity - value to be set

    • setSupplyChannel

      void setSupplyChannel(ChannelReference supplyChannel)

      Reference to the Channel where the InventoryEntry quantity was set.

      Parameters:
      supplyChannel - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static InventoryEntryQuantitySetMessagePayloadBuilder builder()
      builder factory method for InventoryEntryQuantitySetMessagePayload
      Returns:
      builder

    • builder

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

    • withInventoryEntryQuantitySetMessagePayload

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