Package com.commercetools.api.models.cart

Class CartAddCustomLineItemActionBuilder

java.lang.Object

com.commercetools.api.models.cart.CartAddCustomLineItemActionBuilder

All Implemented Interfaces:

Builder<CartAddCustomLineItemAction>

public class CartAddCustomLineItemActionBuilder
extends Object
implements Builder<CartAddCustomLineItemAction>

CartAddCustomLineItemActionBuilder Example to create an instance using the builder pattern

     CartAddCustomLineItemAction cartAddCustomLineItemAction = CartAddCustomLineItemAction.builder()
             .money(moneyBuilder -> moneyBuilder)
             .name(nameBuilder -> nameBuilder)
             .slug("{slug}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartAddCustomLineItemActionBuilder()

Method Summary

Modifier and Type	Method	Description
CartAddCustomLineItemAction	build()	builds CartAddCustomLineItemAction with checking for non-null required values
CartAddCustomLineItemAction	buildUnchecked()	builds CartAddCustomLineItemAction without checking for non-null required values
CartAddCustomLineItemActionBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Custom Line Item.
CartAddCustomLineItemActionBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Custom Line Item.
CartAddCustomLineItemActionBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	An external Tax Rate can be set if the Cart has External TaxMode.
CartAddCustomLineItemActionBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	An external Tax Rate can be set if the Cart has External TaxMode.
CustomFieldsDraft	getCustom()	Custom Fields for the Custom Line Item.
ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has External TaxMode.
String	getKey()	User-defined unique identifier of the Custom Line Item.
Money	getMoney()	Money value of the Custom Line Item.
LocalizedString	getName()	Name of the Custom Line Item.
CustomLineItemPriceMode	getPriceMode()	If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item. If External, Cart Discounts are not considered on the Custom Line Item.
Long	getQuantity()	Number of Custom Line Items to add to the Cart.
ItemShippingDetailsDraft	getShippingDetails()	Container for Custom Line Item-specific addresses.
String	getSlug()	User-defined identifier used in a deep-link URL for the Custom Line Item.
TaxCategoryResourceIdentifier	getTaxCategory()	Used to select a Tax Rate when a Cart has the Platform TaxMode.
CartAddCustomLineItemActionBuilder	key(String key)	User-defined unique identifier of the Custom Line Item.
CartAddCustomLineItemActionBuilder	money(Money money)	Money value of the Custom Line Item.
CartAddCustomLineItemActionBuilder	money(Function<MoneyBuilder,MoneyBuilder> builder)	Money value of the Custom Line Item.
CartAddCustomLineItemActionBuilder	name(LocalizedString name)	Name of the Custom Line Item.
CartAddCustomLineItemActionBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Custom Line Item.
static CartAddCustomLineItemActionBuilder	of()	factory method for an instance of CartAddCustomLineItemActionBuilder
static CartAddCustomLineItemActionBuilder	of(CartAddCustomLineItemAction template)	create builder for CartAddCustomLineItemAction instance
CartAddCustomLineItemActionBuilder	priceMode(CustomLineItemPriceMode priceMode)	If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item. If External, Cart Discounts are not considered on the Custom Line Item.
CartAddCustomLineItemActionBuilder	quantity(Long quantity)	Number of Custom Line Items to add to the Cart.
CartAddCustomLineItemActionBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Custom Line Item-specific addresses.
CartAddCustomLineItemActionBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Custom Line Item-specific addresses.
CartAddCustomLineItemActionBuilder	slug(String slug)	User-defined identifier used in a deep-link URL for the Custom Line Item.
CartAddCustomLineItemActionBuilder	taxCategory(TaxCategoryResourceIdentifier taxCategory)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
CartAddCustomLineItemActionBuilder	taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
CartAddCustomLineItemActionBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Custom Line Item.
CartAddCustomLineItemActionBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	An external Tax Rate can be set if the Cart has External TaxMode.
CartAddCustomLineItemActionBuilder	withMoney(Function<MoneyBuilder,Money> builder)	Money value of the Custom Line Item.
CartAddCustomLineItemActionBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Custom Line Item.
CartAddCustomLineItemActionBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Custom Line Item-specific addresses.
CartAddCustomLineItemActionBuilder	withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)	Used to select a Tax Rate when a Cart has the Platform TaxMode.

Methods inherited from class java.lang.Object

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

Constructor Details

CartAddCustomLineItemActionBuilder

public CartAddCustomLineItemActionBuilder()

Method Details

money

public CartAddCustomLineItemActionBuilder money(Function<MoneyBuilder,MoneyBuilder> builder)

Money value of the Custom Line Item. The value can be negative.

