Package com.commercetools.api.models.cart

Class CustomShippingDraftBuilder

java.lang.Object

com.commercetools.api.models.cart.CustomShippingDraftBuilder

All Implemented Interfaces:

Builder<CustomShippingDraft>

public class CustomShippingDraftBuilder
extends Object
implements Builder<CustomShippingDraft>

CustomShippingDraftBuilder Example to create an instance using the builder pattern

     CustomShippingDraft customShippingDraft = CustomShippingDraft.builder()
             .key("{key}")
             .shippingMethodName("{shippingMethodName}")
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomShippingDraftBuilder()

Method Summary

Modifier and Type	Method	Description
CustomShippingDraftBuilder	addDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraft	build()	builds CustomShippingDraft with checking for non-null required values
CustomShippingDraft	buildUnchecked()	builds CustomShippingDraft without checking for non-null required values
CustomShippingDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the custom Shipping Method.
CustomShippingDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the custom Shipping Method.
CustomShippingDraftBuilder	deliveries(DeliveryDraft... deliveries)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraftBuilder	deliveries(List<DeliveryDraft> deliveries)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraftBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CustomShippingDraftBuilder	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 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.
String	getKey()	User-defined unique identifier of the custom Shipping Method in the Cart with Multiple ShippingMode.
BaseAddress	getShippingAddress()	Determines the shipping rate and Tax Rate of the associated Line Items.
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.
CustomShippingDraftBuilder	key(String key)	User-defined unique identifier of the custom Shipping Method in the Cart with Multiple ShippingMode.
static CustomShippingDraftBuilder	of()	factory method for an instance of CustomShippingDraftBuilder
static CustomShippingDraftBuilder	of(CustomShippingDraft template)	create builder for CustomShippingDraft instance
CustomShippingDraftBuilder	plusDeliveries(DeliveryDraft... deliveries)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraftBuilder	plusDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraftBuilder	setDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraftBuilder	shippingAddress(BaseAddress shippingAddress)	Determines the shipping rate and Tax Rate of the associated Line Items.
CustomShippingDraftBuilder	shippingAddress(Function<BaseAddressBuilder,BaseAddressBuilder> builder)	Determines the shipping rate and Tax Rate of the associated Line Items.
CustomShippingDraftBuilder	shippingMethodName(String shippingMethodName)	Name of the custom Shipping Method.
CustomShippingDraftBuilder	shippingRate(ShippingRateDraft shippingRate)	Determines the shipping price.
CustomShippingDraftBuilder	shippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraftBuilder> builder)	Determines the shipping price.
CustomShippingDraftBuilder	shippingRateInput(ShippingRateInputDraft shippingRateInput)	Input used to select a ShippingRatePriceTier.
CustomShippingDraftBuilder	shippingRateInput(Function<ShippingRateInputDraftBuilder,Builder<? extends ShippingRateInputDraft>> builder)	Input used to select a ShippingRatePriceTier.
CustomShippingDraftBuilder	taxCategory(TaxCategoryResourceIdentifier taxCategory)	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.
CustomShippingDraftBuilder	taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.
CustomShippingDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the custom Shipping Method.
CustomShippingDraftBuilder	withDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)	Deliveries to be shipped with the custom Shipping Method.
CustomShippingDraftBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CustomShippingDraftBuilder	withShippingAddress(Function<BaseAddressBuilder,BaseAddress> builder)	Determines the shipping rate and Tax Rate of the associated Line Items.
CustomShippingDraftBuilder	withShippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraft> builder)	Determines the shipping price.
CustomShippingDraftBuilder	withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomShippingDraftBuilder

public CustomShippingDraftBuilder()

Method Details

key

public CustomShippingDraftBuilder key(String key)

User-defined unique identifier of the custom Shipping Method in the Cart with Multiple ShippingMode.

Parameters:

key - value to be set

Returns:

Builder

shippingMethodName

public CustomShippingDraftBuilder shippingMethodName(String shippingMethodName)

Name of the custom Shipping Method.

Parameters:

shippingMethodName - value to be set

Returns:

Builder

shippingAddress

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

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

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

withShippingAddress

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

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

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

shippingAddress

public CustomShippingDraftBuilder shippingAddress(@Nullable
 BaseAddress shippingAddress)

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

Parameters:

shippingAddress - value to be set

Returns:

Builder

shippingRate

public CustomShippingDraftBuilder shippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraftBuilder> builder)

Determines the shipping price.

Parameters:

builder - function to build the shippingRate value

Returns:

Builder

withShippingRate

public CustomShippingDraftBuilder withShippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraft> builder)

Determines the shipping price.

Parameters:

builder - function to build the shippingRate value

Returns:

Builder

shippingRate

public CustomShippingDraftBuilder shippingRate(ShippingRateDraft shippingRate)

Determines the shipping price.

Parameters:

shippingRate - value to be set

Returns:

Builder

shippingRateInput

public CustomShippingDraftBuilder 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 CustomShippingDraftBuilder 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

taxCategory

public CustomShippingDraftBuilder taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)

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

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

public CustomShippingDraftBuilder withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)

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

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public CustomShippingDraftBuilder taxCategory(@Nullable
 TaxCategoryResourceIdentifier taxCategory)

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

Parameters:

taxCategory - value to be set

Returns:

Builder

externalTaxRate

public CustomShippingDraftBuilder 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 CustomShippingDraftBuilder 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 CustomShippingDraftBuilder 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 CustomShippingDraftBuilder deliveries(@Nullable
 DeliveryDraft... deliveries)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

deliveries

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

Deliveries to be shipped with the custom Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

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

Deliveries to be shipped with the custom Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

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

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

withDeliveries

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

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

addDeliveries

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

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

setDeliveries

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

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

custom

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

Custom Fields for the custom Shipping Method.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the custom Shipping Method.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CustomShippingDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the custom Shipping Method.

Parameters:

custom - value to be set

Returns:

Builder

getKey

public String getKey()

User-defined unique identifier of the custom Shipping Method in the Cart with Multiple ShippingMode.

Returns:

key

getShippingMethodName

public String getShippingMethodName()

Name of the custom Shipping Method.

Returns:

shippingMethodName

getShippingAddress

@Nullable
public BaseAddress getShippingAddress()

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

Returns:

shippingAddress

getShippingRate

public ShippingRateDraft getShippingRate()

Determines the shipping price.

Returns:

shippingRate

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

getTaxCategory

@Nullable
public TaxCategoryResourceIdentifier getTaxCategory()

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

Returns:

taxCategory

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 custom Shipping Method.

Returns:

deliveries

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the custom Shipping Method.

Returns:

custom

build

public CustomShippingDraft build()

builds CustomShippingDraft with checking for non-null required values

Specified by:

build in interface Builder<CustomShippingDraft>

Returns:

CustomShippingDraft

buildUnchecked

public CustomShippingDraft buildUnchecked()

builds CustomShippingDraft without checking for non-null required values

Returns:

CustomShippingDraft

of

public static CustomShippingDraftBuilder of()

factory method for an instance of CustomShippingDraftBuilder

Returns:

builder

of

public static CustomShippingDraftBuilder of(CustomShippingDraft template)

create builder for CustomShippingDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder