CountryManager

The class manipulates the country data in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.CountryManager

Constructors

  • CountryManager()
  • CountryManager(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.CountryData)

Adds a new country to Ektron CMS based on the CountryData object. The Country.Id property is populated with the new Country'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

  • * Country ID
  • * Country Name
  • * Long ISO Code
  • * Short ISO Code

Parameters

  • countryData. The CountryData object to add.

Returns

Returns newly created CountryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIDLabel" AssociatedControlID="uxCountryID" CssClass="span-4 last"
            runat="server" Text="* Country ID :" />
        <ektronUI:TextField ID="uxCountryID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryNameLabel" AssociatedControlID="uxCountryName" CssClass="span-4 last"
            runat="server" Text="* Country Name :" />
        <ektronUI:TextField ID="uxCountryName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLongIsoCodeLabel" AssociatedControlID="uxLongIsoCode" CssClass="span-4 last"
            runat="server" Text="* LongIsoCode :" />
        <ektronUI:TextField ID="uxLongIsoCode" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShortIsoCodelabel" AssociatedControlID="uxShortIsoCode" CssClass="span-4 last"
            runat="server" Text="* ShortIsoCode :" />
        <ektronUI:TextField ID="uxShortIsoCode" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></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 System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            if (Convert.ToInt32(uxCountryID.Text) > 0 && uxCountryName.Text.ToString() != "" && uxLongIsoCode.Text.ToString() != "" && uxShortIsoCode.Text.ToString() != "")
            {
                CountryManager countryManager = new CountryManager();
                CountryData countryData = new CountryData();    
            
                countryData.Id = Convert.ToInt32(uxCountryID.Text);
                countryData.Name = uxCountryName.Text.ToString();
                countryData.Enabled = true;
                countryData.LongIsoCode = uxLongIsoCode.Text.ToString();
                countryData.ShortIsoCode = uxShortIsoCode.Text.ToString();
                
                countryManager.Add(countryData);
                MessageUtilities.UpdateMessage(uxMessage, "Country added with Id: " + countryData.Id.ToString(), Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

CanDelete

CanDelete(System.Int32)

Checks to see if a country can be deleted. A country cannot be deleted if a region or address uses the country.

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

  • * Country ID

Parameters

  • countryId. The ID of the country to delete.

Returns

Returns true if country can safely be deleted.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIDLabel" AssociatedControlID="uxCountryID" CssClass="span-4 last"
            runat="server" Text="* Country ID :" />
        <ektronUI:TextField ID="uxCountryID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Check"></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 System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Microsoft.Practices.EnterpriseLibrary.Validation;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int  countryId = int.Parse(uxCountryID.Text);
            if (countryId > 0)
            {
                CountryManager countryManager = new CountryManager();
                CountryData countryData = countryManager.GetItem(countryId);
                if (countryData != null)
                {
                    bool canDelete = countryManager.CanDelete(countryId);
                    if (canDelete == true)
                    {
                        MessageUtilities.UpdateMessage(uxMessage, "The Country with Id " + countryId.ToString() + " is deletable", Message.DisplayModes.Success);
                    }
                    else
                    {
                        MessageUtilities.UpdateMessage(uxMessage, "The Country with Id " + countryId.ToString() + " is not deletable", Message.DisplayModes.Error);
                    }
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Country with Id " + countryId.ToString() + " could not be found", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Country Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int32)

Deletes a country from the Ektron CMS based on its 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

  • * Country ID

Parameters

  • countryId. The ID of the country to be deleted.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIDLabel" AssociatedControlID="uxCountryID" CssClass="span-4 last"
            runat="server" Text="* Country ID :" />
        <ektronUI:TextField ID="uxCountryID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </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 System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int countryId = int.Parse(uxCountryID.Text);
            if (countryId > 0)
            {
                CountryManager countryManager = new CountryManager();
                CountryData countryData = countryManager.GetItem(countryId);
                if (countryData != null)
                {
                    countryManager.Delete(countryId);
                    MessageUtilities.UpdateMessage(uxMessage, "Country Deleted for Id: " + countryId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Country with Id " + countryId.ToString() + " could not be found", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Country Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int32)

Retrieves a country by its 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

  • * Country ID

Parameters

  • countryId. The ID of the country to retrieve.

Returns

Returns a CountryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIDLabel" AssociatedControlID="uxCountryID" CssClass="span-4 last"
            runat="server" Text="* Country ID :" />
        <ektronUI:TextField ID="uxCountryID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" 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="uxCountryName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLongIsoCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxShortIsoCode" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int countryId = int.Parse(uxCountryID.Text);
            if (countryId > 0)
            {
                CountryManager countryManager = new CountryManager();
                CountryData countryData = countryManager.GetItem(countryId);
                if (countryData != null)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Country Details for Id: " + countryId.ToString() + " are below", Message.DisplayModes.Success);
                    uxCountryName.Text = "Country Name: " + countryData.Name;
                    uxLongIsoCode.Text = "LongIsoCode: " + countryData.LongIsoCode;
                    uxShortIsoCode.Text = "ShortIsoCode: " + countryData.ShortIsoCode;
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Country Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Country Id", 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.CountryCriteria)

Retrieves a list of countries based on filters set in the CountryCriteria property.

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

  • * Country Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter the list of countries being retrieved.

Returns

A list of countries 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="uxCountryPropertyLabel" AssociatedControlID="uxCountryProperty"
            CssClass="span-4 last" runat="server" Text="* CountryProperty :" />
        <asp:DropDownList ID="uxCountryProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>LongIsoCode</asp:ListItem>                            
        </asp:DropDownList>
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last"
            runat="server" Text="* ObjectValue :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxCountrylistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
    Visible="false">
    <EmptyDataTemplate>
        Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        Name
                    </th>
                    <th>
                        LongIsoCode
                    </th>
                    <th>
                        ShortIsoCode
                    </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("LongIsoCode")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ShortIsoCode")%>
            </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CountryManager countryManager = new CountryManager();
            object objectValue = uxObjectValue.Text;
            string countryProperty = uxCountryProperty.SelectedItem.Text;

            CountryCriteria criteria = new CountryCriteria();
            criteria.OrderByField = CountryProperty.Id;
            criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;

            if (countryProperty == "Id")
            {                
                criteria.AddFilter(CountryProperty.Id, CriteriaFilterOperator.EqualTo, objectValue);
            }
            else if (countryProperty == "Name")
            {
                criteria.AddFilter(CountryProperty.Name, CriteriaFilterOperator.EqualTo, objectValue);
            }
            else
            {
                criteria.AddFilter(CountryProperty.LongIsoCode, CriteriaFilterOperator.EqualTo, objectValue);
            }

            List<CountryData> countryDataList = countryManager.GetList(criteria);
            uxCountrylistView.Visible = true;
            uxCountrylistView.DataSource = countryDataList;
            uxCountrylistView.DataBind();

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

Update

Update(Ektron.Cms.Commerce.CountryData)

Updates an existing country in Ektron CMS based on the CountryData object.

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

  • * Country ID
  • Country Name
  • Long ISO Code
  • Short ISO Code

Parameters

  • countryData. The CountryData object to save.

Returns

Returns updated CountryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIDLabel" AssociatedControlID="uxCountryID" CssClass="span-4 last"
            runat="server" Text="* Country ID :" />
        <ektronUI:TextField ID="uxCountryID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryNameLabel" AssociatedControlID="uxCountryName" CssClass="span-4 last"
            runat="server" Text=" Country Name :" />
        <ektronUI:TextField ID="uxCountryName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLongIsoCodeLabel" AssociatedControlID="uxLongIsoCode" CssClass="span-4 last"
            runat="server" Text=" LongIsoCode :" />
        <ektronUI:TextField ID="uxLongIsoCode" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShortIsoCodelabel" AssociatedControlID="uxShortIsoCode" CssClass="span-4 last"
            runat="server" Text=" ShortIsoCode :" />
        <ektronUI:TextField ID="uxShortIsoCode" CssClass="span-4" 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-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int countryId = int.Parse(uxCountryID.Text);
            if (countryId > 0)
            {
                CountryManager countryManager = new CountryManager();
                CountryData countryData = countryManager.GetItem(countryId);
                countryData.Name = uxCountryName.Text == "" ? countryData.Name : uxCountryName.Text;
                countryData.LongIsoCode = uxLongIsoCode.Text == "" ? countryData.LongIsoCode : uxLongIsoCode.Text;
                countryData.ShortIsoCode = uxShortIsoCode.Text == "" ? countryData.ShortIsoCode : uxShortIsoCode.Text;
                countryManager.Update(countryData);
                MessageUtilities.UpdateMessage(uxMessage, "Country updated for Id: " + countryId.ToString() , Message.DisplayModes.Success);
            }
            else 
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Country Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

CountryCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • CountryCriteria()
    public CountryCriteria()
  • CountryCriteria(Ektron.Cms.Commerce.CountryProperty, EkEnumeration.OrderByDirection)
    public 
  CountryCriteria(Ektron.Cms.Commerce.CountryProperty 
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CountryProperty are:

    • Id
    • IsEnabled
    • LongIsoCode
    • Name
    • ShortIsoCode

CountryData

Namespace

Ektron.Cms.Commerce

Properties

  • CountryData()
    public CountryData()
  • CountryData(int, string, string, string, bool)
    public CountryData(int id, string name, string shortIsoCode, 
  string longIsoCode, bool enabled)
  • Enabled. Gets or sets whether or not the country is enabled for use.
    public bool Enabled { set; get; }
  • Id. Gets or sets the ID of the country. The ID is the ISO numeric code of the country. This property is required when creating an country data object.
    public int Id { set; get; }
  • LongIsoCode. Gets or sets the 3 letter ISO code of the country. This property is required when creating an country data object.
    public string LongIsoCode { set; get; }
  • Name. Gets or sets the name of the country. This property is required when creating an country data object.
    public string Name { set; get; }
  • ShortIsoCode. Gets or sets the 2 letter ISO code of the country. This property is required when creating an country data object.
    public string ShortIsoCode { set; get; }
  • ToString. Returns Name of Country.
    public override string ToString()
  • Validate. Validates the CountryData object is valid for saving. Returns a ValidationResult object with any validation errors.
    public ValidationResults Validate()