Class QuoteImpl
- All Implemented Interfaces:
BaseResource
,Customizable<Quote>
,DomainResource<Quote>
,Identifiable<Quote>
,Quote
,QuoteMixin
,Referencable<Quote>
,ResourceIdentifiable<Quote>
,Versioned<Quote>
,WithKey
,io.vrap.rmf.base.client.ModelBase
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Address used for invoicing.The BusinessUnit for the Quote.Message from the Buyer included in the renegotiation request.Used for Product Variant price selection.Date and time (UTC) the Quote was initially created.Present on resources created after 1 February 2019 except for events not tracked.Custom Fields on the Quote.The Buyer who owns the Quote.Set automatically whencustomer
is set and the Customer is a member of a Customer Group.The Custom Line Items for which the Quote is requested.Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.getId()
Unique identifier of the Quote.Inventory mode of the Cart referenced in the QuoteRequestDraft.Contains addresses for carts with multiple shipping addresses.getKey()
User-defined unique identifier of the Quote.Date and time (UTC) the Quote was last updated.Present on resources created after 1 February 2019 except for events not tracked.The Line Items for which the Quote is requested.Log of payment transactions related to the Quote.The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.Quote Request related to the Quote.Predefined states tracking the status of the Quote.Message from the Seller included in the offer.Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.Set automatically once the ShippingMethod is set.Used to select a ShippingRatePriceTier.Staged Quote related to the Quote.getState()
State of the Quote.getStore()
The Store to which the Buyer belongs.When calculating taxes fortaxedPrice
, the selected mode is used for calculating the price withLineItemLevel
(horizontally) orUnitPriceLevel
(vertically) calculation mode.Not set until the shipping address is set.Tax mode of the Cart referenced in the QuoteRequestDraft.When calculating taxes fortaxedPrice
, the selected mode is used for rounding.Sum of alltotalPrice
fields of thelineItems
andcustomLineItems
, as well as theprice
field ofshippingInfo
(if it exists).Expiration date for the Quote.Current version of the Quote.int
hashCode()
void
setBillingAddress
(Address billingAddress) Address used for invoicing.void
setBusinessUnit
(BusinessUnitKeyReference businessUnit) The BusinessUnit for the Quote.void
setBuyerComment
(String buyerComment) Message from the Buyer included in the renegotiation request.void
setCountry
(String country) Used for Product Variant price selection.void
setCreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Quote was initially created.void
setCreatedBy
(CreatedBy createdBy) Present on resources created after 1 February 2019 except for events not tracked.void
setCustom
(CustomFields custom) Custom Fields on the Quote.void
setCustomer
(CustomerReference customer) The Buyer who owns the Quote.void
setCustomerGroup
(CustomerGroupReference customerGroup) Set automatically whencustomer
is set and the Customer is a member of a Customer Group.void
setCustomLineItems
(CustomLineItem... customLineItems) The Custom Line Items for which the Quote is requested.void
setCustomLineItems
(List<CustomLineItem> customLineItems) The Custom Line Items for which the Quote is requested.void
setDirectDiscounts
(DirectDiscount... directDiscounts) Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.void
setDirectDiscounts
(List<DirectDiscount> directDiscounts) Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.void
Unique identifier of the Quote.void
setInventoryMode
(InventoryMode inventoryMode) Inventory mode of the Cart referenced in the QuoteRequestDraft.void
setItemShippingAddresses
(Address... itemShippingAddresses) Contains addresses for carts with multiple shipping addresses.void
setItemShippingAddresses
(List<Address> itemShippingAddresses) Contains addresses for carts with multiple shipping addresses.void
User-defined unique identifier of the Quote.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the Quote was last updated.void
setLastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.void
setLineItems
(LineItem... lineItems) The Line Items for which the Quote is requested.void
setLineItems
(List<LineItem> lineItems) The Line Items for which the Quote is requested.void
setPaymentInfo
(PaymentInfo paymentInfo) Log of payment transactions related to the Quote.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.void
setQuoteRequest
(QuoteRequestReference quoteRequest) Quote Request related to the Quote.void
setQuoteState
(QuoteState quoteState) Predefined states tracking the status of the Quote.void
setSellerComment
(String sellerComment) Message from the Seller included in the offer.void
setShippingAddress
(Address shippingAddress) Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.void
setShippingInfo
(ShippingInfo shippingInfo) Set automatically once the ShippingMethod is set.void
setShippingRateInput
(ShippingRateInput shippingRateInput) Used to select a ShippingRatePriceTier.void
setStagedQuote
(StagedQuoteReference stagedQuote) Staged Quote related to the Quote.void
setState
(StateReference state) State of the Quote.void
setStore
(StoreKeyReference store) The Store to which the Buyer belongs.void
setTaxCalculationMode
(TaxCalculationMode taxCalculationMode) When calculating taxes fortaxedPrice
, the selected mode is used for calculating the price withLineItemLevel
(horizontally) orUnitPriceLevel
(vertically) calculation mode.void
setTaxedPrice
(TaxedPrice taxedPrice) Not set until the shipping address is set.void
setTaxMode
(TaxMode taxMode) Tax mode of the Cart referenced in the QuoteRequestDraft.void
setTaxRoundingMode
(RoundingMode taxRoundingMode) When calculating taxes fortaxedPrice
, the selected mode is used for rounding.void
setTotalPrice
(TypedMoney totalPrice) Sum of alltotalPrice
fields of thelineItems
andcustomLineItems
, as well as theprice
field ofshippingInfo
(if it exists).void
setValidTo
(ZonedDateTime validTo) Expiration date for the Quote.void
setVersion
(Long version) Current version of the Quote.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.common.BaseResource
withBaseResource
Methods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.DomainResource
get
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.quote.QuoteMixin
toReference, toResourceIdentifier
-
Constructor Details
-
QuoteImpl
public QuoteImpl()create empty instance
-
-
Method Details
-
getId
Unique identifier of the Quote.
- Specified by:
getId
in interfaceBaseResource
- Specified by:
getId
in interfaceDomainResource<Quote>
- Specified by:
getId
in interfaceIdentifiable<Quote>
- Specified by:
getId
in interfaceQuote
- Specified by:
getId
in interfaceVersioned<Quote>
- Returns:
- id
-
getVersion
Current version of the Quote.
- Specified by:
getVersion
in interfaceBaseResource
- Specified by:
getVersion
in interfaceDomainResource<Quote>
- Specified by:
getVersion
in interfaceQuote
- Specified by:
getVersion
in interfaceVersioned<Quote>
- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Quote was initially created.
- Specified by:
getCreatedAt
in interfaceBaseResource
- Specified by:
getCreatedAt
in interfaceQuote
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the Quote was last updated.
- Specified by:
getLastModifiedAt
in interfaceBaseResource
- Specified by:
getLastModifiedAt
in interfaceQuote
- Returns:
- lastModifiedAt
-
getKey
User-defined unique identifier of the Quote.
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getLastModifiedBy
in interfaceQuote
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getCreatedBy
in interfaceQuote
- Returns:
- createdBy
-
getQuoteRequest
Quote Request related to the Quote.
- Specified by:
getQuoteRequest
in interfaceQuote
- Returns:
- quoteRequest
-
getStagedQuote
Staged Quote related to the Quote.
- Specified by:
getStagedQuote
in interfaceQuote
- Returns:
- stagedQuote
-
getCustomer
The Buyer who owns the Quote.
- Specified by:
getCustomer
in interfaceQuote
- Returns:
- customer
-
getCustomerGroup
Set automatically when
customer
is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote creation. Used for Product Variant price selection.- Specified by:
getCustomerGroup
in interfaceQuote
- Returns:
- customerGroup
-
getValidTo
Expiration date for the Quote.
- Specified by:
getValidTo
in interfaceQuote
- Returns:
- validTo
-
getSellerComment
Message from the Seller included in the offer.
- Specified by:
getSellerComment
in interfaceQuote
- Returns:
- sellerComment
-
getBuyerComment
Message from the Buyer included in the renegotiation request.
- Specified by:
getBuyerComment
in interfaceQuote
- Returns:
- buyerComment
-
getStore
The Store to which the Buyer belongs.
-
getLineItems
The Line Items for which the Quote is requested.
- Specified by:
getLineItems
in interfaceQuote
- Returns:
- lineItems
-
getCustomLineItems
The Custom Line Items for which the Quote is requested.
- Specified by:
getCustomLineItems
in interfaceQuote
- Returns:
- customLineItems
-
getTotalPrice
Sum of all
totalPrice
fields of thelineItems
andcustomLineItems
, as well as theprice
field ofshippingInfo
(if it exists).totalPrice
may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.- Specified by:
getTotalPrice
in interfaceQuote
- Returns:
- totalPrice
-
getTaxedPrice
Not set until the shipping address is set. Will be set automatically in the
Platform
TaxMode. For theExternal
tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.- Specified by:
getTaxedPrice
in interfaceQuote
- Returns:
- taxedPrice
-
getShippingAddress
Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.
- Specified by:
getShippingAddress
in interfaceQuote
- Returns:
- shippingAddress
-
getBillingAddress
Address used for invoicing.
- Specified by:
getBillingAddress
in interfaceQuote
- Returns:
- billingAddress
-
getInventoryMode
Inventory mode of the Cart referenced in the QuoteRequestDraft.
- Specified by:
getInventoryMode
in interfaceQuote
- Returns:
- inventoryMode
-
getTaxMode
Tax mode of the Cart referenced in the QuoteRequestDraft.
- Specified by:
getTaxMode
in interfaceQuote
- Returns:
- taxMode
-
getTaxRoundingMode
When calculating taxes for
taxedPrice
, the selected mode is used for rounding.- Specified by:
getTaxRoundingMode
in interfaceQuote
- Returns:
- taxRoundingMode
-
getTaxCalculationMode
When calculating taxes for
taxedPrice
, the selected mode is used for calculating the price withLineItemLevel
(horizontally) orUnitPriceLevel
(vertically) calculation mode.- Specified by:
getTaxCalculationMode
in interfaceQuote
- Returns:
- taxCalculationMode
-
getCountry
Used for Product Variant price selection.
- Specified by:
getCountry
in interfaceQuote
- Returns:
- country
-
getShippingInfo
Set automatically once the ShippingMethod is set.
- Specified by:
getShippingInfo
in interfaceQuote
- Returns:
- shippingInfo
-
getPaymentInfo
Log of payment transactions related to the Quote.
- Specified by:
getPaymentInfo
in interfaceQuote
- Returns:
- paymentInfo
-
getShippingRateInput
Used to select a ShippingRatePriceTier.
- Specified by:
getShippingRateInput
in interfaceQuote
- Returns:
- shippingRateInput
-
getItemShippingAddresses
Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their
shippingDetails
. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart'sshippingAddress
is used for this.- Specified by:
getItemShippingAddresses
in interfaceQuote
- Returns:
- itemShippingAddresses
-
getDirectDiscounts
Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
- Specified by:
getDirectDiscounts
in interfaceQuote
- Returns:
- directDiscounts
-
getCustom
Custom Fields on the Quote.
- Specified by:
getCustom
in interfaceCustomizable<Quote>
- Specified by:
getCustom
in interfaceQuote
- Returns:
- custom
-
getQuoteState
Predefined states tracking the status of the Quote.
- Specified by:
getQuoteState
in interfaceQuote
- Returns:
- quoteState
-
getState
State of the Quote. This reference can point to a State in a custom workflow.
-
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.
- Specified by:
getPurchaseOrderNumber
in interfaceQuote
- Returns:
- purchaseOrderNumber
-
getBusinessUnit
The BusinessUnit for the Quote.
- Specified by:
getBusinessUnit
in interfaceQuote
- Returns:
- businessUnit
-
setId
Description copied from interface:Quote
Unique identifier of the Quote.
- Specified by:
setId
in interfaceBaseResource
- Specified by:
setId
in interfaceQuote
- Parameters:
id
- value to be set
-
setVersion
Description copied from interface:Quote
Current version of the Quote.
- Specified by:
setVersion
in interfaceBaseResource
- Specified by:
setVersion
in interfaceQuote
- Parameters:
version
- value to be set
-
setCreatedAt
Description copied from interface:Quote
Date and time (UTC) the Quote was initially created.
- Specified by:
setCreatedAt
in interfaceBaseResource
- Specified by:
setCreatedAt
in interfaceQuote
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
Description copied from interface:Quote
Date and time (UTC) the Quote was last updated.
- Specified by:
setLastModifiedAt
in interfaceBaseResource
- Specified by:
setLastModifiedAt
in interfaceQuote
- Parameters:
lastModifiedAt
- value to be set
-
setKey
Description copied from interface:Quote
User-defined unique identifier of the Quote.
-
setLastModifiedBy
Description copied from interface:Quote
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setLastModifiedBy
in interfaceQuote
- Parameters:
lastModifiedBy
- value to be set
-
setCreatedBy
Description copied from interface:Quote
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setCreatedBy
in interfaceQuote
- Parameters:
createdBy
- value to be set
-
setQuoteRequest
Description copied from interface:Quote
Quote Request related to the Quote.
- Specified by:
setQuoteRequest
in interfaceQuote
- Parameters:
quoteRequest
- value to be set
-
setStagedQuote
Description copied from interface:Quote
Staged Quote related to the Quote.
- Specified by:
setStagedQuote
in interfaceQuote
- Parameters:
stagedQuote
- value to be set
-
setCustomer
Description copied from interface:Quote
The Buyer who owns the Quote.
- Specified by:
setCustomer
in interfaceQuote
- Parameters:
customer
- value to be set
-
setCustomerGroup
Description copied from interface:Quote
Set automatically when
customer
is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote creation. Used for Product Variant price selection.- Specified by:
setCustomerGroup
in interfaceQuote
- Parameters:
customerGroup
- value to be set
-
setValidTo
Description copied from interface:Quote
Expiration date for the Quote.
- Specified by:
setValidTo
in interfaceQuote
- Parameters:
validTo
- value to be set
-
setSellerComment
Description copied from interface:Quote
Message from the Seller included in the offer.
- Specified by:
setSellerComment
in interfaceQuote
- Parameters:
sellerComment
- value to be set
-
setBuyerComment
Description copied from interface:Quote
Message from the Buyer included in the renegotiation request.
- Specified by:
setBuyerComment
in interfaceQuote
- Parameters:
buyerComment
- value to be set
-
setStore
Description copied from interface:Quote
The Store to which the Buyer belongs.
-
setLineItems
Description copied from interface:Quote
The Line Items for which the Quote is requested.
- Specified by:
setLineItems
in interfaceQuote
- Parameters:
lineItems
- values to be set
-
setLineItems
Description copied from interface:Quote
The Line Items for which the Quote is requested.
- Specified by:
setLineItems
in interfaceQuote
- Parameters:
lineItems
- values to be set
-
setCustomLineItems
Description copied from interface:Quote
The Custom Line Items for which the Quote is requested.
- Specified by:
setCustomLineItems
in interfaceQuote
- Parameters:
customLineItems
- values to be set
-
setCustomLineItems
Description copied from interface:Quote
The Custom Line Items for which the Quote is requested.
- Specified by:
setCustomLineItems
in interfaceQuote
- Parameters:
customLineItems
- values to be set
-
setTotalPrice
Description copied from interface:Quote
Sum of all
totalPrice
fields of thelineItems
andcustomLineItems
, as well as theprice
field ofshippingInfo
(if it exists).totalPrice
may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.- Specified by:
setTotalPrice
in interfaceQuote
- Parameters:
totalPrice
- value to be set
-
setTaxedPrice
Description copied from interface:Quote
Not set until the shipping address is set. Will be set automatically in the
Platform
TaxMode. For theExternal
tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.- Specified by:
setTaxedPrice
in interfaceQuote
- Parameters:
taxedPrice
- value to be set
-
setShippingAddress
Description copied from interface:Quote
Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.
- Specified by:
setShippingAddress
in interfaceQuote
- Parameters:
shippingAddress
- value to be set
-
setBillingAddress
Description copied from interface:Quote
Address used for invoicing.
- Specified by:
setBillingAddress
in interfaceQuote
- Parameters:
billingAddress
- value to be set
-
setInventoryMode
Description copied from interface:Quote
Inventory mode of the Cart referenced in the QuoteRequestDraft.
- Specified by:
setInventoryMode
in interfaceQuote
- Parameters:
inventoryMode
- value to be set
-
setTaxMode
Description copied from interface:Quote
Tax mode of the Cart referenced in the QuoteRequestDraft.
- Specified by:
setTaxMode
in interfaceQuote
- Parameters:
taxMode
- value to be set
-
setTaxRoundingMode
Description copied from interface:Quote
When calculating taxes for
taxedPrice
, the selected mode is used for rounding.- Specified by:
setTaxRoundingMode
in interfaceQuote
- Parameters:
taxRoundingMode
- value to be set
-
setTaxCalculationMode
Description copied from interface:Quote
When calculating taxes for
taxedPrice
, the selected mode is used for calculating the price withLineItemLevel
(horizontally) orUnitPriceLevel
(vertically) calculation mode.- Specified by:
setTaxCalculationMode
in interfaceQuote
- Parameters:
taxCalculationMode
- value to be set
-
setCountry
Description copied from interface:Quote
Used for Product Variant price selection.
- Specified by:
setCountry
in interfaceQuote
- Parameters:
country
- value to be set
-
setShippingInfo
Description copied from interface:Quote
Set automatically once the ShippingMethod is set.
- Specified by:
setShippingInfo
in interfaceQuote
- Parameters:
shippingInfo
- value to be set
-
setPaymentInfo
Description copied from interface:Quote
Log of payment transactions related to the Quote.
- Specified by:
setPaymentInfo
in interfaceQuote
- Parameters:
paymentInfo
- value to be set
-
setShippingRateInput
Description copied from interface:Quote
Used to select a ShippingRatePriceTier.
- Specified by:
setShippingRateInput
in interfaceQuote
- Parameters:
shippingRateInput
- value to be set
-
setItemShippingAddresses
Description copied from interface:Quote
Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their
shippingDetails
. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart'sshippingAddress
is used for this.- Specified by:
setItemShippingAddresses
in interfaceQuote
- Parameters:
itemShippingAddresses
- values to be set
-
setItemShippingAddresses
Description copied from interface:Quote
Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their
shippingDetails
. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart'sshippingAddress
is used for this.- Specified by:
setItemShippingAddresses
in interfaceQuote
- Parameters:
itemShippingAddresses
- values to be set
-
setDirectDiscounts
Description copied from interface:Quote
Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
- Specified by:
setDirectDiscounts
in interfaceQuote
- Parameters:
directDiscounts
- values to be set
-
setDirectDiscounts
Description copied from interface:Quote
Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
- Specified by:
setDirectDiscounts
in interfaceQuote
- Parameters:
directDiscounts
- values to be set
-
setCustom
Description copied from interface:Quote
Custom Fields on the Quote.
- Specified by:
setCustom
in interfaceCustomizable<Quote>
- Specified by:
setCustom
in interfaceQuote
- Parameters:
custom
- value to be set
-
setQuoteState
Description copied from interface:Quote
Predefined states tracking the status of the Quote.
- Specified by:
setQuoteState
in interfaceQuote
- Parameters:
quoteState
- value to be set
-
setState
Description copied from interface:Quote
State of the Quote. This reference can point to a State in a custom workflow.
-
setPurchaseOrderNumber
Description copied from interface:Quote
The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.
- Specified by:
setPurchaseOrderNumber
in interfaceQuote
- Parameters:
purchaseOrderNumber
- value to be set
-
setBusinessUnit
Description copied from interface:Quote
The BusinessUnit for the Quote.
- Specified by:
setBusinessUnit
in interfaceQuote
- Parameters:
businessUnit
- value to be set
-
equals
-
hashCode
-