Package com.commercetools.api.models.cart

Class CartAddShippingMethodActionBuilder

java.lang.Object

com.commercetools.api.models.cart.CartAddShippingMethodActionBuilder

All Implemented Interfaces:

Builder<CartAddShippingMethodAction>

public class CartAddShippingMethodActionBuilder
extends Object
implements Builder<CartAddShippingMethodAction>

CartAddShippingMethodActionBuilder Example to create an instance using the builder pattern

     CartAddShippingMethodAction cartAddShippingMethodAction = CartAddShippingMethodAction.builder()
             .shippingKey("{shippingKey}")
             .shippingMethod(shippingMethodBuilder -> shippingMethodBuilder)
             .shippingAddress(shippingAddressBuilder -> shippingAddressBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartAddShippingMethodActionBuilder()

Method Summary

Modifier and Type	Method	Description
CartAddShippingMethodActionBuilder	addDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodAction	build()	builds CartAddShippingMethodAction with checking for non-null required values
CartAddShippingMethodAction	buildUnchecked()	builds CartAddShippingMethodAction without checking for non-null required values
CartAddShippingMethodActionBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Shipping Method.
CartAddShippingMethodActionBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Shipping Method.
CartAddShippingMethodActionBuilder	deliveries(DeliveryDraft... deliveries)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodActionBuilder	deliveries(List<DeliveryDraft> deliveries)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodActionBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CartAddShippingMethodActionBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CustomFieldsDraft	getCustom()	Custom Fields for the Shipping Method.
List<DeliveryDraft>	getDeliveries()	Deliveries to be shipped with the referenced 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 Line Items.
String	getShippingKey()	User-defined identifier for the Shipping that must be unique across the Cart with Multiple ShippingMode.
ShippingMethodResourceIdentifier	getShippingMethod()	RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode.
ShippingRateInputDraft	getShippingRateInput()	Input used to select a ShippingRatePriceTier.
static CartAddShippingMethodActionBuilder	of()	factory method for an instance of CartAddShippingMethodActionBuilder
static CartAddShippingMethodActionBuilder	of(CartAddShippingMethodAction template)	create builder for CartAddShippingMethodAction instance
CartAddShippingMethodActionBuilder	plusDeliveries(DeliveryDraft... deliveries)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodActionBuilder	plusDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodActionBuilder	setDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodActionBuilder	shippingAddress(BaseAddress shippingAddress)	Determines the shipping rate and Tax Rate of the Line Items.
CartAddShippingMethodActionBuilder	shippingAddress(Function<BaseAddressBuilder,BaseAddressBuilder> builder)	Determines the shipping rate and Tax Rate of the Line Items.
CartAddShippingMethodActionBuilder	shippingKey(String shippingKey)	User-defined identifier for the Shipping that must be unique across the Cart with Multiple ShippingMode.
CartAddShippingMethodActionBuilder	shippingMethod(ShippingMethodResourceIdentifier shippingMethod)	RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode.
CartAddShippingMethodActionBuilder	shippingMethod(Function<ShippingMethodResourceIdentifierBuilder,ShippingMethodResourceIdentifierBuilder> builder)	RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode.
CartAddShippingMethodActionBuilder	shippingRateInput(ShippingRateInputDraft shippingRateInput)	Input used to select a ShippingRatePriceTier.
CartAddShippingMethodActionBuilder	shippingRateInput(Function<ShippingRateInputDraftBuilder,Builder<? extends ShippingRateInputDraft>> builder)	Input used to select a ShippingRatePriceTier.
CartAddShippingMethodActionBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Shipping Method.
CartAddShippingMethodActionBuilder	withDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)	Deliveries to be shipped with the referenced Shipping Method.
CartAddShippingMethodActionBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CartAddShippingMethodActionBuilder	withShippingAddress(Function<BaseAddressBuilder,BaseAddress> builder)	Determines the shipping rate and Tax Rate of the Line Items.
CartAddShippingMethodActionBuilder	withShippingMethod(Function<ShippingMethodResourceIdentifierBuilder,ShippingMethodResourceIdentifier> builder)	RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode.

