org.broadleafcommerce.core.offer.service.discount.domain

Class PromotableCandidateItemOfferImpl

java.lang.Object

org.broadleafcommerce.core.offer.service.discount.domain.AbstractPromotionRounding

org.broadleafcommerce.core.offer.service.discount.domain.PromotableCandidateItemOfferImpl

All Implemented Interfaces:

Serializable, OfferHolder, PromotableCandidateItemOffer, PromotionRounding

public class PromotableCandidateItemOfferImpl
extends AbstractPromotionRounding
implements PromotableCandidateItemOffer, OfferHolder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<OfferItemCriteria,List<PromotableOrderItem>>	candidateQualifiersMap
protected HashMap<OfferItemCriteria,List<PromotableOrderItem>>	candidateTargetsMap
protected List<PromotableOrderItem>	legacyCandidateTargets
protected int	minimumTargetsRequired
protected Offer	offer
protected Money	originalPrice
protected Money	potentialSavings
protected Money	potentialSavingsQtyOne
protected PromotableOrder	promotableOrder
protected boolean	useQtyOnlyTierCalculation
protected int	uses
protected BigDecimal	weightedPercentSaved

Fields inherited from class org.broadleafcommerce.core.offer.service.discount.domain.AbstractPromotionRounding

roundingMode, roundingScale, roundOfferValues

Constructor Summary

Constructors

Constructor and Description
PromotableCandidateItemOfferImpl(PromotableOrder promotableOrder, Offer offer)
PromotableCandidateItemOfferImpl(PromotableOrder promotableOrder, Offer offer, boolean useQtyOnlyTierCalculation)

Method Summary

Modifier and Type	Method and Description
void	addUse()
int	calculateMaximumNumberOfUses() Determines the maximum number of times this promotion can be used based on the ItemCriteria and promotion's maxQty setting.
int	calculateMaxUsesForItemCriteria(OfferItemCriteria itemCriteria, Offer promotion) Determines the max number of times this itemCriteria might apply.
Money	calculateSavingsForOrderItem(PromotableOrderItem orderItem, int qtyToReceiveSavings) Public only for unit testing - not intended to be called
int	calculateTargetQuantityForTieredOffer() Returns the number of items that potentially could be targets for the offer.
HashMap<OfferItemCriteria,List<PromotableOrderItem>>	getCandidateQualifiersMap()
HashMap<OfferItemCriteria,List<PromotableOrderItem>>	getCandidateTargetsMap()
BroadleafCurrency	getCurrency()
List<PromotableOrderItem>	getLegacyCandidateTargets()
int	getMinimumRequiredTargetQuantity() If the offer has a minimum required number of targets, then the first time this offer is processed, return that number.
Offer	getOffer()
Money	getOriginalPrice()
Money	getPotentialSavings()
Money	getPotentialSavingsQtyOne()
int	getPriority()
int	getUses()
BigDecimal	getWeightedPercentSaved()
boolean	hasQualifyingItemCriteria()
boolean	isUseQtyOnlyTierCalculation() Returns whether to use quantity only tier calculation.
void	resetUses() Resets the uses for this candidate offer item.
void	setCandidateQualifiersMap(HashMap<OfferItemCriteria,List<PromotableOrderItem>> candidateItemsMap)
void	setCandidateTargetsMap(HashMap<OfferItemCriteria,List<PromotableOrderItem>> candidateItemsMap)
void	setLegacyCandidateTargets(List<PromotableOrderItem> candidateTargets)
void	setMinimumTargetsRequired(Integer minimumTargetsRequired)
void	setOriginalPrice(Money originalPrice)
void	setPotentialSavings(Money potentialSavings)
void	setPotentialSavingsQtyOne(Money potentialSavingsQtyOne)
void	setUseQtyOnlyTierCalculation(boolean useQtyOnlyTierCalculation) Sets whether to use quantity only tier calculation.
void	setWeightedPercentSaved(BigDecimal weightedPercentSaved)

Methods inherited from class org.broadleafcommerce.core.offer.service.discount.domain.AbstractPromotionRounding

getRoundingMode, getRoundingScale, isRoundOfferValues, setRoundingMode, setRoundingScale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

offer

protected Offer offer

promotableOrder

protected PromotableOrder promotableOrder

potentialSavings

protected Money potentialSavings

