Package com.commercetools.api.models.quote

Interface QuoteTransitionStateAction

All Superinterfaces:
QuoteUpdateAction, ResourceUpdateAction<QuoteUpdateAction>
public interface QuoteTransitionStateAction extends QuoteUpdateAction

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 Quote State Transition Message.

Example to create an instance using the builder pattern 

     QuoteTransitionStateAction quoteTransitionStateAction = QuoteTransitionStateAction.builder()
             .state(stateBuilder -> stateBuilder)
             .build()

  • Field Details

    • TRANSITION_STATE

      static final String TRANSITION_STATE
      discriminator value for QuoteTransitionStateAction
      See Also:

  • Method Details

    • getState

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

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

      Returns:
      state

    • getForce

      Boolean getForce()

      Switch validations on or off.

      Returns:
      force

    • setState

      void setState(StateResourceIdentifier state)

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

      Parameters:
      state - value to be set

    • setForce

      void setForce(Boolean force)

      Switch validations on or off.

      Parameters:
      force - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static QuoteTransitionStateActionBuilder builder()
      builder factory method for QuoteTransitionStateAction
      Returns:
      builder

    • builder

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

    • withQuoteTransitionStateAction

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