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

Interface CandidateOfferUtility

All Known Implementing Classes:

DefaultCandidateOfferUtility

public interface CandidateOfferUtility

Utility for creating each of the different CandidateXOffer types: CandidateOrderOffer, CandidateItemOffer, CandidateFulfillmentGroupOffer.

Author:

Chad Harchar (charchar)

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.
javax.money.MonetaryAmount	parseDynamicOfferAmount(String dynamicOfferKey, EnhancedOrder order)	Looks for a map of dynamicOfferKey to amount.

Method Details

createCandidateOrderOffer

CandidateOrderOffer createCandidateOrderOffer(EnhancedOrder order,
 Offer offer)

Creates a CandidateOrderOffer for the given order and offer.

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

CandidateItemOffer createCandidateOrderItemOffer(EnhancedOrder order,
 Offer offer)

Creates a CandidateItemOffer for the given order and offer.

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

CandidateFulfillmentGroupOffer createCandidateFulfillmentGroupOffer(EnhancedOrder order,
 Offer offer)

Creates a CandidateFulfillmentGroupOffer for the given order and offer.

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

CandidateItemOffer createCandidateFulfillmentItemOffer(EnhancedOrder order,
 Offer offer)

Creates a CandidateItemOffer for the given order and offer.

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

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

Looks for a map of dynamicOfferKey to amount.

Parameters:

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

order - the order to search for dynamic offer amounts.

Returns:

the parsed MonetaryAmount