Package com.commercetools.api.models.cart

Class CartAddCustomShippingMethodActionImpl

java.lang.Object

com.commercetools.api.models.cart.CartAddCustomShippingMethodActionImpl

All Implemented Interfaces:

CartAddCustomShippingMethodAction, CartUpdateAction, ResourceUpdateAction<CartUpdateAction>, io.vrap.rmf.base.client.ModelBase

public class CartAddCustomShippingMethodActionImpl
extends Object
implements CartAddCustomShippingMethodAction, 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

Constructors

Constructor	Description
CartAddCustomShippingMethodActionImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAction()
CustomFieldsDraft	getCustom()	Custom Fields for the custom Shipping Method.
List<DeliveryDraft>	getDeliveries()	Deliveries to be shipped with the custom Shipping Method.
ExternalTaxRateDraft	getExternalTaxRate()	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
BaseAddress	getShippingAddress()	Determines the shipping rate and Tax Rate of the associated Line Items.
String	getShippingKey()	User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode.
String	getShippingMethodName()	Name of the custom Shipping Method.
ShippingRateDraft	getShippingRate()	Determines the shipping price.
ShippingRateInputDraft	getShippingRateInput()	Input used to select a ShippingRatePriceTier.
TaxCategoryResourceIdentifier	getTaxCategory()	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform 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 the External 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 with Multiple 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 the Platform TaxMode.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

public String getAction()

Specified by:

getAction in interface CartUpdateAction

Specified by:

getAction in interface ResourceUpdateAction<CartUpdateAction>

Returns:

action

getShippingKey

public String getShippingKey()

User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode.

Specified by:

getShippingKey in interface CartAddCustomShippingMethodAction

Returns:

shippingKey

getShippingMethodName

public String getShippingMethodName()

Name of the custom Shipping Method.

Specified by:

getShippingMethodName in interface CartAddCustomShippingMethodAction

Returns:

shippingMethodName

getShippingAddress

public BaseAddress getShippingAddress()

Determines the shipping rate and Tax Rate of the associated Line Items.

Specified by:

getShippingAddress in interface CartAddCustomShippingMethodAction

Returns:

shippingAddress

getShippingRate

public ShippingRateDraft getShippingRate()

Determines the shipping price.

Specified by:

getShippingRate in interface CartAddCustomShippingMethodAction

Returns:

shippingRate

getShippingRateInput

public ShippingRateInputDraft 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 interface CartAddCustomShippingMethodAction

Returns:

shippingRateInput

getTaxCategory

public TaxCategoryResourceIdentifier getTaxCategory()

Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Specified by:

getTaxCategory in interface CartAddCustomShippingMethodAction

Returns:

taxCategory

getExternalTaxRate

public ExternalTaxRateDraft getExternalTaxRate()

Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

Specified by:

getExternalTaxRate in interface CartAddCustomShippingMethodAction

Returns:

externalTaxRate

getDeliveries

public List<DeliveryDraft> getDeliveries()

Deliveries to be shipped with the custom Shipping Method.

Specified by:

getDeliveries in interface CartAddCustomShippingMethodAction

Returns:

deliveries

getCustom

public CustomFieldsDraft getCustom()

Custom Fields for the custom Shipping Method.

Specified by:

getCustom in interface CartAddCustomShippingMethodAction

Returns:

custom

setShippingKey

public void setShippingKey(String shippingKey)

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 interface CartAddCustomShippingMethodAction

Parameters:

shippingKey - value to be set

setShippingMethodName

public void setShippingMethodName(String shippingMethodName)

Description copied from interface: CartAddCustomShippingMethodAction

Name of the custom Shipping Method.

Specified by:

setShippingMethodName in interface CartAddCustomShippingMethodAction

Parameters:

shippingMethodName - value to be set

setShippingAddress

public void setShippingAddress(BaseAddress shippingAddress)

Description copied from interface: CartAddCustomShippingMethodAction

Determines the shipping rate and Tax Rate of the associated Line Items.

Specified by:

setShippingAddress in interface CartAddCustomShippingMethodAction

Parameters:

shippingAddress - value to be set

setShippingRate

public void setShippingRate(ShippingRateDraft shippingRate)

Description copied from interface: CartAddCustomShippingMethodAction

Determines the shipping price.

Specified by:

setShippingRate in interface CartAddCustomShippingMethodAction

Parameters:

shippingRate - value to be set

setShippingRateInput

public void setShippingRateInput(ShippingRateInputDraft shippingRateInput)

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 interface CartAddCustomShippingMethodAction

Parameters:

shippingRateInput - value to be set

setTaxCategory

public void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

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 interface CartAddCustomShippingMethodAction

Parameters:

taxCategory - value to be set

setExternalTaxRate

public void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Description copied from interface: CartAddCustomShippingMethodAction

Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

Specified by:

setExternalTaxRate in interface CartAddCustomShippingMethodAction

Parameters:

externalTaxRate - value to be set

setDeliveries

public void setDeliveries(DeliveryDraft... deliveries)

Description copied from interface: CartAddCustomShippingMethodAction

Deliveries to be shipped with the custom Shipping Method.

Specified by:

setDeliveries in interface CartAddCustomShippingMethodAction

Parameters:

deliveries - values to be set

setDeliveries

public void setDeliveries(List<DeliveryDraft> deliveries)

Description copied from interface: CartAddCustomShippingMethodAction

Deliveries to be shipped with the custom Shipping Method.

Specified by:

setDeliveries in interface CartAddCustomShippingMethodAction

Parameters:

deliveries - values to be set

setCustom

public void setCustom(CustomFieldsDraft custom)

Description copied from interface: CartAddCustomShippingMethodAction

Custom Fields for the custom Shipping Method.

Specified by:

setCustom in interface CartAddCustomShippingMethodAction

Parameters:

custom - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object