RegionManager

The class manages regions in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.RegionManager

Constructors

  • RegionManager()
  • RegionManager(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.RegionData)

Adds a region to the CMS. The Region.Id property is populated with the new regions 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

  • * Name
  • * Country ID
  • * Code
  • Enabled

Parameters

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxRegionNameLabel" AssociatedControlID="uxRegionName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxRegionName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionCountryIdLabel" AssociatedControlID="uxRegionCountryId" CssClass="span-3 last" runat="server" Text="* Country Id:" />
        <ektronUI:TextField  ID="uxRegionCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxRegionCodeLabel" AssociatedControlID="uxRegionCode" CssClass="span-3 last" runat="server" Text="* Code:" />
        <ektronUI:TextField  ID="uxRegionCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionEnabledLabel" AssociatedControlID="uxRegionEnabled" CssClass="span-3 last" runat="server" Text=" Enabled:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxRegionEnabled" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            RegionManager regionManager = new RegionManager();
            bool isEnabled = false;
            if (uxRegionEnabled.Checked)
            {
                isEnabled = true;
            }
            RegionData regionData = new RegionData()
            {
                Code = uxRegionCode.Text,
                CountryId = long.Parse(uxRegionCountryId.Text),
                Name = uxRegionName.Text,
                Enabled = isEnabled
            };

            regionData = regionManager.Add(regionData);
            if (regionData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Region Added with Id " + regionData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Region adding process is failed", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

CanDelete

CanDelete(System.Int64)

Checks to see whether a region can be deleted.

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

  • * Region ID

Parameters

  • regionId. ID of Region to delete.

Returns

True if the region can be deleted safely.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-3 last" runat="server" Text="* Region Id:" />
        <ektronUI:TextField  ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="CanDelete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" 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 Microsoft.Practices.EnterpriseLibrary.Validation; 
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            RegionManager regionManager = new RegionManager();
            long regionId = long.Parse(uxRegionId.Text);


            bool delete = regionManager.CanDelete(regionId);
            if (delete)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Region " + regionId + " can be deleted", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Region " + regionId + " cannot be deleted", Message.DisplayModes.Information);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Delete

Delete(System.Int64)

Deletes a region 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

  • * Region ID

