Package com.commercetools.api.models.order_edit

Class StagedOrderAddCustomLineItemActionBuilder

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderAddCustomLineItemActionBuilder

All Implemented Interfaces:

Builder<StagedOrderAddCustomLineItemAction>

public class StagedOrderAddCustomLineItemActionBuilder
extends Object
implements Builder<StagedOrderAddCustomLineItemAction>

StagedOrderAddCustomLineItemActionBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
StagedOrderAddCustomLineItemActionBuilder()

Method Summary

Modifier and Type	Method	Description
StagedOrderAddCustomLineItemAction	build()	builds StagedOrderAddCustomLineItemAction with checking for non-null required values
StagedOrderAddCustomLineItemAction	buildUnchecked()	builds StagedOrderAddCustomLineItemAction without checking for non-null required values
StagedOrderAddCustomLineItemActionBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	An external Tax Rate can be set if the Cart has the External TaxMode.
StagedOrderAddCustomLineItemActionBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	An external Tax Rate can be set if the Cart has the External TaxMode.
CustomFieldsDraft	getCustom()	Custom Fields for the Custom Line Item.
ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set 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, MultiBuyCustomLineItemsTarget, or CartDiscountPatternTarget 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.
CustomLineItemRecurrenceInfoDraft	getRecurrenceInfo()	Recurring Order and frequency data.
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.
StagedOrderAddCustomLineItemActionBuilder	key(String key)	User-defined unique identifier of the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	money(Money money)	Money value of the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	money(Function<MoneyBuilder,MoneyBuilder> builder)	Money value of the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	name(LocalizedString name)	Name of the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Custom Line Item.
static StagedOrderAddCustomLineItemActionBuilder	of()	factory method for an instance of StagedOrderAddCustomLineItemActionBuilder
static StagedOrderAddCustomLineItemActionBuilder	of(StagedOrderAddCustomLineItemAction template)	create builder for StagedOrderAddCustomLineItemAction instance
StagedOrderAddCustomLineItemActionBuilder	priceMode(CustomLineItemPriceMode priceMode)	If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget, MultiBuyCustomLineItemsTarget, or CartDiscountPatternTarget are applied to the Custom Line Item. If External, Cart Discounts are not considered on the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	quantity(Long quantity)	Number of Custom Line Items to add to the Cart.
StagedOrderAddCustomLineItemActionBuilder	recurrenceInfo(CustomLineItemRecurrenceInfoDraft recurrenceInfo)	Recurring Order and frequency data.
StagedOrderAddCustomLineItemActionBuilder	recurrenceInfo(Function<CustomLineItemRecurrenceInfoDraftBuilder,CustomLineItemRecurrenceInfoDraftBuilder> builder)	Recurring Order and frequency data.
StagedOrderAddCustomLineItemActionBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Custom Line Item-specific addresses.
StagedOrderAddCustomLineItemActionBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Custom Line Item-specific addresses.
StagedOrderAddCustomLineItemActionBuilder	slug(String slug)	User-defined identifier used in a deep-link URL for the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	taxCategory(TaxCategoryResourceIdentifier taxCategory)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
StagedOrderAddCustomLineItemActionBuilder	taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
StagedOrderAddCustomLineItemActionBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	An external Tax Rate can be set if the Cart has the External TaxMode.
StagedOrderAddCustomLineItemActionBuilder	withMoney(Function<MoneyBuilder,Money> builder)	Money value of the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Custom Line Item.
StagedOrderAddCustomLineItemActionBuilder	withRecurrenceInfo(Function<CustomLineItemRecurrenceInfoDraftBuilder,CustomLineItemRecurrenceInfoDraft> builder)	Recurring Order and frequency data.
StagedOrderAddCustomLineItemActionBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Custom Line Item-specific addresses.
StagedOrderAddCustomLineItemActionBuilder	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

StagedOrderAddCustomLineItemActionBuilder

public StagedOrderAddCustomLineItemActionBuilder()

Method Details

money

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

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

To set the money value in high precision, use HighPrecisionMoneyDraft.

