Class CartDraftImpl
- All Implemented Interfaces:
CartDraft
,CustomizableDraft<CartDraft>
,WithKey
,io.vrap.rmf.base.client.Draft<CartDraft>
,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
Anonymous session associated with the Cart.Billing address associated with the Cart.ResourceIdentifier to the Business Unit the Cart should belong to.Used for LineItem Price selection.Currency the Cart uses.Custom Fields for the Cart.Email address of the Customer that the Cart belongs to.ResourceIdentifier to the Customer Group of the Customer that the Cart belongs to.id
of the Customer that the Cart belongs to.Custom Line Items to add to the Cart.Custom Shipping Methods for a Cart withMultiple
ShippingMode.Number of days after which an active Cart is deleted since its last modification.code
of the existing DiscountCodes to add to the Cart.External Tax Rate for theshippingMethod
if the Cart hasExternal
TaxMode.Determines how stock quantities are tracked for Line Items in the Cart.Multiple shipping addresses of the Cart.getKey()
User-defined unique identifier for the Cart.Line Items to add to the Cart.Languages of the Cart.Indicates how the Cart was created.Shipping Methods for a Cart withMultiple
ShippingMode.Shipping address associated with the Cart.Shipping Method for a Cart withSingle
ShippingMode.If set toSingle
, only a single Shipping Method can be added to the Cart. If set toMultiple
, multiple Shipping Methods can be added to the Cart.Used as an input to select a ShippingRatePriceTier.getStore()
ResourceIdentifier to the Store the Cart should belong to.Determines how taxes are calculated when calculating taxes fortaxedPrice
.Determines how Tax Rates are set.Determines how monetary values are rounded when calculating taxes fortaxedPrice
.int
hashCode()
void
setAnonymousId
(String anonymousId) Anonymous session associated with the Cart.void
setBillingAddress
(BaseAddress billingAddress) Billing address associated with the Cart.void
setBusinessUnit
(BusinessUnitResourceIdentifier businessUnit) ResourceIdentifier to the Business Unit the Cart should belong to.void
setCountry
(String country) Used for LineItem Price selection.void
setCurrency
(String currency) Currency the Cart uses.void
setCustom
(CustomFieldsDraft custom) Custom Fields for the Cart.void
setCustomerEmail
(String customerEmail) Email address of the Customer that the Cart belongs to.void
setCustomerGroup
(CustomerGroupResourceIdentifier customerGroup) ResourceIdentifier to the Customer Group of the Customer that the Cart belongs to.void
setCustomerId
(String customerId) id
of the Customer that the Cart belongs to.void
setCustomLineItems
(CustomLineItemDraft... customLineItems) Custom Line Items to add to the Cart.void
setCustomLineItems
(List<CustomLineItemDraft> customLineItems) Custom Line Items to add to the Cart.void
setCustomShipping
(CustomShippingDraft... customShipping) Custom Shipping Methods for a Cart withMultiple
ShippingMode.void
setCustomShipping
(List<CustomShippingDraft> customShipping) Custom Shipping Methods for a Cart withMultiple
ShippingMode.void
setDeleteDaysAfterLastModification
(Long deleteDaysAfterLastModification) Number of days after which an active Cart is deleted since its last modification.void
setDiscountCodes
(String... discountCodes) code
of the existing DiscountCodes to add to the Cart.void
setDiscountCodes
(List<String> discountCodes) code
of the existing DiscountCodes to add to the Cart.void
setExternalTaxRateForShippingMethod
(ExternalTaxRateDraft externalTaxRateForShippingMethod) External Tax Rate for theshippingMethod
if the Cart hasExternal
TaxMode.void
setInventoryMode
(InventoryMode inventoryMode) Determines how stock quantities are tracked for Line Items in the Cart.void
setItemShippingAddresses
(BaseAddress... itemShippingAddresses) Multiple shipping addresses of the Cart.void
setItemShippingAddresses
(List<BaseAddress> itemShippingAddresses) Multiple shipping addresses of the Cart.void
User-defined unique identifier for the Cart.void
setLineItems
(LineItemDraft... lineItems) Line Items to add to the Cart.void
setLineItems
(List<LineItemDraft> lineItems) Line Items to add to the Cart.void
Languages of the Cart.void
setOrigin
(CartOrigin origin) Indicates how the Cart was created.void
setShipping
(ShippingDraft... shipping) Shipping Methods for a Cart withMultiple
ShippingMode.void
setShipping
(List<ShippingDraft> shipping) Shipping Methods for a Cart withMultiple
ShippingMode.void
setShippingAddress
(BaseAddress shippingAddress) Shipping address associated with the Cart.void
setShippingMethod
(ShippingMethodResourceIdentifier shippingMethod) Shipping Method for a Cart withSingle
ShippingMode.void
setShippingMode
(ShippingMode shippingMode) If set toSingle
, only a single Shipping Method can be added to the Cart. If set toMultiple
, multiple Shipping Methods can be added to the Cart.void
setShippingRateInput
(ShippingRateInputDraft shippingRateInput) Used as an input to select a ShippingRatePriceTier.void
setStore
(StoreResourceIdentifier store) ResourceIdentifier to the Store the Cart should belong to.void
setTaxCalculationMode
(TaxCalculationMode taxCalculationMode) Determines how taxes are calculated when calculating taxes fortaxedPrice
.void
setTaxMode
(TaxMode taxMode) Determines how Tax Rates are set.void
setTaxRoundingMode
(RoundingMode taxRoundingMode) Determines how monetary values are rounded when calculating taxes fortaxedPrice
.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.cart.CartDraft
withCartDraft
Methods inherited from interface com.commercetools.api.models.CustomizableDraft
unwrapCustomizableDraft
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
-
Constructor Details
-
CartDraftImpl
public CartDraftImpl()create empty instance
-
-
Method Details
-
getCurrency
Currency the Cart uses.
- Specified by:
getCurrency
in interfaceCartDraft
- Returns:
- currency
-
getKey
User-defined unique identifier for the Cart.
-
getCustomerId
id
of the Customer that the Cart belongs to.- Specified by:
getCustomerId
in interfaceCartDraft
- Returns:
- customerId
-
getCustomerEmail
Email address of the Customer that the Cart belongs to.
- Specified by:
getCustomerEmail
in interfaceCartDraft
- Returns:
- customerEmail
-
getCustomerGroup
ResourceIdentifier to the Customer Group of the Customer that the Cart belongs to. Used for LineItem Price selection.
It is automatically set if the Customer referenced in
customerId
belongs to a Customer Group. It can also be set explicitly when nocustomerId
is present.- Specified by:
getCustomerGroup
in interfaceCartDraft
- Returns:
- customerGroup
-
getAnonymousId
Anonymous session associated with the Cart.
- Specified by:
getAnonymousId
in interfaceCartDraft
- Returns:
- anonymousId
-
getBusinessUnit
ResourceIdentifier to the Business Unit the Cart should belong to. When the
customerId
of the Cart is also set, the Customer must be an Associate of the Business Unit.- Specified by:
getBusinessUnit
in interfaceCartDraft
- Returns:
- businessUnit
-
getStore
ResourceIdentifier to the Store the Cart should belong to. Once set, it cannot be updated.
-
getLineItems
Line Items to add to the Cart.
- Specified by:
getLineItems
in interfaceCartDraft
- Returns:
- lineItems
-
getCustomLineItems
Custom Line Items to add to the Cart.
- Specified by:
getCustomLineItems
in interfaceCartDraft
- Returns:
- customLineItems
-
getTaxMode
Determines how Tax Rates are set.
- Specified by:
getTaxMode
in interfaceCartDraft
- Returns:
- taxMode
-
getExternalTaxRateForShippingMethod
External Tax Rate for the
shippingMethod
if the Cart hasExternal
TaxMode.- Specified by:
getExternalTaxRateForShippingMethod
in interfaceCartDraft
- Returns:
- externalTaxRateForShippingMethod
-
getTaxRoundingMode
Determines how monetary values are rounded when calculating taxes for
taxedPrice
.- Specified by:
getTaxRoundingMode
in interfaceCartDraft
- Returns:
- taxRoundingMode
-
getTaxCalculationMode
Determines how taxes are calculated when calculating taxes for
taxedPrice
.- Specified by:
getTaxCalculationMode
in interfaceCartDraft
- Returns:
- taxCalculationMode
-
getInventoryMode
Determines how stock quantities are tracked for Line Items in the Cart.
- Specified by:
getInventoryMode
in interfaceCartDraft
- Returns:
- inventoryMode
-
getBillingAddress
Billing address associated with the Cart.
- Specified by:
getBillingAddress
in interfaceCartDraft
- Returns:
- billingAddress
-
getShippingAddress
Shipping address associated with the Cart. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Specified by:
getShippingAddress
in interfaceCartDraft
- Returns:
- shippingAddress
-
getShippingMethod
Shipping Method for a Cart with
Single
ShippingMode. If the referenced ShippingMethod has apredicate
that does not match the Cart, an InvalidOperation error is returned when creating a Cart.- Specified by:
getShippingMethod
in interfaceCartDraft
- Returns:
- shippingMethod
-
getShippingRateInput
Used as an input to select a ShippingRatePriceTier. The data type of this field depends on the
shippingRateInputType.type
configured in the Project:- If
CartClassification
, it must be ClassificationShippingRateInputDraft. - If
CartScore
, it must be ScoreShippingRateInputDraft. - If
CartValue
, it cannot be set.
- Specified by:
getShippingRateInput
in interfaceCartDraft
- Returns:
- shippingRateInput
- If
-
getShippingMode
- If set to
Single
, only a single Shipping Method can be added to the Cart. - If set to
Multiple
, multiple Shipping Methods can be added to the Cart.
- Specified by:
getShippingMode
in interfaceCartDraft
- Returns:
- shippingMode
- If set to
-
getCustomShipping
Custom Shipping Methods for a Cart with
Multiple
ShippingMode.- Specified by:
getCustomShipping
in interfaceCartDraft
- Returns:
- customShipping
-
getShipping
Shipping Methods for a Cart with
Multiple
ShippingMode.- Specified by:
getShipping
in interfaceCartDraft
- Returns:
- shipping
-
getItemShippingAddresses
Multiple shipping addresses of the Cart. Each address must contain a
key
that is unique in this Cart. The keys are used by LineItems to reference these addresses under theirshippingDetails
.Eligible Shipping Methods or applicable Tax Rates are determined by the address
shippingAddress
, and notitemShippingAddresses
.- Specified by:
getItemShippingAddresses
in interfaceCartDraft
- Returns:
- itemShippingAddresses
-
getDiscountCodes
code
of the existing DiscountCodes to add to the Cart.- Specified by:
getDiscountCodes
in interfaceCartDraft
- Returns:
- discountCodes
-
getCountry
Used for LineItem Price selection. If used for Create Cart in Store, the provided country must be one of the Store's
countries
.- Specified by:
getCountry
in interfaceCartDraft
- Returns:
- country
-
getLocale
Languages of the Cart. Can only contain languages supported by the Project.
-
getOrigin
Indicates how the Cart was created.
-
getDeleteDaysAfterLastModification
Number of days after which an active Cart is deleted since its last modification. If not provided, the default value for this field configured in Project settings is assigned.
Create a ChangeSubscription for Carts to receive a ResourceDeletedDeliveryPayload upon deletion of the Cart.
- Specified by:
getDeleteDaysAfterLastModification
in interfaceCartDraft
- Returns:
- deleteDaysAfterLastModification
-
getCustom
Custom Fields for the Cart.
- Specified by:
getCustom
in interfaceCartDraft
- Specified by:
getCustom
in interfaceCustomizableDraft<CartDraft>
- Returns:
- custom
-
setCurrency
Description copied from interface:CartDraft
Currency the Cart uses.
- Specified by:
setCurrency
in interfaceCartDraft
- Parameters:
currency
- value to be set
-
setKey
Description copied from interface:CartDraft
User-defined unique identifier for the Cart.
-
setCustomerId
Description copied from interface:CartDraft
id
of the Customer that the Cart belongs to.- Specified by:
setCustomerId
in interfaceCartDraft
- Parameters:
customerId
- value to be set
-
setCustomerEmail
Description copied from interface:CartDraft
Email address of the Customer that the Cart belongs to.
- Specified by:
setCustomerEmail
in interfaceCartDraft
- Parameters:
customerEmail
- value to be set
-
setCustomerGroup
Description copied from interface:CartDraft
ResourceIdentifier to the Customer Group of the Customer that the Cart belongs to. Used for LineItem Price selection.
It is automatically set if the Customer referenced in
customerId
belongs to a Customer Group. It can also be set explicitly when nocustomerId
is present.- Specified by:
setCustomerGroup
in interfaceCartDraft
- Parameters:
customerGroup
- value to be set
-
setAnonymousId
Description copied from interface:CartDraft
Anonymous session associated with the Cart.
- Specified by:
setAnonymousId
in interfaceCartDraft
- Parameters:
anonymousId
- value to be set
-
setBusinessUnit
Description copied from interface:CartDraft
ResourceIdentifier to the Business Unit the Cart should belong to. When the
customerId
of the Cart is also set, the Customer must be an Associate of the Business Unit.- Specified by:
setBusinessUnit
in interfaceCartDraft
- Parameters:
businessUnit
- value to be set
-
setStore
Description copied from interface:CartDraft
ResourceIdentifier to the Store the Cart should belong to. Once set, it cannot be updated.
-
setLineItems
Description copied from interface:CartDraft
Line Items to add to the Cart.
- Specified by:
setLineItems
in interfaceCartDraft
- Parameters:
lineItems
- values to be set
-
setLineItems
Description copied from interface:CartDraft
Line Items to add to the Cart.
- Specified by:
setLineItems
in interfaceCartDraft
- Parameters:
lineItems
- values to be set
-
setCustomLineItems
Description copied from interface:CartDraft
Custom Line Items to add to the Cart.
- Specified by:
setCustomLineItems
in interfaceCartDraft
- Parameters:
customLineItems
- values to be set
-
setCustomLineItems
Description copied from interface:CartDraft
Custom Line Items to add to the Cart.
- Specified by:
setCustomLineItems
in interfaceCartDraft
- Parameters:
customLineItems
- values to be set
-
setTaxMode
Description copied from interface:CartDraft
Determines how Tax Rates are set.
- Specified by:
setTaxMode
in interfaceCartDraft
- Parameters:
taxMode
- value to be set
-
setExternalTaxRateForShippingMethod
public void setExternalTaxRateForShippingMethod(ExternalTaxRateDraft externalTaxRateForShippingMethod) Description copied from interface:CartDraft
External Tax Rate for the
shippingMethod
if the Cart hasExternal
TaxMode.- Specified by:
setExternalTaxRateForShippingMethod
in interfaceCartDraft
- Parameters:
externalTaxRateForShippingMethod
- value to be set
-
setTaxRoundingMode
Description copied from interface:CartDraft
Determines how monetary values are rounded when calculating taxes for
taxedPrice
.- Specified by:
setTaxRoundingMode
in interfaceCartDraft
- Parameters:
taxRoundingMode
- value to be set
-
setTaxCalculationMode
Description copied from interface:CartDraft
Determines how taxes are calculated when calculating taxes for
taxedPrice
.- Specified by:
setTaxCalculationMode
in interfaceCartDraft
- Parameters:
taxCalculationMode
- value to be set
-
setInventoryMode
Description copied from interface:CartDraft
Determines how stock quantities are tracked for Line Items in the Cart.
- Specified by:
setInventoryMode
in interfaceCartDraft
- Parameters:
inventoryMode
- value to be set
-
setBillingAddress
Description copied from interface:CartDraft
Billing address associated with the Cart.
- Specified by:
setBillingAddress
in interfaceCartDraft
- Parameters:
billingAddress
- value to be set
-
setShippingAddress
Description copied from interface:CartDraft
Shipping address associated with the Cart. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Specified by:
setShippingAddress
in interfaceCartDraft
- Parameters:
shippingAddress
- value to be set
-
setShippingMethod
Description copied from interface:CartDraft
Shipping Method for a Cart with
Single
ShippingMode. If the referenced ShippingMethod has apredicate
that does not match the Cart, an InvalidOperation error is returned when creating a Cart.- Specified by:
setShippingMethod
in interfaceCartDraft
- Parameters:
shippingMethod
- value to be set
-
setShippingRateInput
Description copied from interface:CartDraft
Used as an input to select a ShippingRatePriceTier. The data type of this field depends on the
shippingRateInputType.type
configured in the Project:- If
CartClassification
, it must be ClassificationShippingRateInputDraft. - If
CartScore
, it must be ScoreShippingRateInputDraft. - If
CartValue
, it cannot be set.
- Specified by:
setShippingRateInput
in interfaceCartDraft
- Parameters:
shippingRateInput
- value to be set
- If
-
setShippingMode
Description copied from interface:CartDraft
- If set to
Single
, only a single Shipping Method can be added to the Cart. - If set to
Multiple
, multiple Shipping Methods can be added to the Cart.
- Specified by:
setShippingMode
in interfaceCartDraft
- Parameters:
shippingMode
- value to be set
- If set to
-
setCustomShipping
Description copied from interface:CartDraft
Custom Shipping Methods for a Cart with
Multiple
ShippingMode.- Specified by:
setCustomShipping
in interfaceCartDraft
- Parameters:
customShipping
- values to be set
-
setCustomShipping
Description copied from interface:CartDraft
Custom Shipping Methods for a Cart with
Multiple
ShippingMode.- Specified by:
setCustomShipping
in interfaceCartDraft
- Parameters:
customShipping
- values to be set
-
setShipping
Description copied from interface:CartDraft
Shipping Methods for a Cart with
Multiple
ShippingMode.- Specified by:
setShipping
in interfaceCartDraft
- Parameters:
shipping
- values to be set
-
setShipping
Description copied from interface:CartDraft
Shipping Methods for a Cart with
Multiple
ShippingMode.- Specified by:
setShipping
in interfaceCartDraft
- Parameters:
shipping
- values to be set
-
setItemShippingAddresses
Description copied from interface:CartDraft
Multiple shipping addresses of the Cart. Each address must contain a
key
that is unique in this Cart. The keys are used by LineItems to reference these addresses under theirshippingDetails
.Eligible Shipping Methods or applicable Tax Rates are determined by the address
shippingAddress
, and notitemShippingAddresses
.- Specified by:
setItemShippingAddresses
in interfaceCartDraft
- Parameters:
itemShippingAddresses
- values to be set
-
setItemShippingAddresses
Description copied from interface:CartDraft
Multiple shipping addresses of the Cart. Each address must contain a
key
that is unique in this Cart. The keys are used by LineItems to reference these addresses under theirshippingDetails
.Eligible Shipping Methods or applicable Tax Rates are determined by the address
shippingAddress
, and notitemShippingAddresses
.- Specified by:
setItemShippingAddresses
in interfaceCartDraft
- Parameters:
itemShippingAddresses
- values to be set
-
setDiscountCodes
Description copied from interface:CartDraft
code
of the existing DiscountCodes to add to the Cart.- Specified by:
setDiscountCodes
in interfaceCartDraft
- Parameters:
discountCodes
- values to be set
-
setDiscountCodes
Description copied from interface:CartDraft
code
of the existing DiscountCodes to add to the Cart.- Specified by:
setDiscountCodes
in interfaceCartDraft
- Parameters:
discountCodes
- values to be set
-
setCountry
Description copied from interface:CartDraft
Used for LineItem Price selection. If used for Create Cart in Store, the provided country must be one of the Store's
countries
.- Specified by:
setCountry
in interfaceCartDraft
- Parameters:
country
- value to be set
-
setLocale
Description copied from interface:CartDraft
Languages of the Cart. Can only contain languages supported by the Project.
-
setOrigin
Description copied from interface:CartDraft
Indicates how the Cart was created.
-
setDeleteDaysAfterLastModification
Description copied from interface:CartDraft
Number of days after which an active Cart is deleted since its last modification. If not provided, the default value for this field configured in Project settings is assigned.
Create a ChangeSubscription for Carts to receive a ResourceDeletedDeliveryPayload upon deletion of the Cart.
- Specified by:
setDeleteDaysAfterLastModification
in interfaceCartDraft
- Parameters:
deleteDaysAfterLastModification
- value to be set
-
setCustom
Description copied from interface:CartDraft
Custom Fields for the Cart.
- Specified by:
setCustom
in interfaceCartDraft
- Specified by:
setCustom
in interfaceCustomizableDraft<CartDraft>
- Parameters:
custom
- value to be set
-
equals
-
hashCode
-