Class CartAddCustomShippingMethodActionImpl
- All Implemented Interfaces:
CartAddCustomShippingMethodAction
,CartUpdateAction
,ResourceUpdateAction<CartUpdateAction>
,io.vrap.rmf.base.client.ModelBase
To add a custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) to the Cart, it must have the Multiple
ShippingMode.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Field Summary
Fields inherited from interface com.commercetools.api.models.cart.CartAddCustomShippingMethodAction
ADD_CUSTOM_SHIPPING_METHOD
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Custom Fields for the custom Shipping Method.Deliveries to be shipped with the custom Shipping Method.Tax Rate used to tax a shipping expense if the Cart has theExternal
TaxMode.Determines the shipping rate and Tax Rate of the associated Line Items.User-defined identifier for the custom Shipping Method that must be unique across the Cart withMultiple
ShippingMode.Name of the custom Shipping Method.Determines the shipping price.Input used to select a ShippingRatePriceTier.Tax Category used to determine a shipping Tax Rate if the Cart has thePlatform
TaxMode.int
hashCode()
void
setCustom
(CustomFieldsDraft custom) Custom Fields for the custom Shipping Method.void
setDeliveries
(DeliveryDraft... deliveries) Deliveries to be shipped with the custom Shipping Method.void
setDeliveries
(List<DeliveryDraft> deliveries) Deliveries to be shipped with the custom Shipping Method.void
setExternalTaxRate
(ExternalTaxRateDraft externalTaxRate) Tax Rate used to tax a shipping expense if the Cart has theExternal
TaxMode.void
setShippingAddress
(BaseAddress shippingAddress) Determines the shipping rate and Tax Rate of the associated Line Items.void
setShippingKey
(String shippingKey) User-defined identifier for the custom Shipping Method that must be unique across the Cart withMultiple
ShippingMode.void
setShippingMethodName
(String shippingMethodName) Name of the custom Shipping Method.void
setShippingRate
(ShippingRateDraft shippingRate) Determines the shipping price.void
setShippingRateInput
(ShippingRateInputDraft shippingRateInput) Input used to select a ShippingRatePriceTier.void
setTaxCategory
(TaxCategoryResourceIdentifier taxCategory) Tax Category used to determine a shipping Tax Rate if the Cart has thePlatform
TaxMode.toString()
Methods inherited from interface com.commercetools.api.models.cart.CartAddCustomShippingMethodAction
withCartAddCustomShippingMethodAction
Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction
withCartUpdateAction
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
-
Constructor Details
-
CartAddCustomShippingMethodActionImpl
public CartAddCustomShippingMethodActionImpl()create empty instance
-
-
Method Details
-
getAction
- Specified by:
getAction
in interfaceCartUpdateAction
- Specified by:
getAction
in interfaceResourceUpdateAction<CartUpdateAction>
- Returns:
- action
-
getShippingKey
User-defined identifier for the custom Shipping Method that must be unique across the Cart with
Multiple
ShippingMode.- Specified by:
getShippingKey
in interfaceCartAddCustomShippingMethodAction
- Returns:
- shippingKey
-
getShippingMethodName
Name of the custom Shipping Method.
- Specified by:
getShippingMethodName
in interfaceCartAddCustomShippingMethodAction
- Returns:
- shippingMethodName
-
getShippingAddress
Determines the shipping rate and Tax Rate of the associated Line Items.
- Specified by:
getShippingAddress
in interfaceCartAddCustomShippingMethodAction
- Returns:
- shippingAddress
-
getShippingRate
Determines the shipping price.
- Specified by:
getShippingRate
in interfaceCartAddCustomShippingMethodAction
- Returns:
- shippingRate
-
getShippingRateInput
Input used 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 interfaceCartAddCustomShippingMethodAction
- Returns:
- shippingRateInput
- If
-
getTaxCategory
Tax Category used to determine a shipping Tax Rate if the Cart has the
Platform
TaxMode.- Specified by:
getTaxCategory
in interfaceCartAddCustomShippingMethodAction
- Returns:
- taxCategory
-
getExternalTaxRate
Tax Rate used to tax a shipping expense if the Cart has the
External
TaxMode.- Specified by:
getExternalTaxRate
in interfaceCartAddCustomShippingMethodAction
- Returns:
- externalTaxRate
-
getDeliveries
Deliveries to be shipped with the custom Shipping Method.
- Specified by:
getDeliveries
in interfaceCartAddCustomShippingMethodAction
- Returns:
- deliveries
-
getCustom
Custom Fields for the custom Shipping Method.
- Specified by:
getCustom
in interfaceCartAddCustomShippingMethodAction
- Returns:
- custom
-
setShippingKey
Description copied from interface:CartAddCustomShippingMethodAction
User-defined identifier for the custom Shipping Method that must be unique across the Cart with
Multiple
ShippingMode.- Specified by:
setShippingKey
in interfaceCartAddCustomShippingMethodAction
- Parameters:
shippingKey
- value to be set
-
setShippingMethodName
Description copied from interface:CartAddCustomShippingMethodAction
Name of the custom Shipping Method.
- Specified by:
setShippingMethodName
in interfaceCartAddCustomShippingMethodAction
- Parameters:
shippingMethodName
- value to be set
-
setShippingAddress
Description copied from interface:CartAddCustomShippingMethodAction
Determines the shipping rate and Tax Rate of the associated Line Items.
- Specified by:
setShippingAddress
in interfaceCartAddCustomShippingMethodAction
- Parameters:
shippingAddress
- value to be set
-
setShippingRate
Description copied from interface:CartAddCustomShippingMethodAction
Determines the shipping price.
- Specified by:
setShippingRate
in interfaceCartAddCustomShippingMethodAction
- Parameters:
shippingRate
- value to be set
-
setShippingRateInput
Description copied from interface:CartAddCustomShippingMethodAction
Input used 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 interfaceCartAddCustomShippingMethodAction
- Parameters:
shippingRateInput
- value to be set
- If
-
setTaxCategory
Description copied from interface:CartAddCustomShippingMethodAction
Tax Category used to determine a shipping Tax Rate if the Cart has the
Platform
TaxMode.- Specified by:
setTaxCategory
in interfaceCartAddCustomShippingMethodAction
- Parameters:
taxCategory
- value to be set
-
setExternalTaxRate
Description copied from interface:CartAddCustomShippingMethodAction
Tax Rate used to tax a shipping expense if the Cart has the
External
TaxMode.- Specified by:
setExternalTaxRate
in interfaceCartAddCustomShippingMethodAction
- Parameters:
externalTaxRate
- value to be set
-
setDeliveries
Description copied from interface:CartAddCustomShippingMethodAction
Deliveries to be shipped with the custom Shipping Method.
- Specified by:
setDeliveries
in interfaceCartAddCustomShippingMethodAction
- Parameters:
deliveries
- values to be set
-
setDeliveries
Description copied from interface:CartAddCustomShippingMethodAction
Deliveries to be shipped with the custom Shipping Method.
- Specified by:
setDeliveries
in interfaceCartAddCustomShippingMethodAction
- Parameters:
deliveries
- values to be set
-
setCustom
Description copied from interface:CartAddCustomShippingMethodAction
Custom Fields for the custom Shipping Method.
- Specified by:
setCustom
in interfaceCartAddCustomShippingMethodAction
- Parameters:
custom
- value to be set
-
equals
-
hashCode
public int hashCode() -
toString
-