Package com.commercetools.api.models.staged_quote

Interface StagedQuote

All Superinterfaces:
BaseResource, WithKey
public interface StagedQuote extends BaseResource, WithKey
StagedQuote
Example to create an instance using the builder pattern 

     StagedQuote stagedQuote = StagedQuote.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .stagedQuoteState(StagedQuoteState.IN_PROGRESS)
             .quoteRequest(quoteRequestBuilder -> quoteRequestBuilder)
             .quotationCart(quotationCartBuilder -> quotationCartBuilder)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      The unique ID of the StagedQuote.

      Specified by:
      getId in interface BaseResource
      Returns:
      id

    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the StagedQuote.

      Specified by:
      getVersion in interface BaseResource
      Returns:
      version

    • getKey

      String getKey()

      User-specific unique identifier of the staged quote.

      Specified by:
      getKey in interface WithKey
      Returns:
      key

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the StagedQuote was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the StagedQuote was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the StagedQuote.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      IDs and references that created the StagedQuote.

      Returns:
      createdBy

    • getStagedQuoteState

      @NotNull @NotNull StagedQuoteState getStagedQuoteState()

      Predefined states tracking the status of the Staged Quote.

      Returns:
      stagedQuoteState

    • getCustomer

      @Valid @Valid CustomerReference getCustomer()

      The Buyer who requested the Quote.

      Returns:
      customer

    • getQuoteRequest

      @NotNull @Valid @NotNull @Valid QuoteRequestReference getQuoteRequest()

      Quote Request related to the Staged Quote.

      Returns:
      quoteRequest

    • getQuotationCart

      @NotNull @Valid @NotNull @Valid CartReference getQuotationCart()

      Cart containing the offered items. May contain either DirectDiscounts or CartDiscounts.

      Returns:
      quotationCart

    • getValidTo

      ZonedDateTime getValidTo()

      Expiration date for the Quote. Once a Quote expires, it cannot be ordered.

      Returns:
      validTo

    • getSellerComment

      String getSellerComment()

      Message from the Seller included in the offer.

      Returns:
      sellerComment

    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom Fields of the Staged Quote.

      Returns:
      custom

    • getState

      @Valid @Valid StateReference getState()

      State of the Staged Quote. This reference can point to a State in a custom workflow.

      Returns:
      state

    • getPurchaseOrderNumber

      String getPurchaseOrderNumber()

      The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.

      Returns:
      purchaseOrderNumber

    • getBusinessUnit

      @Valid @Valid BusinessUnitKeyReference getBusinessUnit()

      The BusinessUnit for the Staged Quote. Only available for B2B-enabled Projects.

      Returns:
      businessUnit

    • getStore

      @Valid @Valid StoreKeyReference getStore()

      The Store to which the Buyer belongs.

      Returns:
      store

    • setId

      void setId(String id)

      The unique ID of the StagedQuote.

      Specified by:
      setId in interface BaseResource
      Parameters:
      id - value to be set

    • setVersion

      void setVersion(Long version)

      Current version of the StagedQuote.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set

    • setKey

      void setKey(String key)

      User-specific unique identifier of the staged quote.

      Parameters:
      key - value to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the StagedQuote was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the StagedQuote was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set

    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      IDs and references that last modified the StagedQuote.

      Parameters:
      lastModifiedBy - value to be set

    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      IDs and references that created the StagedQuote.

      Parameters:
      createdBy - value to be set

    • setStagedQuoteState

      void setStagedQuoteState(StagedQuoteState stagedQuoteState)

      Predefined states tracking the status of the Staged Quote.

      Parameters:
      stagedQuoteState - value to be set

    • setCustomer

      void setCustomer(CustomerReference customer)

      The Buyer who requested the Quote.

      Parameters:
      customer - value to be set

    • setQuoteRequest

      void setQuoteRequest(QuoteRequestReference quoteRequest)

      Quote Request related to the Staged Quote.

      Parameters:
      quoteRequest - value to be set

    • setQuotationCart

      void setQuotationCart(CartReference quotationCart)

      Cart containing the offered items. May contain either DirectDiscounts or CartDiscounts.

      Parameters:
      quotationCart - value to be set

    • setValidTo

      void setValidTo(ZonedDateTime validTo)

      Expiration date for the Quote. Once a Quote expires, it cannot be ordered.

      Parameters:
      validTo - value to be set

    • setSellerComment

      void setSellerComment(String sellerComment)

      Message from the Seller included in the offer.

      Parameters:
      sellerComment - value to be set

    • setCustom

      void setCustom(CustomFields custom)

      Custom Fields of the Staged Quote.

      Parameters:
      custom - value to be set

    • setState

      void setState(StateReference state)

      State of the Staged Quote. This reference can point to a State in a custom workflow.

      Parameters:
      state - value to be set

    • setPurchaseOrderNumber

      void setPurchaseOrderNumber(String purchaseOrderNumber)

      The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.

      Parameters:
      purchaseOrderNumber - value to be set

    • setBusinessUnit

      void setBusinessUnit(BusinessUnitKeyReference businessUnit)

      The BusinessUnit for the Staged Quote. Only available for B2B-enabled Projects.

      Parameters:
      businessUnit - value to be set

    • setStore

      void setStore(StoreKeyReference store)

      The Store to which the Buyer belongs.

      Parameters:
      store - value to be set

    • of

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

    • of

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

    • copyDeep

      StagedQuote copyDeep()
      Specified by:
      copyDeep in interface BaseResource

    • deepCopy

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

    • builder

      static StagedQuoteBuilder builder()
      builder factory method for StagedQuote
      Returns:
      builder

    • builder

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

    • withStagedQuote

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