Package com.broadleafcommerce.promotion.offer.web.context.info

Class OfferQualifier

java.lang.Object

com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

All Implemented Interfaces:

Serializable

public class OfferQualifier
extends Object
implements Serializable

DTO containing information about the order items used by an Offer as item qualifiers. This includes the quantity used and and the Offer.getItemQualifierCriteria() an order item matched.

Author:

Nathan Moore (nathanmoore).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OfferQualifier()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected OfferQualifier	copy(com.broadleafcommerce.common.extension.TypeFactory offerFactory)	Creates a copy of this offer discount.
boolean	equals(Object o)
int	getFinalizedQuantity()	The actual item quantity of an EnhancedLineItem matched to the offer.
ItemCriteriaRule	getItemQualifierCriteria()	The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.
Offer	getOffer()	The Offer using some EnhancedLineItem as an item qualifier.
javax.money.MonetaryAmount	getPrice()	Tracks the discount amount of the related item qualifier.
int	getQuantity()	The potential item quantity of an EnhancedLineItem that matched the offer.
int	hashCode()
int	incrementQuantity(int incrementQuantity)	Increments the quantity by the given amount.
void	setFinalizedQuantity(int finalizedQuantity)	The actual item quantity of an EnhancedLineItem matched to the offer.
void	setItemQualifierCriteria(ItemCriteriaRule itemQualifierCriteria)	The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.
void	setOffer(Offer offer)	The Offer using some EnhancedLineItem as an item qualifier.
void	setPrice(javax.money.MonetaryAmount price)	Tracks the discount amount of the related item qualifier.
void	setQuantity(int quantity)	The potential item quantity of an EnhancedLineItem that matched the offer.
OfferQualifier	split(com.broadleafcommerce.common.extension.TypeFactory offerFactory, int splitItemQty)	Checks to see that the discount quantities match the target quantities.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OfferQualifier

public OfferQualifier()

Method Detail

incrementQuantity

public int incrementQuantity(int incrementQuantity)

Increments the quantity by the given amount.

Parameters:

incrementQuantity - amount by which to increment quantity

Returns:

the new quantity

split

@NonNull
public OfferQualifier split(@NonNull
                            com.broadleafcommerce.common.extension.TypeFactory offerFactory,
                            int splitItemQty)

Checks to see that the discount quantities match the target quantities. If not, splits this item into two.

Returns:

the item created by splitting

copy

protected OfferQualifier copy(com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Creates a copy of this offer discount.

Parameters:

offerFactory - the TypeFactory required to create a new instance

Returns:

the copied instance

getOffer

public Offer getOffer()

The Offer using some EnhancedLineItem as an item qualifier.

Returns:

The Offer using some EnhancedLineItem as an item qualifier.

getItemQualifierCriteria

public ItemCriteriaRule getItemQualifierCriteria()

The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.

Returns:

The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.

getQuantity

public int getQuantity()

The potential item quantity of an EnhancedLineItem that matched the offer.

Returns:

The potential item quantity of an EnhancedLineItem that matched the offer.

getFinalizedQuantity

public int getFinalizedQuantity()

The actual item quantity of an EnhancedLineItem matched to the offer.

Returns:

The actual item quantity of an EnhancedLineItem matched to the offer.

getPrice

public javax.money.MonetaryAmount getPrice()

Tracks the discount amount of the related item qualifier. The discount amount will be 0 if this item was only used as a qualifier.

setOffer

public void setOffer(Offer offer)

The Offer using some EnhancedLineItem as an item qualifier.

Parameters:

offer - The Offer using some EnhancedLineItem as an item qualifier.

setItemQualifierCriteria

public void setItemQualifierCriteria(ItemCriteriaRule itemQualifierCriteria)

The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.

Parameters:

itemQualifierCriteria - The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.

setQuantity

public void setQuantity(int quantity)

The potential item quantity of an EnhancedLineItem that matched the offer.

Parameters:

quantity - The potential item quantity of an EnhancedLineItem that matched the offer.

setFinalizedQuantity

public void setFinalizedQuantity(int finalizedQuantity)

The actual item quantity of an EnhancedLineItem matched to the offer.

Parameters:

quantity - The actual item quantity of an EnhancedLineItem matched to the offer.

setPrice

public void setPrice(javax.money.MonetaryAmount price)

Tracks the discount amount of the related item qualifier. The discount amount will be 0 if this item was only used as a qualifier.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object