Package com.broadleafcommerce.promotion.offer.service.dto

Class CandidateItemOffer

java.lang.Object

com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

All Implemented Interfaces:

Serializable

public class CandidateItemOffer
extends BaseCandidateOffer

DTO containing information necessary for determining if an Offer that can apply to an EnhancedLineItem is part of the best permutation of all offers applicable to that line item. This works for OrderLineItems and FulfillmentLineItems.

Author:

Nathan Moore (nathanmoore).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CandidateItemOffer()

Method Summary

Modifier and Type	Method	Description
BigDecimal	calculateTargetAmountForTieredOffer()
int	calculateTargetQuantityForTieredOffer()	Determines the number of target order items that can be used when determining which discount tier to use in discounts.
protected boolean	canEqual(Object other)
void	clearState()
boolean	equals(Object o)
Map<ItemCriteriaRule,Collection<EnhancedLineItem>>	getCandidateQualifiersMap()	Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.
Map<ItemCriteriaRule,Collection<EnhancedLineItem>>	getCandidateTargetsMap()	Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.
Map<LineItemOfferDetail,OfferDiscount>	getMaxSavingsDiscounts()	Keep track of the current iteration targets so that the estimated discount can be calculated.
Map<LineItemOfferDetail,OfferQualifier>	getMaxSavingsQualifiers()
Optional<javax.money.MonetaryAmount>	getMaxSavingsRemainderAmount()	Represents the remainder of max savings per order that can be applied to qualifying items.
BigDecimal	getOriginalPrice()	The original, unadjusted price of the item being targeted by BaseCandidateOffer.getOffer().
javax.money.MonetaryAmount	getPotentialSavingsQtyOne()	Potential savings per single use of BaseCandidateOffer.getOffer().
String	getPromotionUsageId()	The id of each individual usage of this promotion instance.
int	getUses()	Tracks the number of times this candidate offer has been used.
BigDecimal	getWeightedPercentSaved()	Takes the BaseCandidateOffer.getPotentialSavings() and divides them by the item's price before multiply by 100 to get a percentage.
int	hashCode()
void	incrementUses()
boolean	isMaxSavingsCheckRequired()
boolean	isUseAmountOnlyTierCalculation()
boolean	isUseQtyOnlyTierCalculation()	Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.
void	resetUses()	Deprecated.
void	setCandidateQualifiersMap(Map<ItemCriteriaRule,Collection<EnhancedLineItem>> candidateQualifiersMap)	Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.
void	setCandidateTargetsMap(Map<ItemCriteriaRule,Collection<EnhancedLineItem>> candidateTargetsMap)	Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.
void	setMaxSavingsCheckRequired(boolean maxSavingsCheckRequired)
void	setMaxSavingsDiscounts(Map<LineItemOfferDetail,OfferDiscount> maxSavingsDiscounts)	Keep track of the current iteration targets so that the estimated discount can be calculated.
void	setMaxSavingsQualifiers(Map<LineItemOfferDetail,OfferQualifier> maxSavingsQualifiers)
void	setMaxSavingsRemainderAmount(Optional<javax.money.MonetaryAmount> maxSavingsRemainderAmount)	Represents the remainder of max savings per order that can be applied to qualifying items.
void	setOriginalPrice(BigDecimal originalPrice)	The original, unadjusted price of the item being targeted by BaseCandidateOffer.getOffer().
void	setOrUpdatePromotionUsageId(String promotionUsageBaseId)
void	setPotentialSavingsQtyOne(javax.money.MonetaryAmount potentialSavingsQtyOne)	Potential savings per single use of BaseCandidateOffer.getOffer().
void	setPromotionUsageId(String promotionUsageId)	The id of each individual usage of this promotion instance.
void	setUseAmountOnlyTierCalculation(boolean useAmountOnlyTierCalculation)
void	setUseQtyOnlyTierCalculation(boolean useQtyOnlyTierCalculation)	Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.
void	setUses(int uses)	Tracks the number of times this candidate offer has been used.
void	setWeightedPercentSaved(BigDecimal weightedPercentSaved)	Takes the BaseCandidateOffer.getPotentialSavings() and divides them by the item's price before multiply by 100 to get a percentage.
int	targetQtyRequired(EnhancedOrder order)
String	toString()

Methods inherited from class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