Parameters:

builder - function to build the money value

Returns:

Builder

withMoney

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

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

To set the money value in high precision, use HighPrecisionMoneyDraft.

Parameters:

builder - function to build the money value

Returns:

Builder

money

public StagedOrderAddCustomLineItemActionBuilder money(Money money)

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

To set the money value in high precision, use HighPrecisionMoneyDraft.

Parameters:

money - value to be set

Returns:

Builder

name

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

Name of the Custom Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the Custom Line Item.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public StagedOrderAddCustomLineItemActionBuilder name(LocalizedString name)

Name of the Custom Line Item.

Parameters:

name - value to be set

Returns:

Builder

key

public StagedOrderAddCustomLineItemActionBuilder key(@Nullable
 String key)

User-defined unique identifier of the Custom Line Item.

Parameters:

key - value to be set

Returns:

Builder

quantity

public StagedOrderAddCustomLineItemActionBuilder quantity(@Nullable
 Long quantity)

Number of Custom Line Items to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

slug

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

shippingDetails

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

Container for Custom Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

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

Container for Custom Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public StagedOrderAddCustomLineItemActionBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Custom Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

priceMode

public StagedOrderAddCustomLineItemActionBuilder priceMode(@Nullable
 CustomLineItemPriceMode priceMode)

• If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget, MultiBuyCustomLineItemsTarget, or CartDiscountPatternTarget 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

custom

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

Custom Fields for the Custom Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Custom Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public StagedOrderAddCustomLineItemActionBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Custom Line Item.

Parameters:

custom - value to be set

Returns:

Builder

recurrenceInfo

public StagedOrderAddCustomLineItemActionBuilder recurrenceInfo(Function<CustomLineItemRecurrenceInfoDraftBuilder,CustomLineItemRecurrenceInfoDraftBuilder> builder)

Recurring Order and frequency data.

Parameters:

builder - function to build the recurrenceInfo value

Returns:

Builder

withRecurrenceInfo

public StagedOrderAddCustomLineItemActionBuilder withRecurrenceInfo(Function<CustomLineItemRecurrenceInfoDraftBuilder,CustomLineItemRecurrenceInfoDraft> builder)

Recurring Order and frequency data.

Parameters:

builder - function to build the recurrenceInfo value

Returns:

Builder

recurrenceInfo

public StagedOrderAddCustomLineItemActionBuilder recurrenceInfo(@Nullable
 CustomLineItemRecurrenceInfoDraft recurrenceInfo)

Recurring Order and frequency data.

Parameters:

recurrenceInfo - value to be set

Returns:

Builder

getMoney

public Money getMoney()

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

To set the money value in high precision, use HighPrecisionMoneyDraft.

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 the External TaxMode.

Returns:

externalTaxRate

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Custom Line Item-specific addresses.

Returns:

shippingDetails

getPriceMode

@Nullable
public CustomLineItemPriceMode getPriceMode()

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

Returns:

priceMode

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Custom Line Item.

Returns:

custom

getRecurrenceInfo

@Nullable
public CustomLineItemRecurrenceInfoDraft getRecurrenceInfo()

Recurring Order and frequency data.

Returns:

recurrenceInfo

build

public StagedOrderAddCustomLineItemAction build()

builds StagedOrderAddCustomLineItemAction with checking for non-null required values

Specified by:

build in interface Builder<StagedOrderAddCustomLineItemAction>

Returns:

StagedOrderAddCustomLineItemAction

buildUnchecked

public StagedOrderAddCustomLineItemAction buildUnchecked()

builds StagedOrderAddCustomLineItemAction without checking for non-null required values

Returns:

StagedOrderAddCustomLineItemAction

of

public static StagedOrderAddCustomLineItemActionBuilder of()

factory method for an instance of StagedOrderAddCustomLineItemActionBuilder

Returns:

builder

of

public static StagedOrderAddCustomLineItemActionBuilder of(StagedOrderAddCustomLineItemAction template)

create builder for StagedOrderAddCustomLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder