Package com.commercetools.api.models.cart_discount

Interface MultiBuyCustomLineItemsTarget

All Superinterfaces:

CartDiscountTarget

All Known Implementing Classes:

MultiBuyCustomLineItemsTargetImpl

public interface MultiBuyCustomLineItemsTarget
extends CartDiscountTarget

This Discount target is similar to MultiBuyLineItems, but is applied on Custom Line Items instead of Line Items.

Example to create an instance using the builder pattern

     MultiBuyCustomLineItemsTarget multiBuyCustomLineItemsTarget = MultiBuyCustomLineItemsTarget.builder()
             .predicate("{predicate}")
             .triggerQuantity(1)
             .discountedQuantity(1)
             .selectionMode(SelectionMode.CHEAPEST)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MULTI_BUY_CUSTOM_LINE_ITEMS	discriminator value for MultiBuyCustomLineItemsTarget

Method Summary

Modifier and Type	Method	Description
static MultiBuyCustomLineItemsTargetBuilder	builder()	builder factory method for MultiBuyCustomLineItemsTarget
static MultiBuyCustomLineItemsTargetBuilder	builder(MultiBuyCustomLineItemsTarget template)	create builder for MultiBuyCustomLineItemsTarget instance
static MultiBuyCustomLineItemsTarget	deepCopy(MultiBuyCustomLineItemsTarget template)	factory method to create a deep copy of MultiBuyCustomLineItemsTarget
@NotNull Integer	getDiscountedQuantity()	Number of Custom Line Items that are discounted per application of this Discount.
Integer	getMaxOccurrence()	Maximum number of times this Discount can be applied.
@NotNull String	getPredicate()	Valid CustomLineItems target predicate.
@NotNull SelectionMode	getSelectionMode()	Discounts particular Line Items only according to the SelectionMode.
@NotNull Integer	getTriggerQuantity()	Number of Custom Line Items to be present in order to trigger an application of this Discount.
static MultiBuyCustomLineItemsTarget	of()	factory method
static MultiBuyCustomLineItemsTarget	of(MultiBuyCustomLineItemsTarget template)	factory method to create a shallow copy MultiBuyCustomLineItemsTarget
void	setDiscountedQuantity(Integer discountedQuantity)	Number of Custom Line Items that are discounted per application of this Discount.
void	setMaxOccurrence(Integer maxOccurrence)	Maximum number of times this Discount can be applied.
void	setPredicate(String predicate)	Valid CustomLineItems target predicate.
void	setSelectionMode(SelectionMode selectionMode)	Discounts particular Line Items only according to the SelectionMode.
void	setTriggerQuantity(Integer triggerQuantity)	Number of Custom Line Items to be present in order to trigger an application of this Discount.
static com.fasterxml.jackson.core.type.TypeReference<MultiBuyCustomLineItemsTarget>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMultiBuyCustomLineItemsTarget(Function<MultiBuyCustomLineItemsTarget,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart_discount.CartDiscountTarget

getType, withCartDiscountTarget

Field Details

MULTI_BUY_CUSTOM_LINE_ITEMS

static final String MULTI_BUY_CUSTOM_LINE_ITEMS

discriminator value for MultiBuyCustomLineItemsTarget

See Also:

• Constant Field Values

Method Details

getPredicate

@NotNull
@NotNull String getPredicate()

Valid CustomLineItems target predicate. The Discount will be applied to Custom Line Items that are matched by the predicate.

Returns:

predicate

getTriggerQuantity

@NotNull
@NotNull Integer getTriggerQuantity()

Number of Custom Line Items to be present in order to trigger an application of this Discount.

Returns:

triggerQuantity

getDiscountedQuantity

@NotNull
@NotNull Integer getDiscountedQuantity()

Number of Custom Line Items that are discounted per application of this Discount.

Returns:

discountedQuantity

getMaxOccurrence

Integer getMaxOccurrence()

Maximum number of times this Discount can be applied.

Returns:

maxOccurrence

getSelectionMode

@NotNull
@NotNull SelectionMode getSelectionMode()

Discounts particular Line Items only according to the SelectionMode.

Returns:

selectionMode

setPredicate

void setPredicate(String predicate)

Valid CustomLineItems target predicate. The Discount will be applied to Custom Line Items that are matched by the predicate.

Parameters:

predicate - value to be set

setTriggerQuantity

void setTriggerQuantity(Integer triggerQuantity)

Number of Custom Line Items to be present in order to trigger an application of this Discount.

Parameters:

triggerQuantity - value to be set

setDiscountedQuantity

void setDiscountedQuantity(Integer discountedQuantity)

Number of Custom Line Items that are discounted per application of this Discount.

Parameters:

discountedQuantity - value to be set

setMaxOccurrence

void setMaxOccurrence(Integer maxOccurrence)

Maximum number of times this Discount can be applied.

Parameters:

maxOccurrence - value to be set

setSelectionMode

void setSelectionMode(SelectionMode selectionMode)

Discounts particular Line Items only according to the SelectionMode.

Parameters:

selectionMode - value to be set

of

static MultiBuyCustomLineItemsTarget of()

factory method

Returns:

instance of MultiBuyCustomLineItemsTarget

of

static MultiBuyCustomLineItemsTarget of(MultiBuyCustomLineItemsTarget template)

factory method to create a shallow copy MultiBuyCustomLineItemsTarget

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MultiBuyCustomLineItemsTarget deepCopy(@Nullable
 MultiBuyCustomLineItemsTarget template)

factory method to create a deep copy of MultiBuyCustomLineItemsTarget

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MultiBuyCustomLineItemsTargetBuilder builder()

builder factory method for MultiBuyCustomLineItemsTarget

Returns:

builder

builder

static MultiBuyCustomLineItemsTargetBuilder builder(MultiBuyCustomLineItemsTarget template)

create builder for MultiBuyCustomLineItemsTarget instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMultiBuyCustomLineItemsTarget

default <T> T withMultiBuyCustomLineItemsTarget(Function<MultiBuyCustomLineItemsTarget,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<MultiBuyCustomLineItemsTarget> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference