java.lang.Object
- com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CandidateFulfillmentGroupOffer, CandidateItemOffer, CandidateOrderOffer
```
public class BaseCandidateOffer
extends Object
implements Serializable
```
Author:

Chad Harchar (charchar)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

BaseCandidateOffer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Set<String>`	`getCombinableOverrides()`	Convert offer data into easier structures for combinability algorithms
`javax.money.CurrencyUnit`	`getCurrency()`	The `EnhancedOrder.getCurrency()` order's currency code}.
`String`	`getDiscountMethodType()`	Convenience method to access this property to improve code readability
`String`	`getDiscountTargetType()`	Convenience method to access this property to improve code readability
`Set<String>`	`getNonCombinableOverrides()`
`Offer`	`getOffer()`	The candidate `Offer`.
`OfferCombinabilityCriteriaKey`	`getOfferCombinabilityCriteriaKey()`	Holds the combinability criteria for this offer.
`String`	`getOfferId()`	Convenience method to access this property to improve code readability
`javax.money.MonetaryAmount`	`getPotentialSavings()`	The total potential amount saved by applying this offer to its targets.
`RoundingMode`	`getRoundingMode()`	The `RoundingMode` to use when rounding.
`Set<String>`	`getStackableOverrides()`
`int`	`hashCode()`
`boolean`	`isRoundOfferValues()`	Determines whether to round `potentialSavings`.
`void`	`populateCombinabilityStructures(CandidateOffers candidateOffers)`
`protected void`	`populateCombinabilityStructuresUsedBySameTargetType(CandidateOffers candidateOffers)`
`void`	`setCombinableOverrides(Set<String> combinableOverrides)`	Convert offer data into easier structures for combinability algorithms
`void`	`setCurrency(javax.money.CurrencyUnit currency)`	The `EnhancedOrder.getCurrency()` order's currency code}.
`void`	`setNonCombinableOverrides(Set<String> nonCombinableOverrides)`
`void`	`setOffer(Offer offer)`	The candidate `Offer`.
`void`	`setOfferCombinabilityCriteriaKey(OfferCombinabilityCriteriaKey offerCombinabilityCriteriaKey)`	Holds the combinability criteria for this offer.
`void`	`setPotentialSavings(javax.money.MonetaryAmount potentialSavings)`	The total potential amount saved by applying this offer to its targets.
`void`	`setRoundingMode(RoundingMode roundingMode)`	The `RoundingMode` to use when rounding.
`void`	`setRoundOfferValues(boolean roundOfferValues)`	Determines whether to round `potentialSavings`.
`void`	`setStackableOverrides(Set<String> stackableOverrides)`
`String`	`toString()`
`void`	`updateOfferCombinabilityCriteria(CandidateOffers candidateOffers)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BaseCandidateOffer
```
public BaseCandidateOffer()
```
- Method Detail
  - populateCombinabilityStructures
```
public void populateCombinabilityStructures(CandidateOffers candidateOffers)
```
  - populateCombinabilityStructuresUsedBySameTargetType
```
protected void populateCombinabilityStructuresUsedBySameTargetType(CandidateOffers candidateOffers)
```
  - updateOfferCombinabilityCriteria
```
public void updateOfferCombinabilityCriteria(CandidateOffers candidateOffers)
```
  - getDiscountTargetType
```
public String getDiscountTargetType()
```
    Convenience method to access this property to improve code readability
  - getDiscountMethodType
```
public String getDiscountMethodType()
```
    Convenience method to access this property to improve code readability
  - getOfferId
```
public String getOfferId()
```
    Convenience method to access this property to improve code readability
  - getOffer
```
public Offer getOffer()
```
    The candidate Offer.
    
    Returns:
    
    The candidate Offer.
  - getPotentialSavings
```
public javax.money.MonetaryAmount getPotentialSavings()
```
    The total potential amount saved by applying this offer to its targets.
    
    Returns:
    
    The total potential amount saved by applying this offer to its targets.
  - getCurrency
```
public javax.money.CurrencyUnit getCurrency()
```
    The EnhancedOrder.getCurrency() order's currency code}.
    
    Returns:
    
    The EnhancedOrder.getCurrency() order's currency code}.
    
    See Also:
    
    EnhancedOrder.getCurrency()
  - isRoundOfferValues
```
public boolean isRoundOfferValues()
```
    Determines whether to round potentialSavings. Default is false. Note: This is only relevant for adjustments that apply to items. The additional precision is important when multiplying by a "qty". Order and fulfillment group adjustments will always be rounded in the default implementations.
    It is sometimes problematic to use DiscountMethodType.PERCENT_OFF offers with regards to rounding. For example, consider an item that costs $9.99 and has a 50% discount. To be precise, the offer value is 4.995, but this may be a strange value to display to the user depending on the currency being used. Keeping this false produces more accurate results when using quantities > 1. For example, 20% off of $9.99 with a quantity of 5 will produce a savings of exactly $9.99 which would be expected. The savings will always be rounded to the correct precision of the currency, however the S "totalSavings" will always be displays may want to round the value unit adjustment will be up to 5 digits of precision if roundOfferValues is false. Client displays may with to round the adjustment amount if showing per quantity level adjustments.
    
    Returns:
    
    whether to round potentialSavings.
  - getRoundingMode
```
public RoundingMode getRoundingMode()
```
    The RoundingMode to use when rounding. Default is RoundingMode.HALF_EVEN.
    
    Returns:
    
    The RoundingMode to use when rounding.
  - getOfferCombinabilityCriteriaKey
```
public OfferCombinabilityCriteriaKey getOfferCombinabilityCriteriaKey()
```
    Holds the combinability criteria for this offer. The offer domain contains combinability flags and rules but the criteria will vary with each execution of the offer engine. For example, if "item offer a" can be combined with any "order offer except b" and b is not in the scope of the current offer engine execution, then we can say that "item offer a" can be combined with ANY order offer. Practically, this allows us to reduce the overall complexity of offer engine by getting rid of scenarios that are irrelevant to the current execution.
  - getCombinableOverrides
```
public Set<String> getCombinableOverrides()
```
    Convert offer data into easier structures for combinability algorithms
  - getNonCombinableOverrides
```
public Set<String> getNonCombinableOverrides()
```
  - getStackableOverrides
```
public Set<String> getStackableOverrides()
```
  - setOffer
```
public void setOffer(Offer offer)
```
    The candidate Offer.
    
    Parameters:
    
    offer - The candidate Offer.
  - setPotentialSavings
```
public void setPotentialSavings(javax.money.MonetaryAmount potentialSavings)
```
    The total potential amount saved by applying this offer to its targets.
    
    Parameters:
    
    potentialSavings - The total potential amount saved by applying this offer to its targets.
  - setCurrency
```
public void setCurrency(javax.money.CurrencyUnit currency)
```
    The EnhancedOrder.getCurrency() order's currency code}.
    
    Parameters:
    
    currencyCode - The EnhancedOrder.getCurrency() order's currency code}.
    
    See Also:
    
    EnhancedOrder.getCurrency()
  - setRoundOfferValues
```
public void setRoundOfferValues(boolean roundOfferValues)
```
    Determines whether to round potentialSavings. Default is false. Note: This is only relevant for adjustments that apply to items. The additional precision is important when multiplying by a "qty". Order and fulfillment group adjustments will always be rounded in the default implementations.
    It is sometimes problematic to use DiscountMethodType.PERCENT_OFF offers with regards to rounding. For example, consider an item that costs $9.99 and has a 50% discount. To be precise, the offer value is 4.995, but this may be a strange value to display to the user depending on the currency being used. Keeping this false produces more accurate results when using quantities > 1. For example, 20% off of $9.99 with a quantity of 5 will produce a savings of exactly $9.99 which would be expected. The savings will always be rounded to the correct precision of the currency, however the S "totalSavings" will always be displays may want to round the value unit adjustment will be up to 5 digits of precision if roundOfferValues is false. Client displays may with to round the adjustment amount if showing per quantity level adjustments.
    
    Parameters:
    
    roundOfferValues - whether to round potentialSavings.
  - setRoundingMode
```
public void setRoundingMode(RoundingMode roundingMode)
```
    The RoundingMode to use when rounding. Default is RoundingMode.HALF_EVEN.
    
    Parameters:
    
    roundingMode - The RoundingMode to use when rounding.
  - setOfferCombinabilityCriteriaKey
```
public void setOfferCombinabilityCriteriaKey(OfferCombinabilityCriteriaKey offerCombinabilityCriteriaKey)
```
    Holds the combinability criteria for this offer. The offer domain contains combinability flags and rules but the criteria will vary with each execution of the offer engine. For example, if "item offer a" can be combined with any "order offer except b" and b is not in the scope of the current offer engine execution, then we can say that "item offer a" can be combined with ANY order offer. Practically, this allows us to reduce the overall complexity of offer engine by getting rid of scenarios that are irrelevant to the current execution.
  - setCombinableOverrides
```
public void setCombinableOverrides(Set<String> combinableOverrides)
```
    Convert offer data into easier structures for combinability algorithms
  - setNonCombinableOverrides
```
public void setNonCombinableOverrides(Set<String> nonCombinableOverrides)
```
  - setStackableOverrides
```
public void setStackableOverrides(Set<String> stackableOverrides)
```
  - 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

Class BaseCandidateOffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseCandidateOffer

Method Detail

populateCombinabilityStructures

populateCombinabilityStructuresUsedBySameTargetType

updateOfferCombinabilityCriteria

getDiscountTargetType

getDiscountMethodType

getOfferId

getOffer

getPotentialSavings

getCurrency

isRoundOfferValues

getRoundingMode

getOfferCombinabilityCriteriaKey

getCombinableOverrides

getNonCombinableOverrides

getStackableOverrides

setOffer

setPotentialSavings

setCurrency

setRoundOfferValues

setRoundingMode

setOfferCombinabilityCriteriaKey

setCombinableOverrides

setNonCombinableOverrides

setStackableOverrides

equals

canEqual

hashCode

toString