Package com.commercetools.api.models.order

Interface OrderTransitionStateAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderTransitionStateAction extends OrderUpdateAction

If the existing State has set transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed.

This update action produces the Order State Transition Message.

Example to create an instance using the builder pattern 

     OrderTransitionStateAction orderTransitionStateAction = OrderTransitionStateAction.builder()
             .state(stateBuilder -> stateBuilder)
             .build()

  • Field Details

    • TRANSITION_STATE

      static final String TRANSITION_STATE
      discriminator value for OrderTransitionStateAction
      See Also:

  • Method Details

    • getState

      @NotNull @Valid @NotNull @Valid StateResourceIdentifier getState()

      Value to set. If there is no State yet, the new State must be an initial State.

      Returns:
      state

    • getForce

      Boolean getForce()

      Set to true to turn off validation.

      Returns:
      force

    • setState

      void setState(StateResourceIdentifier state)

      Value to set. If there is no State yet, the new State must be an initial State.

      Parameters:
      state - value to be set

    • setForce

      void setForce(Boolean force)

      Set to true to turn off validation.

      Parameters:
      force - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderTransitionStateAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderTransitionStateActionBuilder builder()
      builder factory method for OrderTransitionStateAction
      Returns:
      builder

    • builder

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

    • withOrderTransitionStateAction

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