Package com.commercetools.api.models.order

Interface OrderFromQuoteDraft

All Superinterfaces:
io.vrap.rmf.base.client.Draft<OrderFromQuoteDraft>
All Known Implementing Classes:
OrderFromQuoteDraftImpl
public interface OrderFromQuoteDraft extends io.vrap.rmf.base.client.Draft<OrderFromQuoteDraft>
OrderFromQuoteDraft
Example to create an instance using the builder pattern 

     OrderFromQuoteDraft orderFromQuoteDraft = OrderFromQuoteDraft.builder()
             .quote(quoteBuilder -> quoteBuilder)
             .version(0.3)
             .build()

  • Method Details

    • getQuote

      @NotNull @Valid @NotNull @Valid QuoteResourceIdentifier getQuote()

      ResourceIdentifier of the Quote from which this Order is created. If the Quote has QuoteState in Accepted, Declined or Withdrawn then the order creation will fail. The creation will also fail if the Quote has expired (validTo check).

      Returns:
      quote

    • getVersion

      @NotNull @NotNull Long getVersion()

      version of the Quote from which an Order is created.

      Returns:
      version

    • getQuoteStateToAccepted

      Boolean getQuoteStateToAccepted()

      If true, the quoteState of the referenced Quote will be set to Accepted.

      Returns:
      quoteStateToAccepted

    • getOrderNumber

      String getOrderNumber()

      String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed. For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression [a-z0-9_\-]{2,36}.

      Returns:
      orderNumber

    • getPaymentState

      PaymentState getPaymentState()

      Payment state of the Order.

      Returns:
      paymentState

    • getShipmentState

      ShipmentState getShipmentState()

      Shipment state of the Order.

      Returns:
      shipmentState

    • getOrderState

      OrderState getOrderState()

      Order will be created with Open status by default.

      Returns:
      orderState

    • getState

      @Valid @Valid StateResourceIdentifier getState()

      Reference to a State indicating the Order's state.

      Returns:
      state

    • setQuote

      void setQuote(QuoteResourceIdentifier quote)

      ResourceIdentifier of the Quote from which this Order is created. If the Quote has QuoteState in Accepted, Declined or Withdrawn then the order creation will fail. The creation will also fail if the Quote has expired (validTo check).

      Parameters:
      quote - value to be set

    • setVersion

      void setVersion(Long version)

      version of the Quote from which an Order is created.

      Parameters:
      version - value to be set

    • setQuoteStateToAccepted

      void setQuoteStateToAccepted(Boolean quoteStateToAccepted)

      If true, the quoteState of the referenced Quote will be set to Accepted.

      Parameters:
      quoteStateToAccepted - value to be set

    • setOrderNumber

      void setOrderNumber(String orderNumber)

      String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed. For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression [a-z0-9_\-]{2,36}.

      Parameters:
      orderNumber - value to be set

    • setPaymentState

      void setPaymentState(PaymentState paymentState)

      Payment state of the Order.

      Parameters:
      paymentState - value to be set

    • setShipmentState

      void setShipmentState(ShipmentState shipmentState)

      Shipment state of the Order.

      Parameters:
      shipmentState - value to be set

    • setOrderState

      void setOrderState(OrderState orderState)

      Order will be created with Open status by default.

      Parameters:
      orderState - value to be set

    • setState

      void setState(StateResourceIdentifier state)

      Reference to a State indicating the Order's state.

      Parameters:
      state - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderFromQuoteDraftBuilder builder()
      builder factory method for OrderFromQuoteDraft
      Returns:
      builder

    • builder

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

    • withOrderFromQuoteDraft

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