A condition with customized logic can be created by implementing the IConditon and IUIExtension interfaces. This is similar to how a custom action is created. The only difference is that the ICondition interface is implemented instead of the IAction one. Apart from that, the same principles apply. Please refer to the article about custom action first, then implement the code presented here.
These are the four steps:
- Create a separate project
- Create a class in the project
- Create a web-user control
- Import condition strings
Create a separate project in your solution, where you can place your custom class.
Create a class in the project and implement the following two interfaces:
- Litium.Foundation.Modules.ECommerce.Plugins.Campaigns.ICondition
- Litium.Foundation.Modules.ECommerce.Plugins.Campaigns.IUIExtension
From Litium 7.2, two more conditions can be implemented for increased flexibility:
- Litium.Foundation.Modules.ECommerce.Plugins.Campaigns.IConditionWithOrder
- Litium.Foundation.Modules.ECommerce.Plugins.Campaigns.IRequireCampaignInfo
Example: Excluding articles from the order total
The default order-total condition calculates the order total on all products in the cart, but does not allow specific products to be excluded. This is not ideal in when large percentage discounts are given. For example, a 50% discount is given for a particular product called "A" (regular price 100 SEK) when the order total exceeds 90 SEK. If the normal order-total condition is used, the campaign will be applied when the user selects product A. This happens because the product list price is 100 SEK and the limit for the campaign order-total condition is 90 SEK. But once the campaign is applied, the order total will be 50 SEK because of the 50% discount.
To avoid the above scenario, we need to use an order-total condition that will exclude the product "A" when the order total is calculated.
Here is the complete source of the above class:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Litium.Foundation.Modules.ECommerce;
using Litium.Foundation.Modules.ECommerce.Carriers;
using Litium.Foundation.Modules.ECommerce.Plugins.Campaigns;
using Litium.Foundation.Modules.ECommerce.Plugins.Campaigns.ConditionTypes;
using Litium.Foundation.Modules.ExtensionMethods;
using Litium.Foundation.Security;
namespace Litium.Studio.KC.Samples.Campaigns
{
/// <summary>
/// Order total condition
/// </summary>
public class OrderTotalExcludingArticlesCondition : CartConditionType
{
private const string PATH = "~/Litium/ECommerce/WebUserControls/Conditions/OrderTotalExcludingArticlesConditionControl.ascx";
Data m_data;
/// <summary>
/// Initializes the specified data.
/// </summary>
/// <param name="data">The data.</param>
protected override void Initialize(object data)
{
base.Initialize(data);
m_data = (Data)data;
}
/// <summary>
/// Gets the panel path.
/// </summary>
/// <value>The panel path.</value>
public override string PanelPath { get { return PATH; } }
/// <summary>
/// Gets a value indicating whether condition depends on order total.
/// If true, an order total calculation will be done before invoking the condition.
/// </summary>
/// <value>
/// <c>true</c> if condition depends on order total otherwise, <c>false</c>.
/// </value>
public override bool DependsOnOrderTotal
{
get
{
return true;
}
}
/// <summary>
/// Evaluates the specified condition.
/// </summary>
/// <param name="conditionArgs">The condition args.</param>
/// <returns></returns>
protected override IEnumerable<OrderCarrier> Evaluate(ConditionArgs conditionArgs)
{
decimal subTotal = 0;
switch (m_data.SelectedIdType)
{
case Data.SelectionCriteria.ProductLists:
subTotal = (m_data.IncludeVat) ?
conditionArgs.OrderRows.Where(x => !m_data.SelectedIDs.Intersect(x.ProductSetIDs).Any()).Select(y => y.OrderRowCarrier.TotalPriceWithVAT).Sum() :
conditionArgs.OrderRows.Where(x => !m_data.SelectedIDs.Intersect(x.ProductSetIDs).Any()).Select(y => y.OrderRowCarrier.TotalPrice).Sum();
break;
}
return (from order in conditionArgs.OrderCarriers
where
(m_data.ShouldBeEqualOrMore && (subTotal >= m_data.TotalPrice))
|| (!m_data.ShouldBeEqualOrMore && (subTotal <= m_data.TotalPrice))
select order);
}
/// <summary>
/// Condition data.
/// </summary>
[Serializable]
public class Data
{
/// <summary>
/// Gets or sets the total price.
/// </summary>
/// <value>The total price.</value>
public decimal TotalPrice { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [include vat].
/// </summary>
/// <value><c>true</c> if [include vat]; otherwise, <c>false</c>.</value>
public bool IncludeVat { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [should be more].
/// </summary>
/// <value><c>true</c> if [should be more]; otherwise, <c>false</c>.</value>
public bool ShouldBeEqualOrMore { get; set; }
/// <summary>
/// Define the type of Ids selected for the <see cref="Data.SelectedIDs"/> property.
/// </summary>
public enum SelectionCriteria
{
/// <summary>
/// Product list ids.
/// </summary>
ProductLists
}
/// <summary>
/// Gets or sets the selection criteria.
/// </summary>
/// <value>The selection criteria.</value>
public SelectionCriteria SelectedIdType { get; set; }
/// <summary>
/// Gets or sets list of selected Ids
/// </summary>
/// <value>The selected I ds.</value>
public List<Guid> SelectedIDs { get; set; }
}
/// <summary>
/// Gets the description.
/// </summary>
/// <param name="languageID">The language ID.</param>
/// <returns></returns>
public override string GetDescription(Guid languageID)
{
string description = string.Empty;
try
{
SecurityToken token = ModuleECommerce.Instance.AdminToken;
StringBuilder sb = new StringBuilder();
if (m_data != null)
{
string articleName = string.Empty;
if (m_data.IncludeVat)
{
var withVatDescription = ModuleECommerce.Instance.Strings.GetValue("OrderTotalConditionDescriptionWithVAT", languageID, true);
sb.AppendFormat(withVatDescription, m_data.ShouldBeEqualOrMore ? " >= " : " <= ", m_data.TotalPrice);
}
else
{
var withoutVatdescription = ModuleECommerce.Instance.Strings.GetValue("OrderTotalConditionDescriptionWithoutVAT", languageID, true);
sb.AppendFormat(withoutVatdescription, m_data.ShouldBeEqualOrMore ? " >= " : " <= ", m_data.TotalPrice);
}
sb.AppendLine();
switch (m_data.SelectedIdType)
{
case Data.SelectionCriteria.ProductLists:
sb.Append(ModuleECommerce.Instance.Strings.GetValue("OrderTotalExcludingArticlesConditionExcludeProductSets", languageID, true));
foreach (Guid item in m_data.SelectedIDs)
{
var productSet = item.GetProductList();
if (productSet != null)
{
sb.Append(Environment.NewLine);
sb.Append(productSet.GetDisplayName(languageID));
}
}
break;
}
description = sb.ToString();
}
else
{
description = base.GetDescription(languageID);
}
}
catch (Exception)
{
description = base.GetDescription(languageID);
}
return description;
}
}
}
Back to top
In your website project, create the web-user control OrderTotalExcludingArticlesConditionControl.ascx and implement it in the IUIExtensionPanel interface. Place the control in the ~/Site/ECommerce/Campaigns/KC/ folder.
The UI of the condition looks as shown below and is rendered from the ~/Site/ECommerce/Campaigns/KC/OrderTotalExcludingArticlesConditionControl.ascx web-user control.
Here is the complete source code of the .ascx file:
<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="OrderTotalExcludingArticlesConditionControl.ascx.cs" Inherits="Litium.Studio.KC.Samples.Campaigns.OrderTotalExcludingArticlesConditionControl" %>
<style type="text/css">
.productlist-grid th, .productlist-grid td {
padding: 5px;
}
</style>
<div>
<div class="litBoldHeader">
<Foundation:ModuleString ID="ModuleStringOrderTotal" Name="OrderTotalExcludingArticlesConditionOrderTotal" runat="server" />
</div>
<asp:DropDownList ID="c_conditionDropDownList" runat="server" Style="width: 204px;" />
<asp:TextBox ID="c_textBoxPay" runat="server" CssClass="lsCampaignConditionsQuantityField" />
<div class="litBoldHeader" style="display: inline;">
<img src="~/LitiumStudio/ECommerce/Images/transparent.gif" runat="server" id="Img2"
style="vertical-align: middle;" class="litIconRequired" alt="" />
</div>
<asp:RequiredFieldValidator Display="Dynamic" ID="c_requiredQuantityValidator" ControlToValidate="c_textBoxPay"
ValidationGroup="addCampaign" runat="server" ErrorMessage="*" />
<asp:RegularExpressionValidator ID="c_regExQuantityValidator" ControlToValidate="c_textBoxPay"
ValidationGroup="addCampaign" runat="server" ValidationExpression="^\d*[0-9](|.\d*[0-9]|,\d*[0-9])?$"
ErrorMessage="*" />
<div>
<div class="litBoldHeader" style="display: inline;">
<asp:CheckBox CssClass="litInputCheckbox" ID="c_includeVat" runat="server" />
<asp:Label ID="c_includeVatLabel" AssociatedControlID="c_includeVat" runat="server">
<Foundation:ModuleString ID="ModuleString11" Name="TotalIncludingVAT" runat="server" />
</asp:Label>
</div>
</div>
</div>
<div class="litBoldHeader">
<Foundation:ModuleString ID="ModuleStringOrderTotalExcludingArticlesConditionExcludeArticles" Name="OrderTotalExcludingArticlesConditionExcludeArticles" runat="server" />
</div>
<div class="litBoldHeader">
<asp:GridView ID="c_ProductListGrid" CssClass="productlist-grid"
runat="server" DataKeyNames="Id" AutoGenerateColumns="false">
<Columns>
<asp:BoundField HeaderText="Name" DataField="Name" />
<asp:TemplateField HeaderText="Select" ItemStyle-HorizontalAlign="Center">
<ItemTemplate>
<asp:CheckBox ID="RowSelector" runat="server"/>
</ItemTemplate>
</asp:TemplateField>
</Columns>
</asp:GridView>
</div>
<div>
<div class="litBoldHeader">
<Foundation:ModuleString ID="ModuleString3" Name="CampaignDescription" runat="server" />
<img src="~/LitiumStudio/ECommerce/Images/transparent.gif" visible="false" runat="server"
id="Img4" style="vertical-align: middle;" class="litIconRequired" alt="" /></div>
<div class="litText" style="width: 280px;">
<Foundation:ModuleString ID="ModuleString1" Name="OrderTotalExcludingArticlesConditionDescription" runat="server" />
</div>
</div>
<div class="clearer" />
<asp:HiddenField runat="server" ID="c_hiddenFieldIDs" />
Here is the Codebehind file:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.UI.WebControls;
using Litium.Foundation.Modules.ECommerce.Plugins.Campaigns;
using Litium.Studio.UI.ECommerce.Common;
using Litium.Studio.UI.ECommerce.Common.Constants;
using Litium.Products;
using System.Globalization;
namespace Litium.Studio.KC.Samples.Campaigns
{
public partial class OrderTotalExcludingArticlesConditionControl : UserBaseControl, IUIExtensionPanel
{
private const string IS_GREATER_THAN_OR_EQUAL = "IsGreaterThanOrEqual";
private const string IS_LESS_THAN_OR_EQUAL = "IsLessThanOrEqual";
protected override void OnInit(EventArgs e)
{
Page.RegisterRequiresControlState(this);
InitializePageControls();
base.OnInit(e);
}
protected override object SaveControlState()
{
return m_data;
}
protected override void LoadControlState(object state)
{
if (state != null)
{
m_data = state as OrderTotalExcludingArticlesCondition.Data;
}
}
private ProductListService _productListService = IoC.Resolve<ProductListService>();
OrderTotalExcludingArticlesCondition.Data Data
{
set
{
m_data = value;
}
get
{
if (m_data == null)
return m_data = new OrderTotalExcludingArticlesCondition.Data { SelectedIDs = new List<Guid>(), SelectedIdType = OrderTotalExcludingArticlesCondition.Data.SelectionCriteria.ProductLists };
return m_data;
}
}
private OrderTotalExcludingArticlesCondition.Data m_data;
/// <summary>
/// Initializes the validation on page.
/// </summary>
private void InitializeValidation()
{
c_regExQuantityValidator.CssClass = ParameterConstants.VALIDATOR_STYLE_NAME;
c_regExQuantityValidator.Text = String.Format("{0} {1}", ParameterConstants.VALIDATOR_IMAGE,
SystemStrings.GetValue(SystemStringConstants.VALIDATION_MESSAGE_INVALID_INPUT,
FoundationContext.LanguageID, true));
String digitsSeparator = FoundationContext.Culture.NumberFormat.CurrencyDecimalSeparator;
c_regExQuantityValidator.ValidationExpression = String.Format(@"^\d*[0-9](|\{0}\d*[0-9])?$", digitsSeparator);
c_requiredQuantityValidator.CssClass = ParameterConstants.VALIDATOR_STYLE_NAME;
c_requiredQuantityValidator.Text = String.Format("{0} {1}", ParameterConstants.VALIDATOR_IMAGE,
SystemStrings.GetValue(SystemStringConstants.VALIDATION_MESSAGE_REQUIRED_FIELD,
FoundationContext.LanguageID, true));
}
/// <summary>
/// Initializes the condition drop down.
/// </summary>
private void InitializeConditionDropDown()
{
if (c_conditionDropDownList.Items.Count == 0)
{
String text = CurrentModule.Strings.GetValue(IS_GREATER_THAN_OR_EQUAL, FoundationContext.LanguageID, true);
c_conditionDropDownList.Items.Add(new ListItem(text, IS_GREATER_THAN_OR_EQUAL));
text = CurrentModule.Strings.GetValue(IS_LESS_THAN_OR_EQUAL, FoundationContext.LanguageID, true);
c_conditionDropDownList.Items.Add(new ListItem(text, IS_LESS_THAN_OR_EQUAL));
}
}
/// <summary>
/// Initializes the page controls.
/// </summary>
private void InitializePageControls()
{
InitializeConditionDropDown();
InitializeProductListDropDown();
InitializeValidation();
}
private void InitializeProductListDropDown()
{
if (c_ProductListGrid.Rows.Count == 0)
{
c_ProductListGrid.DataSource = _productListService.GetAll().Select(x => new {Id = x.SystemId, Name = x.Localizations[CultureInfo.CurrentCulture].Name });
c_ProductListGrid.DataBind();
}
}
/// <summary>
/// Gets the panel data.
/// </summary>
/// <returns>Return an object with the panel data.</returns>
object IUIExtensionPanel.GetPanelData()
{
decimal totalPrice;
decimal.TryParse(c_textBoxPay.Text, out totalPrice);
Data.TotalPrice = totalPrice;
Data.IncludeVat = c_includeVat.Checked;
Data.ShouldBeEqualOrMore = c_conditionDropDownList.Items.FindByValue(IS_GREATER_THAN_OR_EQUAL).Selected;
Data.SelectedIdType = OrderTotalExcludingArticlesCondition.Data.SelectionCriteria.ProductLists;
Data.SelectedIDs = new List<Guid>();
for (int i = 0; i < c_ProductListGrid.Rows.Count; i++)
{
CheckBox cbSelection = c_ProductListGrid.Rows[i].FindControl("RowSelector") as CheckBox;
if (cbSelection.Checked)
{
Data.SelectedIDs.Add(Guid.Parse(c_ProductListGrid.DataKeys[i].Value.ToString()));
}
}
return Data;
}
/// <summary>
/// Sets the panel data.
/// </summary>
/// <param name="data">The data.</param>
void IUIExtensionPanel.SetPanelData(object data)
{
if (data is OrderTotalExcludingArticlesCondition.Data)
Data = (OrderTotalExcludingArticlesCondition.Data)data;
InitializePageControls();
if (data is OrderTotalExcludingArticlesCondition.Data)
{
c_hiddenFieldIDs.Value = string.Join(",", Data.SelectedIDs.ToList().ConvertAll(x => x.ToString()).ToArray());
c_textBoxPay.Text = Data.TotalPrice.ToString();
c_includeVat.Checked = Data.IncludeVat;
if (!Data.ShouldBeEqualOrMore)
{
ListItem item = c_conditionDropDownList.Items.FindByValue(IS_LESS_THAN_OR_EQUAL);
if (item != null)
item.Selected = true;
}
var selectedIds = Data.SelectedIDs.ToList();
if (selectedIds.Count > 0)
{
for (int i = 0; i < c_ProductListGrid.Rows.Count; i++)
{
if(selectedIds.IndexOf(Guid.Parse(c_ProductListGrid.DataKeys[i].Value.ToString())) >= 0)
{
CheckBox cbSelection = c_ProductListGrid.Rows[i].FindControl("RowSelector") as CheckBox;
cbSelection.Checked = true;
}
}
}
}
}
}
}
Back to top
Import condition strings to the Sales area.
<ModuleStringCollection>
<Strings>
<ModuleString Key="OrderTotalExcludingArticlesConditionDescription" Value="Total of all order rows (excluding order rows that contains article from above list) should meet this condition" />
<ModuleString Key="OrderTotalExcludingArticlesConditionExcludeArticles" Value="If the order does not contain following products" />
<ModuleString Key="OrderTotalExcludingArticlesConditionExcludeAssortment" Value="If order doesn't contain products that belong to {0} assortment(s)" />
<ModuleString Key="OrderTotalExcludingArticlesConditionExcludeProductGroup" Value="if order does not contain product from the following categories (products in subcategories are not considered)" />
<ModuleString Key="OrderTotalExcludingArticlesConditionExcludeProductSets" Value="if order does not contain product from the following product lists" />
<ModuleString Key="OrderTotalExcludingArticlesConditionName" Value="Order total excluding specified articles" />
<ModuleString Key="OrderTotalExcludingArticlesConditionOrderTotal" Value="Order total excluding specified articles condition" />
</Strings>
</ModuleStringCollection>
Back to top