calculateOverrideSegment, excludeDiscountedItemsFromTotal, getAllValidSegments, getCombinableOverrides, getCurrency, getDiscountAmount, getDiscountMethodType, getDiscountTargetType, getExcludedItemIds, getNonCombinableOverrides, getOffer, getOfferCodesMap, getOfferCombinabilityCriteriaKey, getOfferDtosMap, getOfferId, getOverrideOfferId, getPotentialSavings, getRoundingMode, getSegment, getStackableOverrides, initializeExcludedCartItemIds, isApplicableToDependentItems, isNotExcludedFromOffer, isRoundOfferValues, normalizeSegment, populateCombinabilityStructures, populateCombinabilityStructuresUsedBySameTargetType, populatePropertiesFromCodeData, segmentIsValid, setCombinableOverrides, setCurrency, setExcludedItemIds, setNonCombinableOverrides, setOffer, setOfferCodesMap, setOfferCombinabilityCriteriaKey, setOfferDtosMap, setOverrideOfferId, setPotentialSavings, setRoundingMode, setRoundOfferValues, setSegment, setStackableOverrides, updateAmountCurrency, updateMonetaryAmountCurrencyIfNeeded, updateOfferCombinabilityCriteria, validateCodesMatchOfferSegments

Methods inherited from class java.lang.Object

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

Constructor Details

CandidateItemOffer

public CandidateItemOffer()

Method Details

incrementUses

public void incrementUses()

setOrUpdatePromotionUsageId

public void setOrUpdatePromotionUsageId(String promotionUsageBaseId)

calculateTargetQuantityForTieredOffer

public int calculateTargetQuantityForTieredOffer()

Determines the number of target order items that can be used when determining which discount tier to use in discounts.

Returns:

the number of target items applicable for tier calculations.

resetUses

@Deprecated
public void resetUses()

Deprecated.

clearState

public void clearState()

calculateTargetAmountForTieredOffer

public BigDecimal calculateTargetAmountForTieredOffer()

Returns:

The monetary amount of the items that qualify for this amount based tier offer.

targetQtyRequired

public int targetQtyRequired(EnhancedOrder order)

getCandidateQualifiersMap

public Map<ItemCriteriaRule,Collection<EnhancedLineItem>> getCandidateQualifiersMap()

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

Returns:

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

getCandidateTargetsMap

public Map<ItemCriteriaRule,Collection<EnhancedLineItem>> getCandidateTargetsMap()

Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.

Returns:

Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.

getPotentialSavingsQtyOne

public javax.money.MonetaryAmount getPotentialSavingsQtyOne()

Potential savings per single use of BaseCandidateOffer.getOffer(). Takes BaseCandidateOffer.getPotentialSavings() and divides it by uses. Used in weighting the potential savings to determine the best permutation of all applicable offers.

Returns:

Potential savings per single use of BaseCandidateOffer.getOffer()

getWeightedPercentSaved

public BigDecimal getWeightedPercentSaved()

Takes the BaseCandidateOffer.getPotentialSavings() and divides them by the item's price before multiply by 100 to get a percentage. Sometimes a more complex weighting algorithm is used such as when an offer has qualifiers that cannot be used by other offers.

Returns:

weighted percentage of an item's price that is discounted by using BaseCandidateOffer.getOffer().

getOriginalPrice

public BigDecimal getOriginalPrice()

The original, unadjusted price of the item being targeted by BaseCandidateOffer.getOffer().

getUses

public int getUses()

Tracks the number of times this candidate offer has been used. This is used while determining potential savings and the best permutation of applicable offers where we don't want to create an OfferAuditDetail because we're calculating potential rather than actually usages.

Returns:

the number of times this candidate offer has been used

isUseQtyOnlyTierCalculation

public boolean isUseQtyOnlyTierCalculation()

Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.

Consider the following offer:

• Has 2 tiers:
  • 1st tier min quantity: 1
  • 2nd tier: 5
• An order must meet the following target item criteria
  • Has 3 items in the "Hot Sauces" category
  • and 1 item in the "Merchandise" category

When useQtyOnlyTierCalculation = true, the 2nd tier would apply if the order had 3 hot sauces, 1 t-shirt, and at least 1 of an item in any category. When it's false, then the order must have 5 sets of 3 hot sauces and 1 t-shirt, that is, 15 hot sauces and 5 t-shirts to match this offer.

By default this behavior can be configured globally using broadleaf.offer.useQuantityOnlyTierCalculation

Returns:

whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.

isUseAmountOnlyTierCalculation

public boolean isUseAmountOnlyTierCalculation()

Returns:

Use amount only tier calculation

See Also:

• Offer#useAmountOnlyTierCalculation

isMaxSavingsCheckRequired

public boolean isMaxSavingsCheckRequired()

Returns:

true if max Savings check is required

See Also:

• DefaultPotentialSavingsCalculator.finalizePotentialSavingsOnOffer(com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer, com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings)

getMaxSavingsRemainderAmount

public Optional<javax.money.MonetaryAmount> getMaxSavingsRemainderAmount()

Represents the remainder of max savings per order that can be applied to qualifying items. Occurs when the max savings threshold is reached such that a given item can not receive the full item discount and instead qualifies for only a part of the discount due to the max threshold calculation.

getMaxSavingsDiscounts

public Map<LineItemOfferDetail,OfferDiscount> getMaxSavingsDiscounts()

