Package com.commercetools.api.models.message

Interface OrderStateTransitionMessagePayload

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

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern 

     OrderStateTransitionMessagePayload orderStateTransitionMessagePayload = OrderStateTransitionMessagePayload.builder()
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()

  • Field Details

    • ORDER_STATE_TRANSITION

      static final String ORDER_STATE_TRANSITION
      discriminator value for OrderStateTransitionMessagePayload
      See Also:

  • Method Details

    • getState

      @NotNull @Valid @NotNull @Valid StateReference getState()

      OrderState after the Transition State update action.

      Returns:
      state

    • getOldState

      @Valid @Valid StateReference getOldState()

      OrderState before the Transition State update action.

      Returns:
      oldState

    • getForce

      @NotNull @NotNull Boolean getForce()

      Whether State transition validations were turned off during the Transition State update action.

      Returns:
      force

    • setState

      void setState(StateReference state)

      OrderState after the Transition State update action.

      Parameters:
      state - value to be set

    • setOldState

      void setOldState(StateReference oldState)

      OrderState before the Transition State update action.

      Parameters:
      oldState - value to be set

    • setForce

      void setForce(Boolean force)

      Whether State transition validations were turned off during the Transition State update action.

      Parameters:
      force - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderStateTransitionMessagePayloadBuilder builder()
      builder factory method for OrderStateTransitionMessagePayload
      Returns:
      builder

    • builder

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

    • withOrderStateTransitionMessagePayload

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