potentialSavingsQtyOne

protected Money potentialSavingsQtyOne

weightedPercentSaved

protected BigDecimal weightedPercentSaved

originalPrice

protected Money originalPrice

uses

protected int uses

useQtyOnlyTierCalculation

protected boolean useQtyOnlyTierCalculation

candidateQualifiersMap

protected HashMap<OfferItemCriteria,List<PromotableOrderItem>> candidateQualifiersMap

candidateTargetsMap

protected HashMap<OfferItemCriteria,List<PromotableOrderItem>> candidateTargetsMap

legacyCandidateTargets

protected List<PromotableOrderItem> legacyCandidateTargets

minimumTargetsRequired

protected int minimumTargetsRequired

Constructor Detail

PromotableCandidateItemOfferImpl

public PromotableCandidateItemOfferImpl(PromotableOrder promotableOrder,
                                        Offer offer)

PromotableCandidateItemOfferImpl

public PromotableCandidateItemOfferImpl(PromotableOrder promotableOrder,
                                        Offer offer,
                                        boolean useQtyOnlyTierCalculation)

Method Detail

getCurrency

public BroadleafCurrency getCurrency()

Specified by:

getCurrency in interface OfferHolder

calculateSavingsForOrderItem

public Money calculateSavingsForOrderItem(PromotableOrderItem orderItem,
                                          int qtyToReceiveSavings)

Description copied from interface: PromotableCandidateItemOffer

Public only for unit testing - not intended to be called

Specified by:

calculateSavingsForOrderItem in interface PromotableCandidateItemOffer

calculateTargetQuantityForTieredOffer

public int calculateTargetQuantityForTieredOffer()

Returns the number of items that potentially could be targets for the offer. Due to combination or bogo logic, they may not all get the tiered offer price.

Specified by:

calculateTargetQuantityForTieredOffer in interface PromotableCandidateItemOffer

Returns:

getPotentialSavings

public Money getPotentialSavings()

Specified by:

getPotentialSavings in interface PromotableCandidateItemOffer

setPotentialSavings

public void setPotentialSavings(Money potentialSavings)

Specified by:

setPotentialSavings in interface PromotableCandidateItemOffer

getPotentialSavingsQtyOne

public Money getPotentialSavingsQtyOne()

Specified by:

getPotentialSavingsQtyOne in interface PromotableCandidateItemOffer

setPotentialSavingsQtyOne

public void setPotentialSavingsQtyOne(Money potentialSavingsQtyOne)

Specified by:

setPotentialSavingsQtyOne in interface PromotableCandidateItemOffer

hasQualifyingItemCriteria

public boolean hasQualifyingItemCriteria()

Specified by:

hasQualifyingItemCriteria in interface PromotableCandidateItemOffer

calculateMaximumNumberOfUses

public int calculateMaximumNumberOfUses()

Determines the maximum number of times this promotion can be used based on the ItemCriteria and promotion's maxQty setting.

Specified by:

calculateMaximumNumberOfUses in interface PromotableCandidateItemOffer

calculateMaxUsesForItemCriteria

public int calculateMaxUsesForItemCriteria(OfferItemCriteria itemCriteria,
                                           Offer promotion)

Description copied from interface: PromotableCandidateItemOffer

Determines the max number of times this itemCriteria might apply. This calculation does not take into account other promotions. It is useful only to assist in prioritizing the order to process the promotions.

Specified by:

calculateMaxUsesForItemCriteria in interface PromotableCandidateItemOffer

Returns:

getCandidateQualifiersMap

public HashMap<OfferItemCriteria,List<PromotableOrderItem>> getCandidateQualifiersMap()

Specified by:

getCandidateQualifiersMap in interface PromotableCandidateItemOffer

setCandidateQualifiersMap

public void setCandidateQualifiersMap(HashMap<OfferItemCriteria,List<PromotableOrderItem>> candidateItemsMap)

Specified by:

setCandidateQualifiersMap in interface PromotableCandidateItemOffer

getCandidateTargetsMap

public HashMap<OfferItemCriteria,List<PromotableOrderItem>> getCandidateTargetsMap()

Specified by:

getCandidateTargetsMap in interface PromotableCandidateItemOffer

setCandidateTargetsMap

public void setCandidateTargetsMap(HashMap<OfferItemCriteria,List<PromotableOrderItem>> candidateItemsMap)