Keep track of the current iteration targets so that the estimated discount can be calculated. This structure is solely for assisting with the maxSavingsPerOrder calculation

getMaxSavingsQualifiers

public Map<LineItemOfferDetail,OfferQualifier> getMaxSavingsQualifiers()

getPromotionUsageId

public String getPromotionUsageId()

The id of each individual usage of this promotion instance.

setCandidateQualifiersMap

public void setCandidateQualifiersMap(Map<ItemCriteriaRule,Collection<EnhancedLineItem>> candidateQualifiersMap)

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

Parameters:

candidateQualifiersMap - Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

setCandidateTargetsMap

public void setCandidateTargetsMap(Map<ItemCriteriaRule,Collection<EnhancedLineItem>> candidateTargetsMap)

Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.

Parameters:

candidateTargetsMap - Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.

setPotentialSavingsQtyOne

public void setPotentialSavingsQtyOne(javax.money.MonetaryAmount potentialSavingsQtyOne)

Potential savings per single use of BaseCandidateOffer.getOffer(). Takes BaseCandidateOffer.getPotentialSavings() and divides it by uses. Used in weighting the potential savings to determine the best permutation of all applicable offers.

Parameters:

potentialSavingsQtyOne - Potential savings per single use of BaseCandidateOffer.getOffer()

setWeightedPercentSaved

public void setWeightedPercentSaved(BigDecimal weightedPercentSaved)

Takes the BaseCandidateOffer.getPotentialSavings() and divides them by the item's price before multiply by 100 to get a percentage. Sometimes a more complex weighting algorithm is used such as when an offer has qualifiers that cannot be used by other offers.

Parameters:

weightedPercentSaved - weighted percentage of an item's price that is discounted by using BaseCandidateOffer.getOffer().

setOriginalPrice

public void setOriginalPrice(BigDecimal originalPrice)

The original, unadjusted price of the item being targeted by BaseCandidateOffer.getOffer().

setUses

public void setUses(int uses)

Tracks the number of times this candidate offer has been used. This is used while determining potential savings and the best permutation of applicable offers where we don't want to create an OfferAuditDetail because we're calculating potential rather than actually usages.

Parameters:

uses - the number of times this candidate offer has been used

setUseQtyOnlyTierCalculation

public void setUseQtyOnlyTierCalculation(boolean useQtyOnlyTierCalculation)

Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.

Consider the following offer:

• Has 2 tiers:
  • 1st tier min quantity: 1
  • 2nd tier: 5
• An order must meet the following target item criteria
  • Has 3 items in the "Hot Sauces" category
  • and 1 item in the "Merchandise" category

When useQtyOnlyTierCalculation = true, the 2nd tier would apply if the order had 3 hot sauces, 1 t-shirt, and at least 1 of an item in any category. When it's false, then the order must have 5 sets of 3 hot sauces and 1 t-shirt, that is, 15 hot sauces and 5 t-shirts to match this offer.

By default this behavior can be configured globally using broadleaf.offer.useQuantityOnlyTierCalculation

Parameters:

useQtyOnlyTierCalculation - whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.

setUseAmountOnlyTierCalculation

public void setUseAmountOnlyTierCalculation(boolean useAmountOnlyTierCalculation)

Parameters:

useAmountOnlyTierCalculation - Use amount only tier calculation

See Also:

• Offer#useAmountOnlyTierCalculation

setMaxSavingsCheckRequired

public void setMaxSavingsCheckRequired(boolean maxSavingsCheckRequired)

Parameters:

maxSavingsCheckRequired - True if the offer requires a max savings check

See Also:

• DefaultPotentialSavingsCalculator.finalizePotentialSavingsOnOffer(com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer, com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings)

setMaxSavingsRemainderAmount

public void setMaxSavingsRemainderAmount(Optional<javax.money.MonetaryAmount> maxSavingsRemainderAmount)

Represents the remainder of max savings per order that can be applied to qualifying items. Occurs when the max savings threshold is reached such that a given item can not receive the full item discount and instead qualifies for only a part of the discount due to the max threshold calculation.

setMaxSavingsDiscounts

public void setMaxSavingsDiscounts(Map<LineItemOfferDetail,OfferDiscount> maxSavingsDiscounts)

Keep track of the current iteration targets so that the estimated discount can be calculated. This structure is solely for assisting with the maxSavingsPerOrder calculation

setMaxSavingsQualifiers

public void setMaxSavingsQualifiers(Map<LineItemOfferDetail,OfferQualifier> maxSavingsQualifiers)

setPromotionUsageId

public void setPromotionUsageId(String promotionUsageId)

The id of each individual usage of this promotion instance.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseCandidateOffer

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseCandidateOffer

hashCode

public int hashCode()

Overrides:

hashCode in class BaseCandidateOffer

toString

public String toString()

Overrides:

toString in class BaseCandidateOffer