Package com.commercetools.api.models.message

Interface OrderStateChangedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin, OrderMessagePayload
public interface OrderStateChangedMessagePayload extends OrderMessagePayload

Generated after a successful Change OrderState update action.

Example to create an instance using the builder pattern 

     OrderStateChangedMessagePayload orderStateChangedMessagePayload = OrderStateChangedMessagePayload.builder()
             .orderState(OrderState.OPEN)
             .build()

  • Field Details

    • ORDER_STATE_CHANGED

      static final String ORDER_STATE_CHANGED
      discriminator value for OrderStateChangedMessagePayload
      See Also:

  • Method Details

    • getOrderState

      @NotNull @NotNull OrderState getOrderState()

      OrderState after the Change Order State update action.

      Returns:
      orderState

    • getOldOrderState

      OrderState getOldOrderState()

      OrderState before the Change Order State update action.

      Returns:
      oldOrderState

    • setOrderState

      void setOrderState(OrderState orderState)

      OrderState after the Change Order State update action.

      Parameters:
      orderState - value to be set

    • setOldOrderState

      void setOldOrderState(OrderState oldOrderState)

      OrderState before the Change Order State update action.

      Parameters:
      oldOrderState - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderStateChangedMessagePayloadBuilder builder()
      builder factory method for OrderStateChangedMessagePayload
      Returns:
      builder

    • builder

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

    • withOrderStateChangedMessagePayload

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