com.elasticpath.xpf.connectivity.extensionpoint

Interface PromotionsCalculator

All Superinterfaces:

org.pf4j.ExtensionPoint

public interface PromotionsCalculator
extends org.pf4j.ExtensionPoint

Promotion calculator extension point.

Method Summary

Modifier and Type	Method and Description
default void	createCouponsForPromotions(XPFPromotionCalculatorCouponCreationContext context) Deprecated. implement triggerActionsAtCheckout(XPFPromotionCalculatorTriggerActionsAtCheckoutContext context) instead
void	disableCouponAutoApply(XPFPromotionCalculatorDisableCouponContext context) Change the behaviour of the specified coupons so that shopper-specific coupons don't automatically apply to future shopper's carts.
XPFPromotionsCalculatorOutputContext	evaluate(XPFCartPromotionsCalculatorInputContext context) Evaluate promotions for cart promotion calculator input context.
XPFPromotionsCalculatorOutputContext	evaluate(XPFCatalogPromotionsCalculatorInputContext context) Evaluate promotions for catalog promotion calculator input context.
Set<String>	retrieveCouponCodesByCustomerAndStore(XPFPromotionCalculatorCouponStoreEmailRetrievalContext context) Get applicable coupon codes for given store and customer email.
Map<String,Collection<XPFCoupon>>	retrieveCouponsByCodes(XPFPromotionCalculatorCouponCodeRetrievalContext context) Retrieve coupons by coupon codes.
Map<String,XPFCoupon>	retrieveCouponsByGuids(XPFPromotionCalculatorCouponGuidRetrievalContext context) Retrieve coupons by GUIDs.
Set<XPFPromotionRule>	retrievePromotionCarrots(XPFPromotionCarrotsInputContext context) Deprecated. implement retrievePromotionCarrots(com.elasticpath.xpf.connectivity.context.XPFPromotionCarrotsInputContext context) instead
default Set<XPFPromotionRule>	retrievePromotionCarrots(XPFPromotionCarrotsInputContext context) Retrieve promotion carrots.
Map<String,XPFPromotionRule>	retrievePromotionRules(XPFPromotionsCalculatorRuleRetrievalContext context) Retrieve promotion rules.
default void	triggerActionsAtCheckout(XPFPromotionCalculatorTriggerActionsAtCheckoutContext context) Trigger promotion-related actions that need to be executed at checkout time for the promotions provided in the context.
Map<String,XPFPromotionCouponValidationOutputContext>	validateCouponRuleAndUsage(XPFPromotionCalculatorCouponValidationContext context) Determine if the specified coupon codes are valid.

Method Detail

evaluate

XPFPromotionsCalculatorOutputContext evaluate(XPFCatalogPromotionsCalculatorInputContext context)

Evaluate promotions for catalog promotion calculator input context.

Parameters:

context - the context

Returns:

the promotion calculator output context

evaluate

XPFPromotionsCalculatorOutputContext evaluate(XPFCartPromotionsCalculatorInputContext context)

Evaluate promotions for cart promotion calculator input context.

Parameters:

context - the context

Returns:

the promotion calculator output context

retrievePromotionRules

Map<String,XPFPromotionRule> retrievePromotionRules(XPFPromotionsCalculatorRuleRetrievalContext context)

Retrieve promotion rules.

Parameters:

context - the rule retrieval context

Returns:

the map of promotion rules

retrievePromotionCarrots

@Deprecated
Set<XPFPromotionRule> retrievePromotionCarrots(XPFPromotionCarrotsInputContext context)

Deprecated. implement retrievePromotionCarrots(com.elasticpath.xpf.connectivity.context.XPFPromotionCarrotsInputContext context) instead

Retrieve promotion carrots.

Parameters:

context - the context

Returns:

the set of promotion carrots

retrievePromotionCarrots

default Set<XPFPromotionRule> retrievePromotionCarrots(XPFPromotionCarrotsInputContext context)

Retrieve promotion carrots.

Parameters:

context - the context

Returns:

the set of promotion carrots

retrieveCouponsByGuids

Map<String,XPFCoupon> retrieveCouponsByGuids(XPFPromotionCalculatorCouponGuidRetrievalContext context)

Retrieve coupons by GUIDs.

Parameters:

context - the context

Returns:

a map of coupon GUID to coupon

retrieveCouponsByCodes

Map<String,Collection<XPFCoupon>> retrieveCouponsByCodes(XPFPromotionCalculatorCouponCodeRetrievalContext context)

Retrieve coupons by coupon codes.

Parameters:

context - the context

Returns:

return a map of coupon code to collection of coupons

retrieveCouponCodesByCustomerAndStore

Set<String> retrieveCouponCodesByCustomerAndStore(XPFPromotionCalculatorCouponStoreEmailRetrievalContext context)

Get applicable coupon codes for given store and customer email.

Parameters:

context - the context

Returns:

the set of valid applicable coupon codes

validateCouponRuleAndUsage

Map<String,XPFPromotionCouponValidationOutputContext> validateCouponRuleAndUsage(XPFPromotionCalculatorCouponValidationContext context)

Determine if the specified coupon codes are valid. Validity checks include ensuring that the coupon is not suspended and that it has at least one use remaining.

Parameters:

context - the context

Returns:

the map coupon code to collection of XPFPromotionCouponValidationOutputContext

createCouponsForPromotions

@Deprecated
default void createCouponsForPromotions(XPFPromotionCalculatorCouponCreationContext context)

Deprecated. implement triggerActionsAtCheckout(XPFPromotionCalculatorTriggerActionsAtCheckoutContext context) instead

Create and assign coupons to the customer email address for the promotions provided in the context.

Parameters:

context - the context

triggerActionsAtCheckout

default void triggerActionsAtCheckout(XPFPromotionCalculatorTriggerActionsAtCheckoutContext context)

Trigger promotion-related actions that need to be executed at checkout time for the promotions provided in the context.

Parameters:

context - the context

disableCouponAutoApply

void disableCouponAutoApply(XPFPromotionCalculatorDisableCouponContext context)

Change the behaviour of the specified coupons so that shopper-specific coupons don't automatically apply to future shopper's carts.

Parameters:

context - the context