ShippingMethodManager

The class manages shipping methods in CMS.

Namespace

Ektron.Cms.Framework.Commerce.ShippingMethodManager

Constructors

  • ShippingMethodManager()
  • ShippingMethodManager(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.ShippingMethodData)

Adds a shipping method to 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

  • * Shipping Method Name
  • * Provider Service
  • * Display Order
  • * Is Active

Parameters

  • shippingMethodData. ShippingMethodData object to add.

Returns

ShippingMethodData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-5 last" runat="server" Text="* Shipping Method Name:" />
        <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxProviderServiceLabel" AssociatedControlID="uxProviderService" CssClass="span-5 last" runat="server" Text="* ProviderService:" />
        <ektronUI:TextField ID="uxProviderService" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" /> 
        </li>
        <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayOrderLabel" AssociatedControlID="uxDisplayOrder" CssClass="span-5 last" runat="server" Text="* DisplayOrder:" />
        <ektronUI:TextField ID="uxDisplayOrder" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" /> 
        </li>
        <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsActiveLabel" AssociatedControlID="uxIsActive" CssClass="span-5 last" runat="server" Text="* IsActive: " />
        <asp:checkbox ID="uxIsActive" runat="server" />
    </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-5" 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
        {
            ShippingMethodManager shippingMethodManager = new ShippingMethodManager();
            ShippingMethodData shippingMethodData=new ShippingMethodData();
            shippingMethodData.Name = uxName.Text;
            shippingMethodData.ProviderService =uxProviderService.Text;
            shippingMethodData.DisplayOrder = int.Parse(uxDisplayOrder.Text);
            shippingMethodData.IsActive = uxIsActive.Checked;

            shippingMethodData = shippingMethodManager.Add(shippingMethodData);
            MessageUtilities.UpdateMessage(uxMessage, "shippingMethodData is added with Id " + shippingMethodData.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 shipping method from 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

  • shippingMethodId. ID of the shipping method to delete.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingIdLabel" AssociatedControlID="uxShippingId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxShippingId" 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(uxShippingId.Text);

            ShippingMethodManager shippingMethodManager = new ShippingMethodManager();
            shippingMethodManager.Delete(ID);
            MessageUtilities.UpdateMessage(uxMessage, "ShippingMethodData with Id " + uxShippingId.Text + " has been 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 the single shipping method by shipping method 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

  • shippingMethodId. ID of the shipping method to retrieved.

Returns

ShippingMethodData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingIdLabel" AssociatedControlID="uxShippingId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxShippingId" 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="uxProviderService" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayOrder" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsActive" 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 shippingMethodId = long.Parse(uxShippingId.Text);

            ShippingMethodManager shippingMethodManager = new ShippingMethodManager();
            ShippingMethodData shippingMethodData = new ShippingMethodData();
            shippingMethodData = shippingMethodManager.GetItem(shippingMethodId);
            if (shippingMethodData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for shipping method Id " + shippingMethodData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name: " + shippingMethodData.Name;
                uxProviderService.Text = "ProviderService: " + shippingMethodData.ProviderService;
                uxDisplayOrder.Text = "DisplayOrder: " + shippingMethodData.DisplayOrder;
                uxIsActive.Text = "IsActive: " + shippingMethodData.IsActive;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either shipping method with ID " + shippingMethodId + " 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.ShippingMethodCriteria)

Retrieves a list of shipping methods.

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

  • * Shipping Method Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter shipping methods being retrieved.

Returns

List of shipping methods meeting criteria filters.

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="uxShippingMethodPropertyLabel" AssociatedControlID="uxShippingMethodProperty" CssClass="span-5 last" runat="server" Text="* ShippingMethod Property:" />
        <asp:DropDownList ID="uxShippingMethodProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>ProviderService</asp:ListItem>
            <asp:ListItem>DisplayOrder</asp:ListItem>
            <asp:ListItem>IsActive</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="uxShippingMethodDataListView" 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>DisplayOrder</th> 
                    <th>ProviderService</th> 
                    <th>IsActive</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("DisplayOrder")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ProviderService")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsActive")%>
            </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;

            ShippingMethodManager shippingMethodManager = new ShippingMethodManager();
            ShippingMethodCriteria criteria = new ShippingMethodCriteria();

            if (uxShippingMethodProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(ShippingMethodProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxShippingMethodProperty.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(ShippingMethodProperty.Name, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxShippingMethodProperty.SelectedItem.Text == "DisplayOrder")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(ShippingMethodProperty.DisplayOrder, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxShippingMethodProperty.SelectedItem.Text == "ProviderService")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(ShippingMethodProperty.ProviderService, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(ShippingMethodProperty.IsActive, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<ShippingMethodData> ShippingMethodDataList = shippingMethodManager.GetList(criteria);

            uxShippingMethodDataListView.Visible = true;
            uxShippingMethodDataListView.DataSource = ShippingMethodDataList;
            uxShippingMethodDataListView.DataBind();

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

Update

Update(Ektron.Cms.Commerce.ShippingMethodData)

Updates an existing shipping method 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

  • * Shipping Method Name
  • * Provider Service
  • * Display Order
  • * Is Active

Parameters

  • shippingMethodData. ShippingMethodData object to save.

Returns

ShippingMethodData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingIdLabel" AssociatedControlID="uxShippingId" CssClass="span-5 last"  runat="server" Text=" Id:" />
        <ektronUI:TextField ID="uxShippingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-5 last" runat="server" Text="* Shipping Method Name:" />
        <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxProviderServiceLabel" AssociatedControlID="uxProviderService" CssClass="span-5 last" runat="server" Text="* ProviderService:" />
        <ektronUI:TextField ID="uxProviderService" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" /> 
        </li>
        <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayOrderLabel" AssociatedControlID="uxDisplayOrder" CssClass="span-5 last" runat="server" Text="* DisplayOrder:" />
        <ektronUI:TextField ID="uxDisplayOrder" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" /> 
        </li>
        <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsActiveLabel" AssociatedControlID="uxIsActive" CssClass="span-5 last" runat="server" Text="* IsActive: " />
            <asp:checkbox ID="uxIsActive" runat="server" />
    </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 shppingMethodId = long.Parse(uxShippingId.Text);
            ShippingMethodManager shippingMethodManager = new ShippingMethodManager();
            ShippingMethodData shippingMethodData = new ShippingMethodData();
            shippingMethodData = shippingMethodManager.GetItem(shppingMethodId);
            if (shppingMethodId > 0 && shippingMethodData != null)
            {
                shippingMethodData.Name = uxName.Text;
                shippingMethodData.DisplayOrder = int.Parse(uxDisplayOrder.Text);
                shippingMethodData.ProviderService = uxProviderService.Text;
                shippingMethodData.IsActive = uxIsActive.Checked;
                shippingMethodData = shippingMethodManager.Update(shippingMethodData);
                MessageUtilities.UpdateMessage(uxMessage, "Shipping Method Data has been updated with Id " + uxShippingId.Text, Message.DisplayModes.Success);
                
            }               
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Shipping Method ID.", Message.DisplayModes.Error);
                
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Data Classes

ShippingMethodCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • ShippingMethodCriteria()
    public ShippingMethodCriteria()
  • ShippingMethodCriteria(Ektron.Cms.Commerce.ShippingMethodProperty, EkEnumeration.OrderByDirection)
    public ShippingMethodCriteria(Ektron.Cms.Commerce.ShippingMethodProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the ShippingMethodProperty are:

    • DisplayOrder
    • Id
    • IsActive
    • Name
    • ProviderSearch

ShippingMethodData

Namespace

Ektron.Cms.Commerce

Properties

  • DisplayOrder. Gets or sets the display order for this shipping method.
    public int DisplayOrder { set; get; }
  • IsActive. Gets or sets whethe ror not the Shipping Method is Active. 
    public bool IsActive { set; get; }
  • ShippingMethodsData()
    public ShippingMethodData()