Package com.commercetools.api.models.cart

Class CartSetShippingMethodActionBuilder

java.lang.Object

com.commercetools.api.models.cart.CartSetShippingMethodActionBuilder

All Implemented Interfaces:

Builder<CartSetShippingMethodAction>

public class CartSetShippingMethodActionBuilder
extends Object
implements Builder<CartSetShippingMethodAction>

CartSetShippingMethodActionBuilder Example to create an instance using the builder pattern

     CartSetShippingMethodAction cartSetShippingMethodAction = CartSetShippingMethodAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartSetShippingMethodActionBuilder()

Method Summary

Modifier and Type	Method	Description
CartSetShippingMethodAction	build()	builds CartSetShippingMethodAction with checking for non-null required values
CartSetShippingMethodAction	buildUnchecked()	builds CartSetShippingMethodAction without checking for non-null required values
CartSetShippingMethodActionBuilder	estimatedDelivery(EstimatedDelivery estimatedDelivery)	Estimated time window during which the shipment is expected to be delivered.
CartSetShippingMethodActionBuilder	estimatedDelivery(Function<EstimatedDeliveryBuilder,EstimatedDeliveryBuilder> builder)	Estimated time window during which the shipment is expected to be delivered.
CartSetShippingMethodActionBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	An external Tax Rate can be set if the Cart has the External TaxMode.
CartSetShippingMethodActionBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	An external Tax Rate can be set if the Cart has the External TaxMode.
EstimatedDelivery	getEstimatedDelivery()	Estimated time window during which the shipment is expected to be delivered.
ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has the External TaxMode.
ShippingMethodResourceIdentifier	getShippingMethod()	Value to set.
static CartSetShippingMethodActionBuilder	of()	factory method for an instance of CartSetShippingMethodActionBuilder
static CartSetShippingMethodActionBuilder	of(CartSetShippingMethodAction template)	create builder for CartSetShippingMethodAction instance
CartSetShippingMethodActionBuilder	shippingMethod(ShippingMethodResourceIdentifier shippingMethod)	Value to set.
CartSetShippingMethodActionBuilder	shippingMethod(Function<ShippingMethodResourceIdentifierBuilder,ShippingMethodResourceIdentifierBuilder> builder)	Value to set.
CartSetShippingMethodActionBuilder	withEstimatedDelivery(Function<EstimatedDeliveryBuilder,EstimatedDelivery> builder)	Estimated time window during which the shipment is expected to be delivered.
CartSetShippingMethodActionBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	An external Tax Rate can be set if the Cart has the External TaxMode.
CartSetShippingMethodActionBuilder	withShippingMethod(Function<ShippingMethodResourceIdentifierBuilder,ShippingMethodResourceIdentifier> builder)	Value to set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CartSetShippingMethodActionBuilder

public CartSetShippingMethodActionBuilder()

Method Details

shippingMethod

public CartSetShippingMethodActionBuilder shippingMethod(Function<ShippingMethodResourceIdentifierBuilder,ShippingMethodResourceIdentifierBuilder> builder)

Value to set. If omitted, any existing value is removed.

InvalidOperation error is returned in one of the following cases:

1. If the referenced Shipping Method has a predicate that does not match the Cart.
2. If the referenced Shipping Method is not active.
3. If the referenced Shipping Method is associated with a Store that is different from the Cart's Store.
4. If the referenced Shipping Method is associated with a Store and the Cart is not associated with any Store.

Parameters:

builder - function to build the shippingMethod value

Returns:

Builder

withShippingMethod

public CartSetShippingMethodActionBuilder withShippingMethod(Function<ShippingMethodResourceIdentifierBuilder,ShippingMethodResourceIdentifier> builder)

Value to set. If omitted, any existing value is removed.

InvalidOperation error is returned in one of the following cases:

1. If the referenced Shipping Method has a predicate that does not match the Cart.
2. If the referenced Shipping Method is not active.
3. If the referenced Shipping Method is associated with a Store that is different from the Cart's Store.
4. If the referenced Shipping Method is associated with a Store and the Cart is not associated with any Store.

