AddressManager

The class manages addresses in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.AddressManager

Constructors

  • AddressManager()
  • AddressManager(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 (address)

Add(Ektron.Cms.Commerce.AddressData)

Adds a new address based on information in an AddressData object. AddressData.Id is populated with the newly created 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

  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID
  • * Phone

Parameters

  • addressData. The AddressData object to add.

Returns

Returns added AddressData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressNameLabel" AssociatedControlID="uxAddressName" CssClass="span-5 last" runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressLine1Label" AssociatedControlID="uxAddressLine1" CssClass="span-5 last" runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCityLabel" AssociatedControlID="uxCity" CssClass="span-5 last" runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-5 last" runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPostalCodeLabel" AssociatedControlID="uxPostalCode" CssClass="span-5 last" runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingFromPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIdLabel" AssociatedControlID="uxCountryId" CssClass="span-5 last" runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxPhoneLabel" AssociatedControlID="uxPhone" CssClass="span-5 last" runat="server" Text="* Phone :" />
        <ektronUI:TextField ID="uxPhone" 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="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
        {

            AddressManager addressManager = new AddressManager();
            
            AddressData addressData = new AddressData();
            addressData.Name = uxAddressName.Text;
            addressData.AddressLine1 = uxAddressLine1.Text;
            addressData.City = uxCity.Text;
            addressData.Region = new RegionData { Id = long.Parse(uxRegionId.Text) };
            addressData.PostalCode = uxPostalCode.Text;
            addressData.Phone = uxPhone.Text;
            addressData.Country = new CountryData { Id = int.Parse(uxCountryId.Text) };
            
            addressManager.Add(addressData);
            MessageUtilities.UpdateMessage(uxMessage, "AddressData is added with Id " + addressData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Add (customer ID)

Add(Ektron.Cms.Commerce.AddressData,System.Int64)

Adds a new address based on information in an AddressData object and associates with a customer. AddressData.Id is populated with the newly created 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

  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID
  • * Phone
  • * Customer ID

Parameters

  • addressData. The AddressData object to add.

  • customerId. The ID of customer to which this address belongs.

Returns

Returns added AddressData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressNameLabel" AssociatedControlID="uxAddressName" CssClass="span-5 last" runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressLine1Label" AssociatedControlID="uxAddressLine1" CssClass="span-5 last" runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCityLabel" AssociatedControlID="uxCity" CssClass="span-5 last" runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-5 last" runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPostalCodeLabel" AssociatedControlID="uxPostalCode" CssClass="span-5 last" runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingFromPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIdLabel" AssociatedControlID="uxCountryId" CssClass="span-5 last" runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxPhoneLabel" AssociatedControlID="uxPhone" CssClass="span-5 last" runat="server" Text="* Phone :" />
        <ektronUI:TextField ID="uxPhone" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-5 last" runat="server" Text="* CustomerId :" />
        <ektronUI:TextField ID="uxCustomerId" 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="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
        {

            AddressManager addressManager = new AddressManager();
            long customerId = long.Parse(uxCustomerId.Text);
            AddressData addressData = new AddressData();
            addressData.Name = uxAddressName.Text;
            addressData.AddressLine1 = uxAddressLine1.Text;
            addressData.City = uxCity.Text;
            addressData.Region = new RegionData { Id = long.Parse(uxRegionId.Text) };
            addressData.PostalCode = uxPostalCode.Text;
            addressData.Phone = uxPhone.Text;
            addressData.Country = new CountryData { Id = int.Parse(uxCountryId.Text) };

            long id=addressManager.Add(addressData, customerId).Id;
            MessageUtilities.UpdateMessage(uxMessage, "Customer AddressData is added with Id " + id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Delete

Deletes an address.

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

  • addressId. The ID of the AddressData object to delete.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressIdLabel" AssociatedControlID="uxAddressId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxAddressId" 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(uxAddressId.Text);
            AddressManager addressManager = new AddressManager();
            addressManager.Delete(ID);
            MessageUtilities.UpdateMessage(uxMessage, "AddresssData with Id " + uxAddressId.Text + " 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 an AddressData object by providing 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

  • * ID

Parameters

  • addressId. The ID the of AddressData object to retrieve.

Returns

Returns an AddressData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressIdLabel" AssociatedControlID="uxAddressId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxAddressId" 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>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAddressName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAddressLine1" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxCity" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRegionId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPostalCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCountryId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPhone" 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 addressId = long.Parse(uxAddressId.Text);

            AddressManager addressManager = new AddressManager();
            AddressData addressData = new AddressData();
            addressData = addressManager.GetItem(addressId);
            if (addressData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for address Id " + addressData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxAddressName.Text = "Address Name : " + addressData.Name;
                uxAddressLine1.Text = "AddressLine1 : " + addressData.AddressLine1;
                uxCity.Text = "City : " + addressData.City;
                uxRegionId.Text = "RegionId : " + addressData.Region.Id;
                uxPostalCode.Text = "PostalCode : " + addressData.PostalCode;
                uxCountryId.Text = "CountryId : " + addressData.Country.Id;
                uxPhone.Text = "Phone : " + addressData.Phone;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either address with ID " + addressId + " 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.AddressCriteria)

Retrieves the list of addresses based on the supplied criteria.

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

  • * Address Property
  • * Object Value

Parameters

  • criteria. Criteria used to retrieve the address.

Returns

Returns the list of AddressData object.

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="uxAddressPropertyLabel" AssociatedControlID="uxAddressProperty" CssClass="span-5 last" runat="server" Text="* Address Property:" />
        <asp:DropDownList ID="uxAddressProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>City</asp:ListItem>
            <asp:ListItem>RegionId</asp:ListItem>
            <asp:ListItem>CountryId</asp:ListItem>
            <asp:ListItem>PostalCode</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="uxAddressDataListView" 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>AddressLine1</th>
                    <th>City</th>
                    <th>PostalCode</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("AddressLine1")%>
            </td>
             <td class="devsite-method">
                <%# Eval("City")%>
            </td>
             <td class="devsite-method">
                <%# Eval("PostalCode")%>
            </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;

            AddressManager addressManager = new AddressManager();
            AddressCriteria criteria = new AddressCriteria();

            if (uxAddressProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(AddressProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxAddressProperty.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(AddressProperty.Name, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxAddressProperty.SelectedItem.Text == "City")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(AddressProperty.City, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxAddressProperty.SelectedItem.Text == "RegionId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(AddressProperty.RegionId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxAddressProperty.SelectedItem.Text == "CountryId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(AddressProperty.CountryId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(AddressProperty.PostalCode, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<AddressData> addressDataList = addressManager.GetList(criteria);

            uxAddressDataListView.Visible = true;
            uxAddressDataListView.DataSource = addressDataList;
            uxAddressDataListView.DataBind();

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

Update

Update(Ektron.Cms.Commerce.AddressData)

Updates the supplied Address.

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
  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID
  • * Phone
  • * Customer ID

Parameters

  • addressData. The ID the of AddressData object to retrieve.

Returns

Returns an updated AddressData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressIdLabel" AssociatedControlID="uxAddressId" CssClass="span-5 last" runat="server" Text=" Id:" />
        <ektronUI:TextField ID="uxAddressId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressNameLabel" AssociatedControlID="uxAddressName" CssClass="span-5 last" runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressLine1Label" AssociatedControlID="uxAddressLine1" CssClass="span-5 last" runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCityLabel" AssociatedControlID="uxCity" CssClass="span-5 last" runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-5 last" runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPostalCodeLabel" AssociatedControlID="uxPostalCode" CssClass="span-5 last" runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIdLabel" AssociatedControlID="uxCountryId" CssClass="span-5 last" runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxPhoneLabel" AssociatedControlID="uxPhone" CssClass="span-5 last" runat="server" Text="* Phone :" />
        <ektronUI:TextField ID="uxPhone" 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-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 addressId = long.Parse(uxAddressId.Text);
            AddressManager addressManager = new AddressManager();
            AddressData addressData = new AddressData();
            addressData = addressManager.GetItem(addressId);
            if (addressId > 0 && addressData != null)
            {
                addressData.Name = uxAddressName.Text;
                addressData.AddressLine1 = uxAddressLine1.Text;
                addressData.City = uxCity.Text;
                addressData.Region = new RegionData { Id = long.Parse(uxRegionId.Text) };
                addressData.PostalCode = uxPostalCode.Text;
                addressData.Phone = uxPhone.Text;
                addressData.Country = new CountryData { Id = int.Parse(uxCountryId.Text) };
                addressManager.Update(addressData);
                MessageUtilities.UpdateMessage(uxMessage, "AddressData is Updated with Id " + uxAddressId.Text, Message.DisplayModes.Success);
                
            }               
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid address ID.", Message.DisplayModes.Error);
                
            uxPageMultiView.SetActiveView(uxViewMessage);

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

UpdateOrderAddress

UpdateOrderAddress(Ektron.Cms.Commerce.AddressData,System.Int64,
  System.Boolean,System.Boolean)

Updates an address associated with an order. This update only affects this specific address and does not affect the customer's actual saved address.

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
  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID
  • * Phone
  • * Order ID
  • * Is Shipping
  • * Is Billing

Parameters

  • addressData. Address information to update.
  • orderId. ID of the order for which to update the address.
  • isBilling. If true, updates the billing address for an order.
  • isShipping. If true, updates the shipping address for an order.

Returns

Returns an updated AddressData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressIdLabel" AssociatedControlID="uxAddressId" CssClass="span-5 last" runat="server" Text=" Id:" />
        <ektronUI:TextField ID="uxAddressId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressNameLabel" AssociatedControlID="uxAddressName" CssClass="span-5 last" runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressLine1Label" AssociatedControlID="uxAddressLine1" CssClass="span-5 last" runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCityLabel" AssociatedControlID="uxCity" CssClass="span-5 last" runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-5 last" runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPostalCodeLabel" AssociatedControlID="uxPostalCode" CssClass="span-5 last" runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIdLabel" AssociatedControlID="uxCountryId" CssClass="span-5 last" runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxPhoneLabel" AssociatedControlID="uxPhone" CssClass="span-5 last" runat="server" Text="* Phone :" />
        <ektronUI:TextField ID="uxPhone" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxOrderIdLabel" AssociatedControlID="uxOrderId" CssClass="span-5 last" runat="server" Text="* OrderId :" />
        <ektronUI:TextField ID="uxOrderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsShippingLabel" AssociatedControlID="uxIsShipping" CssClass="span-5 last" runat="server" Text="* IsShipping: " />
            <asp:checkbox ID="uxIsShipping" runat="server" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsBillingLabel" AssociatedControlID="uxIsBilling" CssClass="span-5 last" runat="server" Text="* IsBilling: " />
            <asp:checkbox ID="uxIsBilling" runat="server" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="UpdateOrderAddress"></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 orderId=long.Parse(uxOrderId.Text);
            long addressId = long.Parse(uxAddressId.Text);
            AddressManager addressManager = new AddressManager();
            AddressData addressData = new AddressData();
            addressData = addressManager.GetItem(addressId);
            if (addressId > 0 && addressData != null)
            {
                addressData.Name = uxAddressName.Text;
                addressData.AddressLine1 = uxAddressLine1.Text;
                addressData.City = uxCity.Text;
                addressData.Region = new RegionData { Id = long.Parse(uxRegionId.Text) };
                addressData.PostalCode = uxPostalCode.Text;
                addressData.Phone = uxPhone.Text;
                addressData.Country = new CountryData { Id = int.Parse(uxCountryId.Text) };
                addressManager.UpdateOrderAddress(addressData, orderId,uxIsShipping.Checked,uxIsBilling.Checked);
                MessageUtilities.UpdateMessage(uxMessage, "Order AddressData is Updated with Id " + uxAddressId.Text, Message.DisplayModes.Success);
                
            }               
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid address ID.", Message.DisplayModes.Error);
                
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Data Classes

AddressCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • AddressCriteria()
    public AddressCriteria()
  • AddressCriteria(Ektron.Cms.Common.AddressProperty, EkEnumeration.OrderByDirection)
    public AddressCriteria(Ektron.Cms.Common.AddressProperty orderByField, 
  EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the AddressProperty are:

    • City
    • Company
    • CountryId
    • CustomerId
    • Id
    • IsCommercial
    • Name
    • PostalCode
    • RegionId
    • Validated

AddressData

Namespace

Ektron.Cms.Commerce

Properties

  • AddressData(). Constructor
    public AddressData()
  • AddressData(string, string, Ektron.Cms.Commerce.RegionData, Ektron.Cms.Commerce.CountryData, string, string). Constructor.
    public AddressData(string name, string addressLine1, 
  Ektron.Cms.Commerce.RegionData region, 
  Ektron.Cms.Commerce.CountryData country, 
  string city, string postalcode)
  • AddressData(string, string, Ektron.Cms.Commerce.RegionData, Ektron.Cms.Commerce.CountryData, string, string). Constructor.
    public AddressData(string name, string addressLine1, 
  Ektron.Cms.Commerce.RegionData region, 
  Ektron.Cms.Commerce.CountryData country, 
  string city, string postalCode, bool iscommercial)
  • AddressLine1. Gets or sets the first line of the address. This property is required when creating an address data object.
    public string AddressLine1 { set; get; }
  • AddressLine2. Gets or sets line 2 of address.
    public string AddressLine2 { set; get; }
  • City. Gets or sets the city associated with this address. This property is required when creating an address data object.
    public string City { set; get; }
  • Company. Gets or sets the name of the company associated with this address. For example, if the address is for Ektron, enter "Ektron, Inc." in the property.
    public string Company { set; get; }
  • Country. Gets or sets the country associated with this address.
    public Ektron.Cms.Commerce.CountryData Country { set; get; }
  • Id. Gets or sets the ID of an address.
    public long Id { set; get; }
  • IsCommercial. Gets or sets whether this address is commercial.
    public bool IsCommercial { set; get; }
  • IsValidated. Gets or sets whether this address is validated. Validation can come from third-party services.
    public bool IsValidated { set; get; }
  • Name. Gets or sets the name associated with the address. For example, if you are entering an address for Ivan Tory, enter the name "Ivan Tory" in this property. This property is required when creating an address data object.
    public string Name { set; get; }
  • Phone. Gets or sets the phone number associated with this address.
    public string Phone { set; get; }
  • PostalCode. Gets or sets the postal code associated with this address. This property is required when creating an address data object.
    public string PostalCode { set; get; }
  • Region. Gets or sets the region associated with this address.
    public Ektron.Cms.Commerce.RegionData Region { set; get; }
  • Validate() 
    public ValidationResults Validate()