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

Class CandidateOrderOffer

java.lang.Object

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

com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

All Implemented Interfaces:

Serializable, Comparable<CandidateOrderOffer>

public class CandidateOrderOffer
extends BaseCandidateOffer
implements Comparable<CandidateOrderOffer>

DTO containing information necessary for determining if an Offer that can apply to an EnhancedOrder is part of the best permutation of all offers applicable to that order.

Author:

Nathan Moore (nathanmoore).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final BigDecimal	ONE_HUNDRED

Constructor Summary

Constructors

Constructor	Description
CandidateOrderOffer()

Method Summary

Modifier and Type	Method	Description
void	calculatePotentialSavings()
protected boolean	canEqual(Object other)
int	compareTo(CandidateOrderOffer p2)
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.
EnhancedOrder	getOrder()	The order being targeted by BaseCandidateOffer.getOffer() }.
int	hashCode()
boolean	isRoundDiscountsByItem()	Whether to round the offer discounts at the item level instead of the order level.
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	setOrder(EnhancedOrder order)	The order being targeted by BaseCandidateOffer.getOffer() }.
void	setRoundDiscountsByItem(boolean roundDiscountsByItem)	Whether to round the offer discounts at the item level instead of the order level.
String	toString()
String	toStringWithoutOrder()	Alternate implementation of toString that does not include the order to be used by OrderOfferAdjustment in order to avoid infinite loop just from that context.

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

Field Details

ONE_HUNDRED

public static final BigDecimal ONE_HUNDRED

Constructor Details

CandidateOrderOffer

public CandidateOrderOffer()

Method Details

calculatePotentialSavings

public void calculatePotentialSavings()

compareTo

public int compareTo(@NonNull
 CandidateOrderOffer p2)

Specified by:

compareTo in interface Comparable<CandidateOrderOffer>

toStringWithoutOrder

public String toStringWithoutOrder()

Alternate implementation of toString that does not include the order to be used by OrderOfferAdjustment in order to avoid infinite loop just from that context.

getOrder

public EnhancedOrder getOrder()

The order being targeted by BaseCandidateOffer.getOffer() }.

Returns:

The order being targeted by BaseCandidateOffer.getOffer().

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.

isRoundDiscountsByItem

public boolean isRoundDiscountsByItem()

Whether to round the offer discounts at the item level instead of the order level.

setOrder

public void setOrder(EnhancedOrder order)

The order being targeted by BaseCandidateOffer.getOffer() }.

Parameters:

order - The order being targeted by BaseCandidateOffer.getOffer().

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.

setRoundDiscountsByItem

public void setRoundDiscountsByItem(boolean roundDiscountsByItem)

Whether to round the offer discounts at the item level instead of the order level.

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