Parameters

  • regionId. ID of region to delete.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-3 last" runat="server" Text="* Region Id:" />
        <ektronUI:TextField  ID="uxRegionId" 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-3" 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.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            RegionManager regionManager = new RegionManager();
            long regionId = int.Parse(uxRegionId.Text);

            regionManager.Delete(regionId);
            MessageUtilities.UpdateMessage(uxMessage, "Region " + regionId + " is 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 region by region 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

  • * Region ID

Parameters

  • regionId. ID of region to retrieve.

Returns

RegionData object.

.aspx code snippet

<ol class="formFields">
     <li class="clearfix">
        <ektronUI:Label ID="uxRegionIDLabel" AssociatedControlID="uxRegionId" CssClass="span-3 last" runat="server" Text="* Region Id :" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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="uxAlpha" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCultureCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEnabled" 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;
using Ektron.Cms.Framework.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            RegionManager regionManager = new RegionManager();
            long regionId=long.Parse(uxRegionId.Text);
            RegionData regionData = regionManager.GetItem(regionId);

            if (regionData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Region with ID " + regionData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxAlpha.Text = "Code : " + regionData.Code;
                uxCultureCode.Text = "Country Id : " + regionData.CountryId;
                uxName.Text = "Name : " + regionData.Name;
                uxEnabled.Text = "Enabled : " + regionData.Enabled;                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Region "+regionId + " 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.RegionCriteria)

Retrieves a list of regions.

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

  • Region Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter regions being retrieved.

Returns

List of regions 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="uxRegionPropertyLabel" AssociatedControlID="uxRegionProperty" CssClass="span-4 last" runat="server" Text="Region Property:" />
        <asp:DropDownList ID="uxRegionProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>Country Id </asp:ListItem>
        </asp:DropDownList>
    </li>
    <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" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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="uxCouponListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Name
                    </th>
                    <th>
                        Country Id
                    </th>
                    <th>
                        Code
                    </th>
                    <th>
                        Enabled
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CountryId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Code")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Enabled")%>
            </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;
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;
            RegionCriteria criteria = new RegionCriteria();

            if (uxRegionProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(RegionProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxRegionProperty.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(RegionProperty.Name, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(RegionProperty.CountryId , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            RegionManager regionManger = new RegionManager();
            List<RegionData> regionList = regionManger.GetList(criteria);

            uxRegionListView.Visible = true;
            uxRegionListView.DataSource = regionList;
            uxRegionListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Update

Update(Ektron.Cms.Commerce.RegionData)

Updates an existing region 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

  • * ID
  • * Name
  • * Country ID
  • * Code

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Label ID="uxRegionNameLabel" AssociatedControlID="uxRegionName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxRegionName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionCountryIdLabel" AssociatedControlID="uxRegionCountryId" CssClass="span-3 last" runat="server" Text="* Country Id:" />
        <ektronUI:TextField  ID="uxRegionCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxRegionCodeLabel" AssociatedControlID="uxRegionCode" CssClass="span-3 last" runat="server" Text="* Code:" />
        <ektronUI:TextField  ID="uxRegionCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionEnabledLabel" AssociatedControlID="uxRegionEnabled" CssClass="span-3 last" runat="server" Text=" Enabled:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxRegionEnabled" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            RegionManager regionManager = new RegionManager();
            bool enabled = false;
            if (uxRegionEnabled.Checked)
            {
                enabled = true ;
            }
            long regionId=long.Parse(uxRegionId.Text);
            RegionData regionData = regionManager.GetItem(regionId);
            if (regionData != null)
            {
                regionData.Code  = uxRegionCode.Text;
                regionData.CountryId = long.Parse(uxRegionCountryId.Text);
                regionData.Name = uxRegionName.Text;
                regionData.Enabled = enabled;
                regionData = regionManager.Update(regionData);
                
                MessageUtilities.UpdateMessage(uxMessage, "Region updated with Id " + regionData.Id, Message.DisplayModes.Success);                
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Data Classes

RegionCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • RegionCriteria()
    public RegionCriteria()
  • RegionCriteria(Ektron.Cms.Commerce.RegionProperty, EkEnumeration.OrderByDirection)
    public RegionCriteria(Ektron.Cms.Commerce.RegionProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the RegionProperty are:

    • AlphaCode
    • CountryId
    • Id
    • IsEnabled
    • Name

RegionData

Namespace

Ektron.Cms.Commerce

Properties

  • Code. Gets or sets the code of the region. This is typically an abbreviation for the name of the region. For example, if you add New Hampshire as a region, you would enter "NH" for this property. Each region must have its own unique code. You cannot have more than one region with the same code. This property is required when creating an region data object.
    public string Code { set; get; }
  • CountryId. Gets or sets the ID of the country to which the region belongs. For example, if you are adding a region to the United States, you would enter "840" for this property. This property is required when creating an region data object.
    public long CountryId { set; get; }
  • Enabled. Gets or sets whether or not the region is enabled for use.
    public bool Enabled { set; get; }
  • Id. Gets or sets the ID of the region.
    public long Id { set; get; }
  • Name. Gets or sets the name of the region. For example, if the region is a US state, you might enter "New Hampshire" for this property. This property is required when creating an region data object.
    public string Name { set; get; }
  • RegionData()
    public RegionData()
  • RegionData(string, long, string, bool)
    public RegionData(string name, long countryId, string code, bool enabled)
  • ToString(). Returns Name of Region.
    public override string ToString()
  • Validate(). Validates the RegionData object is valid for saving. Returns a ValidationResult object with any validation errors.
    public ValidationResults Validate()