Methods inherited from class java.lang.Object

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

Constructor Details

CartAddShippingMethodActionBuilder

public CartAddShippingMethodActionBuilder()

Method Details

shippingKey

public CartAddShippingMethodActionBuilder shippingKey(String shippingKey)

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

Parameters:

shippingKey - value to be set

Returns:

Builder

shippingMethod

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

RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Parameters:

builder - function to build the shippingMethod value

Returns:

Builder

withShippingMethod

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

RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Parameters:

builder - function to build the shippingMethod value

Returns:

Builder

shippingMethod

public CartAddShippingMethodActionBuilder shippingMethod(ShippingMethodResourceIdentifier shippingMethod)

RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Parameters:

shippingMethod - value to be set

Returns:

Builder

shippingAddress

public CartAddShippingMethodActionBuilder shippingAddress(Function<BaseAddressBuilder,BaseAddressBuilder> builder)

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

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

withShippingAddress

public CartAddShippingMethodActionBuilder withShippingAddress(Function<BaseAddressBuilder,BaseAddress> builder)

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

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

shippingAddress

public CartAddShippingMethodActionBuilder shippingAddress(BaseAddress shippingAddress)

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

Parameters:

shippingAddress - value to be set

Returns:

Builder

shippingRateInput

public CartAddShippingMethodActionBuilder shippingRateInput(@Nullable
 ShippingRateInputDraft shippingRateInput)

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.

Parameters:

shippingRateInput - value to be set

Returns:

Builder

shippingRateInput

public CartAddShippingMethodActionBuilder shippingRateInput(Function<ShippingRateInputDraftBuilder,Builder<? extends ShippingRateInputDraft>> builder)

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.

Parameters:

builder - function to build the shippingRateInput value

Returns:

Builder

externalTaxRate

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

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

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

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

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

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public CartAddShippingMethodActionBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

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

Parameters:

externalTaxRate - value to be set

Returns:

Builder

deliveries

public CartAddShippingMethodActionBuilder deliveries(@Nullable
 DeliveryDraft... deliveries)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

deliveries

public CartAddShippingMethodActionBuilder deliveries(@Nullable
 List<DeliveryDraft> deliveries)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

public CartAddShippingMethodActionBuilder plusDeliveries(@Nullable
 DeliveryDraft... deliveries)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

public CartAddShippingMethodActionBuilder plusDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

withDeliveries

public CartAddShippingMethodActionBuilder withDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

addDeliveries

public CartAddShippingMethodActionBuilder addDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

setDeliveries

public CartAddShippingMethodActionBuilder setDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)

Deliveries to be shipped with the referenced Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

custom

public CartAddShippingMethodActionBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Shipping Method.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public CartAddShippingMethodActionBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Shipping Method.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CartAddShippingMethodActionBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Shipping Method.

Parameters:

custom - value to be set

Returns:

Builder

getShippingKey

public String getShippingKey()

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

Returns:

shippingKey

getShippingMethod

public ShippingMethodResourceIdentifier getShippingMethod()

RecourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Returns:

shippingMethod

getShippingAddress

public BaseAddress getShippingAddress()

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

Returns:

shippingAddress

getShippingRateInput

@Nullable
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.

Returns:

shippingRateInput

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

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

Returns:

externalTaxRate

getDeliveries

@Nullable
public List<DeliveryDraft> getDeliveries()

Deliveries to be shipped with the referenced Shipping Method.

Returns:

deliveries

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Shipping Method.

Returns:

custom

build

public CartAddShippingMethodAction build()

builds CartAddShippingMethodAction with checking for non-null required values

Specified by:

build in interface Builder<CartAddShippingMethodAction>

Returns:

CartAddShippingMethodAction

buildUnchecked

public CartAddShippingMethodAction buildUnchecked()

builds CartAddShippingMethodAction without checking for non-null required values

Returns:

CartAddShippingMethodAction

of

public static CartAddShippingMethodActionBuilder of()

factory method for an instance of CartAddShippingMethodActionBuilder

Returns:

builder

of

public static CartAddShippingMethodActionBuilder of(CartAddShippingMethodAction template)

create builder for CartAddShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder