Interface IPromotionProcessor

Namespace: EPiServer.Commerce.Marketing

Assembly: EPiServer.Business.Commerce.dll

Syntax

public interface IPromotionProcessor

Remarks

Examples

/// <summary>
/// Sample of a promotion processor for <see cref="PercentagePromotionSample"/>.
/// </summary>
[ServiceConfiguration(Lifecycle = ServiceInstanceScope.Singleton)]
public class PercentagePromotionProcessorSample : EntryPromotionProcessorBase<PercentagePromotionSample>
{
private readonly CollectionTargetEvaluator _targetEvaluator;
private readonly FulfillmentEvaluator _fulfillmentEvaluator;
private readonly LocalizationService _localizationService;

/// <summary>
/// Creates a new instance of a <see cref="PercentagePromotionProcessorSample"/>.
/// </summary>
/// <param name="targetEvaluator">The service that is used to evaluate an order against a promotion's target properties.</param>
/// <param name="fulfillmentEvaluator">The service that is used to evaluate the fulfillment status of the promotion.</param>
/// <param name="localizationService">The service that is used to get localized strings.</param>
/// <param name="redemptionDescriptionFactory">Factory for creating <see cref="RedemptionDescription"/>s.</param>
public PercentagePromotionProcessorSample(
CollectionTargetEvaluator targetEvaluator, 
FulfillmentEvaluator fulfillmentEvaluator,
LocalizationService localizationService,
RedemptionDescriptionFactory redemptionDescriptionFactory)
: base(redemptionDescriptionFactory)
{
_targetEvaluator = targetEvaluator;
_fulfillmentEvaluator = fulfillmentEvaluator;
_localizationService = localizationService;
}

/// <summary>
/// Evaluates a promotion against an order form.
/// </summary>
/// <param name="promotionData">The promotion to evaluate.</param>
/// <param name="context">The promotion processor context.</param>
/// <returns>
/// A <see cref="RewardDescription" /> telling whether the promotion was fulfilled,
/// which items the promotion was applied to and to which discount percentage.
/// </returns>
protected override RewardDescription Evaluate(PercentagePromotionSample promotionData, PromotionProcessorContext context)
{
var lineItems = GetLineItems(context.OrderForm);
var condition = promotionData.Condition;

var applicableCodes = _targetEvaluator.GetApplicableCodes(lineItems, condition.Items, condition.MatchRecursive);

var fulfillmentStatus = _fulfillmentEvaluator.GetStatusForBuyQuantityPromotion(
applicableCodes, 
lineItems,
condition.RequiredQuantity,
condition.PartiallyFulfilledThreshold);

var affectedEntries = context.EntryPrices.ExtractEntries(applicableCodes, condition.RequiredQuantity, promotionData);

return RewardDescription.CreatePercentageReward(
fulfillmentStatus,
GetRedemptions(promotionData, context, applicableCodes),
promotionData,
promotionData.PercentageDiscount,
fulfillmentStatus.GetRewardDescriptionText(_localizationService));
}

/// <summary>
/// Gets the items related to a promotion.   
/// </summary>
/// <param name="promotionData">The promotion data to get items for.</param>
/// <returns>
/// The promotion condition and reward items.
/// </returns>
protected override PromotionItems GetPromotionItems(PercentagePromotionSample promotionData)
{
var specificItems = new CatalogItemSelection(
promotionData.Condition.Items, 
CatalogItemSelectionType.Specific,
promotionData.Condition.MatchRecursive);

return new PromotionItems(promotionData, specificItems, specificItems);
}

/// <summary>
/// Verify that the current promotion can potentially be fulfilled.
/// </summary>
/// <remarks>
/// This method is intended to be a very quick pre-check to avoid doing more expensive operations.
/// In this case that a positive discount percentage has been set, and that the cart is not empty.
/// </remarks>
/// <param name="promotionData">The promotion to evaluate.</param>
/// <param name="context">The context for the promotion processor evaluation.</param>
/// <returns>
/// <c>true</c> if the current promotion can potentially be fulfilled; otherwise, <c>false</c>.
/// </returns>
protected override bool CanBeFulfilled(PercentagePromotionSample promotionData, PromotionProcessorContext context)
{
if (promotionData.PercentageDiscount <= 0)
{
return false;
}

var lineItems = GetLineItems(context.OrderForm);
if (!lineItems.Any())
{
return false;
}

return true;
}
}

Properties

Priority

Declaration

int Priority { get; }

Property Value

PromotionDataType

Declaration

Type PromotionDataType { get; }

Property Value

Methods

Evaluate(PromotionData, PromotionProcessorContext)

Declaration

RewardDescription Evaluate(PromotionData promotionData, PromotionProcessorContext context)

Parameters

Returns

Remarks

GetPromotionItems(PromotionData)

Declaration

PromotionItems GetPromotionItems(PromotionData promotionData)

Parameters

Returns

Remarks