Parameters:

builder - function to build the money value

Returns:

Builder

withMoney

public CartAddCustomLineItemActionBuilder withMoney(Function<MoneyBuilder,Money> builder)

Money value of the Custom Line Item. The value can be negative.

Parameters:

builder - function to build the money value

Returns:

Builder

money

public CartAddCustomLineItemActionBuilder money(Money money)

Money value of the Custom Line Item. The value can be negative.

Parameters:

money - value to be set

Returns:

Builder

name

public CartAddCustomLineItemActionBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Name of the Custom Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

public CartAddCustomLineItemActionBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

Name of the Custom Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public CartAddCustomLineItemActionBuilder name(LocalizedString name)

Name of the Custom Line Item.

Parameters:

name - value to be set

Returns:

Builder

key

public CartAddCustomLineItemActionBuilder key(@Nullable
 String key)

User-defined unique identifier of the Custom Line Item.

Parameters:

key - value to be set

Returns:

Builder

quantity

public CartAddCustomLineItemActionBuilder quantity(@Nullable
 Long quantity)

Number of Custom Line Items to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

slug

public CartAddCustomLineItemActionBuilder slug(String slug)

User-defined identifier used in a deep-link URL for the Custom Line Item. It must match the pattern [a-zA-Z0-9_-]{2,256}.

Parameters:

slug - value to be set

Returns:

Builder

taxCategory

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

Used to select a Tax Rate when a Cart has the Platform TaxMode.

If TaxMode is Platform, this field must not be empty.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

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

Used to select a Tax Rate when a Cart has the Platform TaxMode.

If TaxMode is Platform, this field must not be empty.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public CartAddCustomLineItemActionBuilder taxCategory(@Nullable
 TaxCategoryResourceIdentifier taxCategory)

Used to select a Tax Rate when a Cart has the Platform TaxMode.

If TaxMode is Platform, this field must not be empty.

Parameters:

taxCategory - value to be set

Returns:

Builder

externalTaxRate

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

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

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

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

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

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public CartAddCustomLineItemActionBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

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

Parameters:

externalTaxRate - value to be set

Returns:

Builder

shippingDetails

public CartAddCustomLineItemActionBuilder shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)

Container for Custom Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

public CartAddCustomLineItemActionBuilder withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)

Container for Custom Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public CartAddCustomLineItemActionBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Custom Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

custom

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

Custom Fields for the Custom Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Custom Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CartAddCustomLineItemActionBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Custom Line Item.

Parameters:

custom - value to be set

Returns:

Builder

priceMode

public CartAddCustomLineItemActionBuilder priceMode(@Nullable
 CustomLineItemPriceMode priceMode)

• If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.
• If External, Cart Discounts are not considered on the Custom Line Item.

Parameters:

priceMode - value to be set

Returns:

Builder

getMoney

public Money getMoney()

Money value of the Custom Line Item. The value can be negative.

Returns:

money

getName

public LocalizedString getName()

Name of the Custom Line Item.

Returns:

name

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Custom Line Item.

Returns:

key

getQuantity

@Nullable
public Long getQuantity()

Number of Custom Line Items to add to the Cart.

Returns:

quantity

getSlug

public String getSlug()

User-defined identifier used in a deep-link URL for the Custom Line Item. It must match the pattern [a-zA-Z0-9_-]{2,256}.

Returns:

slug

getTaxCategory

@Nullable
public TaxCategoryResourceIdentifier getTaxCategory()

Used to select a Tax Rate when a Cart has the Platform TaxMode.

If TaxMode is Platform, this field must not be empty.

Returns:

taxCategory

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

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

Returns:

externalTaxRate

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Custom Line Item-specific addresses.

Returns:

shippingDetails

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Custom Line Item.

Returns:

custom

getPriceMode

@Nullable
public CustomLineItemPriceMode getPriceMode()

• If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.
• If External, Cart Discounts are not considered on the Custom Line Item.

Returns:

priceMode

build

public CartAddCustomLineItemAction build()

builds CartAddCustomLineItemAction with checking for non-null required values

Specified by:

build in interface Builder<CartAddCustomLineItemAction>

Returns:

CartAddCustomLineItemAction

buildUnchecked

public CartAddCustomLineItemAction buildUnchecked()

builds CartAddCustomLineItemAction without checking for non-null required values

Returns:

CartAddCustomLineItemAction

of

public static CartAddCustomLineItemActionBuilder of()

factory method for an instance of CartAddCustomLineItemActionBuilder

Returns:

builder

of

public static CartAddCustomLineItemActionBuilder of(CartAddCustomLineItemAction template)

create builder for CartAddCustomLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder