Package com.commercetools.api.models.order_edit

Interface StagedOrderAddCustomLineItemAction

All Superinterfaces:

CustomizableDraft<StagedOrderAddCustomLineItemAction>, ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderAddCustomLineItemActionImpl

public interface StagedOrderAddCustomLineItemAction
extends StagedOrderUpdateAction, CustomizableDraft<StagedOrderAddCustomLineItemAction>

StagedOrderAddCustomLineItemAction Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_CUSTOM_LINE_ITEM	discriminator value for StagedOrderAddCustomLineItemAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddCustomLineItemActionBuilder	builder()	builder factory method for StagedOrderAddCustomLineItemAction
static StagedOrderAddCustomLineItemActionBuilder	builder(StagedOrderAddCustomLineItemAction template)	create builder for StagedOrderAddCustomLineItemAction instance
static StagedOrderAddCustomLineItemAction	deepCopy(StagedOrderAddCustomLineItemAction template)	factory method to create a deep copy of StagedOrderAddCustomLineItemAction
@Valid CustomFieldsDraft	getCustom()	The representation used when creating or updating a customizable data type with Custom Fields.
@Valid ExternalTaxRateDraft	getExternalTaxRate()	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
String	getKey()	User-defined unique identifier of the Custom Line Item.
@NotNull @Valid Money	getMoney()	Draft type that stores amounts only in cent precision for the specified currency.
@NotNull @Valid LocalizedString	getName()	JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.
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()
@NotNull String	getSlug()
@Valid TaxCategoryResourceIdentifier	getTaxCategory()	ResourceIdentifier to a TaxCategory.
static StagedOrderAddCustomLineItemAction	of()	factory method
static StagedOrderAddCustomLineItemAction	of(StagedOrderAddCustomLineItemAction template)	factory method to create a shallow copy StagedOrderAddCustomLineItemAction
void	setCustom(CustomFieldsDraft custom)	The representation used when creating or updating a customizable data type with Custom Fields.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
void	setKey(String key)	User-defined unique identifier of the Custom Line Item.
void	setMoney(Money money)	Draft type that stores amounts only in cent precision for the specified currency.
void	setName(LocalizedString name)	JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.
void	setPriceMode(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.
void	setQuantity(Long quantity)	set quantity
void	setSlug(String slug)	set slug
void	setTaxCategory(TaxCategoryResourceIdentifier taxCategory)	ResourceIdentifier to a TaxCategory.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddCustomLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddCustomLineItemAction(Function<StagedOrderAddCustomLineItemAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.CustomizableDraft

unwrapCustomizableDraft

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

ADD_CUSTOM_LINE_ITEM

static final String ADD_CUSTOM_LINE_ITEM

discriminator value for StagedOrderAddCustomLineItemAction

See Also:

• Constant Field Values

Method Details

getMoney

@NotNull
@Valid
@NotNull @Valid Money getMoney()

Draft type that stores amounts only in cent precision for the specified currency.

Returns:

money

getName

@NotNull
@Valid
@NotNull @Valid LocalizedString getName()

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

Returns:

name

getKey

String getKey()

User-defined unique identifier of the Custom Line Item.

Returns:

key

getQuantity

Long getQuantity()

Returns:

quantity

getSlug

@NotNull
@NotNull String getSlug()

Returns:

slug

getTaxCategory

@Valid
@Valid TaxCategoryResourceIdentifier getTaxCategory()

ResourceIdentifier to a TaxCategory.

Returns:

taxCategory

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

The representation used when creating or updating a customizable data type with Custom Fields.

Specified by:

getCustom in interface CustomizableDraft<StagedOrderAddCustomLineItemAction>

Returns:

custom

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Returns:

externalTaxRate

getPriceMode

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

setMoney

void setMoney(Money money)

Draft type that stores amounts only in cent precision for the specified currency.

Parameters:

money - value to be set

setName

void setName(LocalizedString name)

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

Parameters:

name - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the Custom Line Item.

Parameters:

key - value to be set

setQuantity

void setQuantity(Long quantity)

set quantity

Parameters:

quantity - value to be set

setSlug

void setSlug(String slug)

set slug

Parameters:

slug - value to be set

setTaxCategory

void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

ResourceIdentifier to a TaxCategory.

Parameters:

taxCategory - value to be set

setCustom

void setCustom(CustomFieldsDraft custom)

The representation used when creating or updating a customizable data type with Custom Fields.

Specified by:

setCustom in interface CustomizableDraft<StagedOrderAddCustomLineItemAction>

Parameters:

custom - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Parameters:

externalTaxRate - value to be set

setPriceMode

void setPriceMode(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

of

static StagedOrderAddCustomLineItemAction of()

factory method

Returns:

instance of StagedOrderAddCustomLineItemAction

of

static StagedOrderAddCustomLineItemAction of(StagedOrderAddCustomLineItemAction template)

factory method to create a shallow copy StagedOrderAddCustomLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderAddCustomLineItemAction deepCopy(@Nullable
 StagedOrderAddCustomLineItemAction template)

factory method to create a deep copy of StagedOrderAddCustomLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddCustomLineItemActionBuilder builder()

builder factory method for StagedOrderAddCustomLineItemAction

Returns:

builder

builder

static StagedOrderAddCustomLineItemActionBuilder builder(StagedOrderAddCustomLineItemAction template)

create builder for StagedOrderAddCustomLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddCustomLineItemAction

default <T> T withStagedOrderAddCustomLineItemAction(Function<StagedOrderAddCustomLineItemAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddCustomLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference