io.sphere.sdk.cartdiscounts

Class MultiBuyCustomLineItemsTarget

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.cartdiscounts.MultiBuyCustomLineItemsTarget

All Implemented Interfaces:

CartDiscountTarget

public final class MultiBuyCustomLineItemsTarget
extends Base

The multi-buy discount represents a "Buy 4 items, get 2 of them at a discounted rate" type of discount. This discount target is very similar to MultiBuyLineItemsTarget but applied on custom line items instead of line items.

Method Summary

Modifier and Type	Method and Description
Long	getDiscountedQuantity() Quantity of line items that are discounted per application of this discount.
Long	getMaxOccurrence() Maximum number of applications of this discount.
String	getPredicate() A valid line item target predicate.
SelectionMode	getSelectionMode() The selection mode.
Long	getTriggerQuantity() Quantity of line items that need to be present in order to trigger an application of this discount.
static MultiBuyCustomLineItemsTarget	of(String predicate, Long triggerQuantity, Long discountedQuantity, SelectionMode selectionMode)
static MultiBuyCustomLineItemsTarget	of(String predicate, Long triggerQuantity, Long discountedQuantity, SelectionMode selectionMode, Long maxOccurrence)

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static MultiBuyCustomLineItemsTarget of(String predicate,
                                               Long triggerQuantity,
                                               Long discountedQuantity,
                                               SelectionMode selectionMode)

of

public static MultiBuyCustomLineItemsTarget of(String predicate,
                                               Long triggerQuantity,
                                               Long discountedQuantity,
                                               SelectionMode selectionMode,
                                               @Nullable
                                               Long maxOccurrence)

getPredicate

public String getPredicate()

A valid line item target predicate. The discount will be applied to line items that are matched by the predicate.

Returns:

the line item target predicate

getTriggerQuantity

public Long getTriggerQuantity()

Quantity of line items that need to be present in order to trigger an application of this discount.

Returns:

the quantity of line items to trigger the discount

getDiscountedQuantity

public Long getDiscountedQuantity()

Quantity of line items that are discounted per application of this discount.

Returns:

the quantity of line items to discount

getMaxOccurrence

@Nullable
public Long getMaxOccurrence()

Maximum number of applications of this discount.

Returns:

the maximum number of applications

getSelectionMode

public SelectionMode getSelectionMode()

The selection mode.

Returns:

the selection mode