Package com.commercetools.api.models.cart

Class CustomLineItemDraftBuilder

java.lang.Object

com.commercetools.api.models.cart.CustomLineItemDraftBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<CustomLineItemDraft>

public class CustomLineItemDraftBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<CustomLineItemDraft>

CustomLineItemDraftBuilder Example to create an instance using the builder pattern

     CustomLineItemDraft customLineItemDraft = CustomLineItemDraft.builder()
             .name(nameBuilder -> nameBuilder)
             .money(moneyBuilder -> moneyBuilder)
             .slug("{slug}")
             .priceMode(CustomLineItemPriceMode.STANDARD)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomLineItemDraftBuilder()

Method Summary

Modifier and Type	Method	Description
CustomLineItemDraft	build()	builds CustomLineItemDraft with checking for non-null required values
CustomLineItemDraft	buildUnchecked()	builds CustomLineItemDraft without checking for non-null required values
CustomLineItemDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Custom Line Item.
CustomLineItemDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Custom Line Item.
CustomLineItemDraftBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.
CustomLineItemDraftBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.
CustomFieldsDraft	getCustom()	Custom Fields for the Custom Line Item.
ExternalTaxRateDraft	getExternalTaxRate()	External Tax Rate for the Custom Line Item if the Cart has the 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.
CustomLineItemDraftBuilder	key(String key)	User-defined unique identifier of the Custom Line Item.
CustomLineItemDraftBuilder	money(Money money)	Money value of the Custom Line Item.
CustomLineItemDraftBuilder	money(Function<MoneyBuilder,MoneyBuilder> builder)	Money value of the Custom Line Item.
CustomLineItemDraftBuilder	name(LocalizedString name)	Name of the Custom Line Item.
CustomLineItemDraftBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Custom Line Item.
static CustomLineItemDraftBuilder	of()	factory method for an instance of CustomLineItemDraftBuilder
static CustomLineItemDraftBuilder	of(CustomLineItemDraft template)	create builder for CustomLineItemDraft instance
CustomLineItemDraftBuilder	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.
CustomLineItemDraftBuilder	quantity(Long quantity)	Number of Custom Line Items to add to the Cart.
CustomLineItemDraftBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Custom Line Item-specific addresses.
CustomLineItemDraftBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Custom Line Item-specific addresses.
CustomLineItemDraftBuilder	slug(String slug)	User-defined identifier used in a deep-link URL for the Custom Line Item.
CustomLineItemDraftBuilder	taxCategory(TaxCategoryResourceIdentifier taxCategory)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
CustomLineItemDraftBuilder	taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
CustomLineItemDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Custom Line Item.
CustomLineItemDraftBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.
CustomLineItemDraftBuilder	withMoney(Function<MoneyBuilder,Money> builder)	Money value of the Custom Line Item.
CustomLineItemDraftBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Custom Line Item.
CustomLineItemDraftBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Custom Line Item-specific addresses.
CustomLineItemDraftBuilder	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

CustomLineItemDraftBuilder

public CustomLineItemDraftBuilder()

Method Details

name

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

Name of the Custom Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the Custom Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public CustomLineItemDraftBuilder name(LocalizedString name)

Name of the Custom Line Item.

Parameters:

name - value to be set

Returns:

Builder

key

public CustomLineItemDraftBuilder key(@Nullable
 String key)

User-defined unique identifier of the Custom Line Item.

Parameters:

key - value to be set

Returns:

Builder

quantity

public CustomLineItemDraftBuilder quantity(@Nullable
 Long quantity)

Number of Custom Line Items to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

money

public CustomLineItemDraftBuilder 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 CustomLineItemDraftBuilder 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 CustomLineItemDraftBuilder money(Money money)

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

Parameters:

money - value to be set

Returns:

Builder

slug

public CustomLineItemDraftBuilder 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 CustomLineItemDraftBuilder taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)

Used to select a Tax Rate when a Cart has the Platform TaxMode. This field is required for Platform TaxMode.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

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

Used to select a Tax Rate when a Cart has the Platform TaxMode. This field is required for Platform TaxMode.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public CustomLineItemDraftBuilder taxCategory(@Nullable
 TaxCategoryResourceIdentifier taxCategory)

Used to select a Tax Rate when a Cart has the Platform TaxMode. This field is required for Platform TaxMode.

Parameters:

taxCategory - value to be set

Returns:

Builder

externalTaxRate

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

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

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

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public CustomLineItemDraftBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

Parameters:

externalTaxRate - value to be set

Returns:

Builder

custom

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

Custom Fields for the Custom Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Custom Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CustomLineItemDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Custom Line Item.

Parameters:

custom - value to be set

Returns:

Builder

shippingDetails

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

Container for Custom Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

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

Container for Custom Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public CustomLineItemDraftBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Custom Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

priceMode

public CustomLineItemDraftBuilder 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.

Parameters:

priceMode - value to be set

Returns:

Builder

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

getMoney

public Money getMoney()

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

Returns:

money

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. This field is required for Platform TaxMode.

Returns:

taxCategory

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

Returns:

externalTaxRate

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Custom Line Item.

Returns:

custom

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Custom Line Item-specific addresses.

Returns:

shippingDetails

getPriceMode

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 CustomLineItemDraft build()

builds CustomLineItemDraft with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<CustomLineItemDraft>

Returns:

CustomLineItemDraft

buildUnchecked

public CustomLineItemDraft buildUnchecked()

builds CustomLineItemDraft without checking for non-null required values

Returns:

CustomLineItemDraft

of

public static CustomLineItemDraftBuilder of()

factory method for an instance of CustomLineItemDraftBuilder

Returns:

builder

of

public static CustomLineItemDraftBuilder of(CustomLineItemDraft template)

create builder for CustomLineItemDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder