TaxTypeManager

The class manages commerce tax types in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.TaxTypeManager

Constructors

  • TaxTypeManager()
  • TaxTypeManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Commerce.TaxTypeData)

Adds a tax type to the CMS. The TaxType.Id property is populated with the new tax type's ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Tax Type Name
  • * Precedence

Parameters

  • taxTypeData. TaxTypeData object to add.

Returns

TaxTypeData object.

.aspx code snippet

<ol class="formFields">
<li class="clearfix">
    <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-6 last" runat="server" Text="* Tax Type Name:" />
    <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
</li>
 <div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Label ID="uxPrecedenceLabel" AssociatedControlID="uxPrecedence" CssClass="span-6 last" runat="server" Text="* Precedence:" />
    <ektronUI:TextField ID="uxPrecedence" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" />
</li>
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Cms;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {

            TaxTypeManager taxTypeManager = new TaxTypeManager();
            TaxTypeData taxTypeData = new TaxTypeData();

            taxTypeData.Name = uxName.Text;
            taxTypeData.Precedence = Convert.ToInt16(uxPrecedence.Text);

            taxTypeData = taxTypeManager.Add(taxTypeData);
            MessageUtilities.UpdateMessage(uxMessage, "TaxTypeData is added with Id " + taxTypeData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a tax type from the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • id. ID of tax type to delete.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxTypeIdLabel" AssociatedControlID="uxTaxTypeId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long ID = long.Parse(uxTaxTypeId.Text);

            TaxTypeManager taxTypeManager = new TaxTypeManager();
            taxTypeManager.Delete(ID);
            MessageUtilities.UpdateMessage(uxMessage, "TaxTypeData with Id " + uxTaxTypeId.Text + " deleted", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves a tax type by ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

id. ID of tax type to retrieve.

Returns

TaxTypeData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxTypeIdLabel" AssociatedControlID="uxTaxTypeId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
    </ol>
    <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPrecedence" runat="server"></asp:Literal>
    </li>
 </ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxTypeId = long.Parse(uxTaxTypeId.Text);

            TaxTypeManager taxTypeManager = new TaxTypeManager();
            TaxTypeData taxTypeData = new TaxTypeData();
            taxTypeData = taxTypeManager.GetItem(taxTypeId);
            if (taxTypeData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for Tax Type Id " + taxTypeData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + taxTypeData.Name;
                uxPrecedence.Text = "Precedence : " + taxTypeData.Precedence;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either Tax Type with ID " + taxTypeId + " does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Commerce.TaxTypeCriteria)

Retrieves a list of Tax Types.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Tax Type Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter tax type being retrieved.

Returns

List of TaxTypeData objects.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxTypePropertyLabel" AssociatedControlID="uxTaxType" CssClass="span-5 last" runat="server" Text="* TaxType Property:" />
        <asp:DropDownList ID="uxTaxType" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>Precedence</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-5 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>            
<asp:ListView ID="uxtaxTypeDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >No records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>Id</th>
                    <th>Name</th>
                    <th>Precedence</th>                   
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
                <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Precedence")%>
            </td>
            
      </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;

            TaxTypeManager taxTypeManager = new TaxTypeManager();
            TaxTypeCriteria criteria = new TaxTypeCriteria();

            if (uxTaxType.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(TaxTypeProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxType.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxTypeProperty.Name, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxTypeProperty.Precedence, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<TaxTypeData> taxTypeDataList = taxTypeManager.GetList(criteria);

            uxtaxTypeDataListView.Visible = true;
            uxtaxTypeDataListView.DataSource = taxTypeDataList;
            uxtaxTypeDataListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Commerce.TaxTypeData)

Updates an existing tax type in the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Tax Type Name

Parameters

  • taxTypeData. TaxTypeData object to save.

Returns

TaxTypeData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxTypeIdLabel" AssociatedControlID="uxTaxTypeId" CssClass="span-6 last" runat="server" Text=" Id:" />
        <ektronUI:TextField ID="uxTaxTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-6 last" runat="server" Text="* Tax Type Name:" />
        <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" />
    </li>
</ol>           
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.IO;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxTypeId = long.Parse(uxTaxTypeId.Text);
            TaxTypeManager taxTypeManager = new TaxTypeManager();
            TaxTypeData taxTypeData = new TaxTypeData();
            taxTypeData = taxTypeManager.GetItem(taxTypeId);
            if (taxTypeId > 0 && taxTypeData != null)
            {
                taxTypeData.Name = uxName.Text;
                taxTypeData = taxTypeManager.Update(taxTypeData);
                MessageUtilities.UpdateMessage(uxMessage, "TaxType Updated with Id " + uxTaxTypeId.Text, Message.DisplayModes.Success);
                
            }               
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid TaxType ID.", Message.DisplayModes.Error);
                
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

TaxTypeCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • TaxTypeCriteria()
    public TaxTypeCriteria()
  • TaxTypeCriteria(Ektron.Cms.Commerce.TaxTypeProperty, EkEnumeration.OrderByDirection)
    public TaxTypeCriteria(Ektron.Cms.Commerce.TaxTypeProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the TaxTypeProperty are:

    • Id
    • Name
    • Precedence

TaxTypeData

Namespace

Ektron.Cms.Commerce

Properties

  • Id. Gets or sets the name of the tax class.
    public long Id { set; get; }
  • Name. Gets or sets the name of the tax class.
    public string Name { set; get; }
  • Precedence. Gets or sets the precedence of the tax class. This is the priority order in which it will be applied. For example, if type "Postal Code Sales Tax is priority 1" and it exists for an address it will be used over type "State Sales Tax" which is priority 2.
    public int Precedence { set; get; }
  • TaxTypeData()
    public TaxTypeData()
  • TaxTypeData(string, int)
    public TaxTypeData(string name, int precedence)
  • TaxTypeData(string, int, long)
    public TaxTypeData(string name, int precedence, long id)