Parameters:

builder - function to build the shippingMethod value

Returns:

Builder

shippingMethod

public CartSetShippingMethodActionBuilder shippingMethod(@Nullable
 ShippingMethodResourceIdentifier shippingMethod)

Value to set. If omitted, any existing value is removed.

InvalidOperation error is returned in one of the following cases:

1. If the referenced Shipping Method has a predicate that does not match the Cart.
2. If the referenced Shipping Method is not active.
3. If the referenced Shipping Method is associated with a Store that is different from the Cart's Store.
4. If the referenced Shipping Method is associated with a Store and the Cart is not associated with any Store.

Parameters:

shippingMethod - value to be set

Returns:

Builder

externalTaxRate

public CartSetShippingMethodActionBuilder externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)

An external Tax Rate can be set if the Cart has the External TaxMode.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

public CartSetShippingMethodActionBuilder withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)

An external Tax Rate can be set if the Cart has the External TaxMode.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public CartSetShippingMethodActionBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

An external Tax Rate can be set if the Cart has the External TaxMode.

Parameters:

externalTaxRate - value to be set

Returns:

Builder

estimatedDelivery

public CartSetShippingMethodActionBuilder estimatedDelivery(Function<EstimatedDeliveryBuilder,EstimatedDeliveryBuilder> builder)

Estimated time window during which the shipment is expected to be delivered. If not set, any existing estimate on the Cart's ShippingInfo is cleared.

Parameters:

builder - function to build the estimatedDelivery value

Returns:

Builder

withEstimatedDelivery

public CartSetShippingMethodActionBuilder withEstimatedDelivery(Function<EstimatedDeliveryBuilder,EstimatedDelivery> builder)

Estimated time window during which the shipment is expected to be delivered. If not set, any existing estimate on the Cart's ShippingInfo is cleared.

Parameters:

builder - function to build the estimatedDelivery value

Returns:

Builder

estimatedDelivery

public CartSetShippingMethodActionBuilder estimatedDelivery(@Nullable
 EstimatedDelivery estimatedDelivery)

Estimated time window during which the shipment is expected to be delivered. If not set, any existing estimate on the Cart's ShippingInfo is cleared.

Parameters:

estimatedDelivery - value to be set

Returns:

Builder

getShippingMethod

@Nullable
public ShippingMethodResourceIdentifier getShippingMethod()

Value to set. If omitted, any existing value is removed.

InvalidOperation error is returned in one of the following cases:

1. If the referenced Shipping Method has a predicate that does not match the Cart.
2. If the referenced Shipping Method is not active.
3. If the referenced Shipping Method is associated with a Store that is different from the Cart's Store.
4. If the referenced Shipping Method is associated with a Store and the Cart is not associated with any Store.

Returns:

shippingMethod

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

An external Tax Rate can be set if the Cart has the External TaxMode.

Returns:

externalTaxRate

getEstimatedDelivery

@Nullable
public EstimatedDelivery getEstimatedDelivery()

Estimated time window during which the shipment is expected to be delivered. If not set, any existing estimate on the Cart's ShippingInfo is cleared.

Returns:

estimatedDelivery

build

public CartSetShippingMethodAction build()

builds CartSetShippingMethodAction with checking for non-null required values

Specified by:

build in interface Builder<CartSetShippingMethodAction>

Returns:

CartSetShippingMethodAction

buildUnchecked

public CartSetShippingMethodAction buildUnchecked()

builds CartSetShippingMethodAction without checking for non-null required values

Returns:

CartSetShippingMethodAction

of

public static CartSetShippingMethodActionBuilder of()

factory method for an instance of CartSetShippingMethodActionBuilder

Returns:

builder

of

public static CartSetShippingMethodActionBuilder of(CartSetShippingMethodAction template)

create builder for CartSetShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder