Package com.broadleafcommerce.promotion.offer.service.engine.candidate

Class DefaultCandidateOfferUtility

java.lang.Object

com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

All Implemented Interfaces:

CandidateOfferUtility

public class DefaultCandidateOfferUtility
extends Object
implements CandidateOfferUtility

Author:

Chad Harchar (charchar)

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.broadleafcommerce.common.extension.TypeFactory	offerFactory

Constructor Summary

Constructors

Constructor	Description
DefaultCandidateOfferUtility(com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Summary

Modifier and Type	Method	Description
CandidateFulfillmentGroupOffer	createCandidateFulfillmentGroupOffer(EnhancedOrder order, Offer offer)	Creates a CandidateFulfillmentGroupOffer for the given order and offer.
CandidateItemOffer	createCandidateFulfillmentItemOffer(EnhancedOrder order, Offer offer)	Creates a CandidateItemOffer for the given order and offer.
CandidateItemOffer	createCandidateOrderItemOffer(EnhancedOrder order, Offer offer)	Creates a CandidateItemOffer for the given order and offer.
CandidateOrderOffer	createCandidateOrderOffer(EnhancedOrder order, Offer offer)	Creates a CandidateOrderOffer for the given order and offer.
protected OfferServiceProperties	getOfferServiceProperties()
javax.money.MonetaryAmount	parseDynamicOfferAmount(String dynamicOfferKey, EnhancedOrder order)	Looks for a map of dynamicOfferKey to amount.
protected void	populateCandidateOfferCurrency(@NonNull BaseCandidateOffer candidateOffer, @NonNull EnhancedOrder order, @NonNull Offer offer)	Populates the BaseCandidateOffer.getCurrency() based on the given EnhancedOrder and Offer.
protected void	populateOfferRoundingProperties(BaseCandidateOffer candidateOffer)	Populates offer rounding properties for order and item typed offers.
void	setOfferServiceProperties(OfferServiceProperties offerServiceProperties)

Methods inherited from class java.lang.Object

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

Field Details

offerFactory

protected final com.broadleafcommerce.common.extension.TypeFactory offerFactory

Constructor Details

DefaultCandidateOfferUtility

public DefaultCandidateOfferUtility(com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Details

createCandidateOrderOffer

public CandidateOrderOffer createCandidateOrderOffer(EnhancedOrder order,
 Offer offer)

Description copied from interface: CandidateOfferUtility

Creates a CandidateOrderOffer for the given order and offer.

Specified by:

createCandidateOrderOffer in interface CandidateOfferUtility

Parameters:

order - the order to be used when building the CandidateOrderOffer

offer - the offer to be used when building the CandidateOrderOffer

Returns:

the created CandidateOrderOffer based on the provided order and offer

createCandidateOrderItemOffer

public CandidateItemOffer createCandidateOrderItemOffer(EnhancedOrder order,
 Offer offer)

Description copied from interface: CandidateOfferUtility

Creates a CandidateItemOffer for the given order and offer.

Specified by:

createCandidateOrderItemOffer in interface CandidateOfferUtility

Parameters:

order - the order to be used when building the CandidateItemOffer

offer - the offer to be used when building the CandidateItemOffer

Returns:

the created CandidateItemOffer based on the provided order and offer

createCandidateFulfillmentGroupOffer

public CandidateFulfillmentGroupOffer createCandidateFulfillmentGroupOffer(EnhancedOrder order,
 Offer offer)

Description copied from interface: CandidateOfferUtility

Creates a CandidateFulfillmentGroupOffer for the given order and offer.

Specified by:

createCandidateFulfillmentGroupOffer in interface CandidateOfferUtility

Parameters:

order - the order to be used when building the CandidateFulfillmentGroupOffer

offer - the offer to be used when building the CandidateFulfillmentGroupOffer

Returns:

the created CandidateFulfillmentGroupOffer based on the provided order and offer

createCandidateFulfillmentItemOffer

public CandidateItemOffer createCandidateFulfillmentItemOffer(EnhancedOrder order,
 Offer offer)

Description copied from interface: CandidateOfferUtility

Creates a CandidateItemOffer for the given order and offer.

Specified by:

createCandidateFulfillmentItemOffer in interface CandidateOfferUtility

Parameters:

order - the order to be used when building the CandidateItemOffer

offer - the offer to be used when building the CandidateItemOffer

Returns:

the created CandidateItemOffer based on the provided order and offer

parseDynamicOfferAmount

public javax.money.MonetaryAmount parseDynamicOfferAmount(String dynamicOfferKey,
 EnhancedOrder order)

Description copied from interface: CandidateOfferUtility

Looks for a map of dynamicOfferKey to amount.

Specified by:

parseDynamicOfferAmount in interface CandidateOfferUtility

Parameters:

dynamicOfferKey - the key for which to find dynamic offer amounts.

order - the order to search for dynamic offer amounts.

Returns:

the parsed MonetaryAmount

populateCandidateOfferCurrency

protected void populateCandidateOfferCurrency(@NonNull
 @NonNull BaseCandidateOffer candidateOffer,
 @NonNull
 @NonNull EnhancedOrder order,
 @NonNull
 @NonNull Offer offer)

Populates the BaseCandidateOffer.getCurrency() based on the given EnhancedOrder and Offer. If present, will also populate BaseCandidateOffer.getConvertedCurrencyDetail()

If Offer.getCurrency() is specified, then that currency is used. Otherwise EnhancedOrder.getCurrency() is used, as the offer should be a candidate regardless of currency.

Parameters:

candidateOffer - the BaseCandidateOffer to populate the currency for

order - the EnhancedOrder that has a currency

offer - the Offer that may have a currency specification

See Also:

• BaseCandidateOffer.updateMonetaryAmountCurrencyIfNeeded()

populateOfferRoundingProperties

protected void populateOfferRoundingProperties(BaseCandidateOffer candidateOffer)

Populates offer rounding properties for order and item typed offers.

Parameters:

candidateOffer - the BaseCandidateOffer to populate the offer rounding properties for

getOfferServiceProperties

protected OfferServiceProperties getOfferServiceProperties()

setOfferServiceProperties

@Autowired
public void setOfferServiceProperties(OfferServiceProperties offerServiceProperties)