Specified by:

setCandidateTargetsMap in interface PromotableCandidateItemOffer

getPriority

public int getPriority()

Specified by:

getPriority in interface PromotableCandidateItemOffer

getOffer

public Offer getOffer()

Specified by:

getOffer in interface OfferHolder

Specified by:

getOffer in interface PromotableCandidateItemOffer

getUses

public int getUses()

Specified by:

getUses in interface PromotableCandidateItemOffer

addUse

public void addUse()

Specified by:

addUse in interface PromotableCandidateItemOffer

resetUses

public void resetUses()

Description copied from interface: PromotableCandidateItemOffer

Resets the uses for this candidate offer item. This is mainly used in the case where we want to calculate savings and then actually apply the promotion to an item. Both scenarios run through the same logic that add uses in order to determine if various quantities of items can be targeted for a particular promotion.

Specified by:

resetUses in interface PromotableCandidateItemOffer

See Also:

ItemOfferProcessor#applyAndCompareOrderAndItemOffers(PromotableOrder, List, List)}

getLegacyCandidateTargets

public List<PromotableOrderItem> getLegacyCandidateTargets()

Specified by:

getLegacyCandidateTargets in interface PromotableCandidateItemOffer

setLegacyCandidateTargets

public void setLegacyCandidateTargets(List<PromotableOrderItem> candidateTargets)

Specified by:

setLegacyCandidateTargets in interface PromotableCandidateItemOffer

getWeightedPercentSaved

public BigDecimal getWeightedPercentSaved()

Specified by:

getWeightedPercentSaved in interface PromotableCandidateItemOffer

setWeightedPercentSaved

public void setWeightedPercentSaved(BigDecimal weightedPercentSaved)

Specified by:

setWeightedPercentSaved in interface PromotableCandidateItemOffer

getOriginalPrice

public Money getOriginalPrice()

Specified by:

getOriginalPrice in interface PromotableCandidateItemOffer

setOriginalPrice

public void setOriginalPrice(Money originalPrice)

Specified by:

setOriginalPrice in interface PromotableCandidateItemOffer

setMinimumTargetsRequired

public void setMinimumTargetsRequired(Integer minimumTargetsRequired)

Specified by:

setMinimumTargetsRequired in interface PromotableCandidateItemOffer

See Also:

MiniumTargetsRequired

getMinimumRequiredTargetQuantity

public int getMinimumRequiredTargetQuantity()

If the offer has a minimum required number of targets, then the first time this offer is processed, return that number. On subsequent runs, return 1.

Specified by:

getMinimumRequiredTargetQuantity in interface PromotableCandidateItemOffer

Returns:

See Also:

MinimumTargetsRequired

isUseQtyOnlyTierCalculation

public boolean isUseQtyOnlyTierCalculation()

Description copied from interface: PromotableCandidateItemOffer

Returns whether to use quantity only tier calculation. If set to true, PromotableCandidateItemOffer.calculateTargetQuantityForTieredOffer() will use only the quantity in cart for determining which tier level to apply for a group of qualifying items. This mode is disabled by default. To turn it back on, use `use.quantity.only.tier.calculation=true` in your `common-shared.properties`. Otherwise, the default behavior is to factor in the number of iterations that the qualifying items have been applied.

Specified by:

isUseQtyOnlyTierCalculation in interface PromotableCandidateItemOffer

Returns:

See Also:

PromotableCandidateItemOffer#calculateTargetQuantityForTieredOffer()}

setUseQtyOnlyTierCalculation

public void setUseQtyOnlyTierCalculation(boolean useQtyOnlyTierCalculation)

Description copied from interface: PromotableCandidateItemOffer

Sets whether to use quantity only tier calculation. If set to true, PromotableCandidateItemOffer.calculateTargetQuantityForTieredOffer() will use only the quantity in cart for determining which tier level to apply for a group of qualifying items. This mode is disabled by default. To turn it back on, use `use.quantity.only.tier.calculation=true` in your `common-shared.properties`. Otherwise, the default behavior is to factor in the number of iterations that the qualifying items have been applied.

Specified by:

setUseQtyOnlyTierCalculation in interface PromotableCandidateItemOffer

See Also:

PromotableCandidateItemOffer#calculateTargetQuantityForTieredOffer()}