ExchangeRateManager

The class manages commerce exchange rates in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.ExchangeRateManager

Constructors

  • ExchangeRateManager()
  • ExchangeRateManager(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.ExchangeRateData)

Adds a new exchange rate 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

  • * Base Currency ID
  • * Exchange Currency ID
  • Rate
  • * Effective Date

Parameters

  • exchangeRateData. Exchange rate data to be added.

Returns

ExchangeRateData object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxBaseCurrencyIdLabel" AssociatedControlID="uxBaseCurrencyId" CssClass="span-3 last" runat="server" Text="* BaseCurrency Id:" />
        <ektronUI:TextField  ID="uxBaseCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxExchangeCurrencyIdLabel" AssociatedControlID="uxExchangeCurrencyId" CssClass="span-3 last" runat="server" Text="* ExchangeCurrency Id:" />
        <ektronUI:TextField  ID="uxExchangeCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyRateLabel" AssociatedControlID="uxCurrencyRate" CssClass="span-3 last" runat="server" Text=" Rate:" />
        <ektronUI:TextField  ID="uxCurrencyRate" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Label ID="uxEffectiveDateLabel" AssociatedControlID="uxEffectiveDate" CssClass="span-3 last" runat="server" Text="* EffectiveDate:" />
        <ektronUI:DatePicker Rows="3" ID="uxEffectiveDate" CssClass="span-4" runat="server"
            Text="MM/DD/YYYY" ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxEffectiveDateTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxEffectiveDatePeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </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
        {
            ExchangeRateManager exchangeRateManager = new ExchangeRateManager();            
            string strEffectiveDate = uxEffectiveDate.Text + " " + uxEffectiveDateTime.SelectedItem.Text + ":00:00 " + uxEffectiveDatePeriod.SelectedItem.Text;
            DateTime EffectiveDate = DateTime.Parse(strEffectiveDate);

            ExchangeRateData exchangeRateData = new ExchangeRateData()
            {
                BaseCurrencyId = int.Parse(uxBaseCurrencyId.Text),
                ExchangeCurrencyId = int.Parse(uxExchangeCurrencyId.Text),
                Rate = decimal.Parse(uxCurrencyRate.Text),
                EffectiveDate = EffectiveDate,
            };

            exchangeRateManager.Add(exchangeRateData);
            
            MessageUtilities.UpdateMessage(uxMessage, "ExchangeRate is Added." , Message.DisplayModes.Success);
                        
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Delete

Delete(Ektron.Cms.Commerce.ExchangeRateData)

Deletes an exchange rate 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

  • * Base Currency ID
  • * Exchange Currency ID
  • * Effective Date

Parameters

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxBaseCurrencyIdLabel" AssociatedControlID="uxBaseCurrencyId" CssClass="span-3 last" runat="server" Text="* BaseCurrency Id:" />
        <ektronUI:TextField  ID="uxBaseCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxExchangeCurrencyIdLabel" AssociatedControlID="uxExchangeCurrencyId" CssClass="span-3 last" runat="server" Text="* ExchangeCurrency Id:" />
        <ektronUI:TextField  ID="uxExchangeCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>     
    <li class="clearfix">
        <ektronUI:Label ID="uxEffectiveDateLabel" AssociatedControlID="uxEffectiveDate" CssClass="span-3 last" runat="server" Text="* EffectiveDate:" />
        <ektronUI:DatePicker Rows="3" ID="uxEffectiveDate" CssClass="span-4" runat="server"
            Text="MM/DD/YYYY" ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxEffectiveDateTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxEffectiveDatePeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </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.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            ExchangeRateManager exchangeRateManager = new ExchangeRateManager();
            string strEffectiveDate = uxEffectiveDate.Text + " " + uxEffectiveDateTime.SelectedItem.Text + ":00:00 " + uxEffectiveDatePeriod.SelectedItem.Text;
            DateTime EffectiveDate = DateTime.Parse(strEffectiveDate);

            ExchangeRateData exchangeRateData = new ExchangeRateData()
            {
                BaseCurrencyId = int.Parse(uxBaseCurrencyId.Text),
                ExchangeCurrencyId = int.Parse(uxExchangeCurrencyId.Text),                
                EffectiveDate = EffectiveDate,
            };

            exchangeRateManager.Delete(exchangeRateData);

            MessageUtilities.UpdateMessage(uxMessage, "ExchangeRate is Deleted.", Message.DisplayModes.Success);

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

GetCurrentExchangeRate

GetCurrentExchangeRate()

Retrieves the current exchange rate.

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.

Returns

ExchangeRateData object retrieved.

.aspx code snippet

<ol class="formFields">    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetCurrentExchangeRate"></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="uxBaseCurrencyId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxExchangeId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEffectiveDate" 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
        {
            ExchangeRateManager exchangeRateManager = new ExchangeRateManager();            
            ExchangeRateData exchangeRateData = exchangeRateManager.GetCurrentExchangeRate();

            if (exchangeRateData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for ExchangeRate with Exchange CurrencyId " + exchangeRateData.ExchangeCurrencyId.ToString() + " are below", Message.DisplayModes.Success);
                uxBaseCurrencyId.Text = "Base CurrencyId : " + exchangeRateData.BaseCurrencyId;
                uxExchangeId.Text = "Exchange CurrencyId : " + exchangeRateData.ExchangeCurrencyId;
                uxRate.Text = "Rate : " + exchangeRateData.Rate;
                uxEffectiveDate.Text = "Effective Date : " + exchangeRateData.EffectiveDate;                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Current exchange data does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetCurrentExchangeRate (ID)

GetCurrentExchangeRate(System.Int32)

Retrieves the current exchange rate by exchange currency 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

  • * Exchange Currency ID

Parameters

  • exchangeCurrencyId. ID of exchange rate to retrieve.

Returns

ExchangeRateData object retrieved.

.aspx code snippet

<ol class="formFields">
     <li class="clearfix">
        <ektronUI:Label ID="uxExchangeCurrencyIDLabel" AssociatedControlID="uxExchangeCurrencyId" CssClass="span-3 last" runat="server" Text="*Exchange CurrencyId:" />
        <ektronUI:TextField ID="uxExchangeCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetCurrentExchangeRate"></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="uxBaseCurrencyId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxExchangeId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEffectiveDate" 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
        {
            ExchangeRateManager exchangeRateManager = new ExchangeRateManager();
            int exchangeRateId=int.Parse(uxExchangeCurrencyId.Text);
            ExchangeRateData exchangeRateData = exchangeRateManager.GetCurrentExchangeRate(exchangeRateId);

            if (exchangeRateData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for ExchangeRate with Exchange CurrencyId " + exchangeRateData.ExchangeCurrencyId.ToString() + " are below", Message.DisplayModes.Success);
                uxBaseCurrencyId.Text = "Base CurrencyId : " + exchangeRateData.BaseCurrencyId;
                uxExchangeId.Text = "Exchange CurrencyId : " + exchangeRateData.ExchangeCurrencyId;
                uxRate.Text = "Rate : " + exchangeRateData.Rate;
                uxEffectiveDate.Text = "Effective Date : " + exchangeRateData.EffectiveDate;                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "ExchangeRate " + exchangeRateId + " does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetCurrentList

GetCurrentList(Ektron.Cms.Commerce.ExchangeRateCriteria)

Retrieves a list of current exchange rates.

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

  • Exchange Rate Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter exchange rates being retrieved.

Returns

List of exchange rates 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="uxExchangeRatePropertyLabel" AssociatedControlID="uxExchangeRateProperty" CssClass="span-4 last" runat="server" Text="ExchangeRate Property:" />
        <asp:DropDownList ID="uxExchangeRateProperty" runat="server">
            <asp:ListItem>BaseCurrencyId</asp:ListItem>
            <asp:ListItem>ExchangeCurrencyId</asp:ListItem>
            <asp:ListItem>Rate </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="GetCurrentList"></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="uxExchangeRateListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Base CurrencyId
                    </th>
                    <th>
                       Exchange CurrencyId
                    </th>
                    <th>
                        Rate
                    </th>
                    <th>
                       Effective Date
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("BaseCurrencyId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ExchangeCurrencyId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Rate")%>
            </td>
            <td class="devsite-method">
                <%# Eval("EffectiveDate")%>
            </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;
            ExchangeRateCriteria criteria = new ExchangeRateCriteria();

            if (uxExchangeRateProperty.SelectedItem.Text == "BaseCurrencyId")
            {
                Objectvalue = int.Parse(uxObjectValue.Text);
                criteria.AddFilter(ExchangeRateProperty.BaseCurrencyId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxExchangeRateProperty.SelectedItem.Text == "ExchangeCurrencyId")
            {
                Objectvalue = int.Parse(uxObjectValue.Text);
                criteria.AddFilter(ExchangeRateProperty.ExchangeCurrencyId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue =Decimal.Parse(uxObjectValue.Text);
                criteria.AddFilter(ExchangeRateProperty.Rate, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            ExchangeRateManager exchangeRateManger = new ExchangeRateManager();
            List<ExchangeRateData> exchangeRateList = exchangeRateManger.GetCurrentList(criteria);

            uxExchangeRateListView.Visible = true;
            uxExchangeRateListView.DataSource = exchangeRateList;
            uxExchangeRateListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetList

GetList(Ektron.Cms.Commerce.ExchangeRateCriteria)

Retrieves a list of exchange rates.

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

  • Exchange Rate Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter exchange rates being retrieved.

Returns

List of exchange rates 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="uxExchangeRatePropertyLabel" AssociatedControlID="uxExchangeRateProperty" CssClass="span-4 last" runat="server" Text="ExchangeRate Property:" />
        <asp:DropDownList ID="uxExchangeRateProperty" runat="server">
            <asp:ListItem>BaseCurrencyId</asp:ListItem>
            <asp:ListItem>ExchangeCurrencyId</asp:ListItem>
            <asp:ListItem>Rate </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="uxExchangeRateListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Base CurrencyId
                    </th>
                    <th>
                       Exchange CurrencyId
                    </th>
                    <th>
                        Rate
                    </th>
                    <th>
                       Effective Date
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("BaseCurrencyId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ExchangeCurrencyId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Rate")%>
            </td>
            <td class="devsite-method">
                <%# Eval("EffectiveDate")%>
            </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;
            ExchangeRateCriteria criteria = new ExchangeRateCriteria();

            if (uxExchangeRateProperty.SelectedItem.Text == "BaseCurrencyId")
            {
                Objectvalue = int.Parse(uxObjectValue.Text);
                criteria.AddFilter(ExchangeRateProperty.BaseCurrencyId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxExchangeRateProperty.SelectedItem.Text == "ExchangeCurrencyId")
            {
                Objectvalue = int.Parse(uxObjectValue.Text);
                criteria.AddFilter(ExchangeRateProperty.ExchangeCurrencyId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue =Decimal.Parse(uxObjectValue.Text);
                criteria.AddFilter(ExchangeRateProperty.Rate, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            ExchangeRateManager exchangeRateManger = new ExchangeRateManager();
            List<ExchangeRateData> exchangeRateList = exchangeRateManger.GetList(criteria);

            uxExchangeRateListView.Visible = true;
            uxExchangeRateListView.DataSource = exchangeRateList;
            uxExchangeRateListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Update

Update(Ektron.Cms.Commerce.ExchangeRateData)

Updates an existing exchange rate 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

  • * Base Currency ID
  • * Exchange Currency ID
  • * Effective Date
  • Rate

Parameters

Returns

Exchange rate data object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxBaseCurrencyIdLabel" AssociatedControlID="uxBaseCurrencyId" CssClass="span-3 last" runat="server" Text="* BaseCurrency Id:" />
        <ektronUI:TextField  ID="uxBaseCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxExchangeCurrencyIdLabel" AssociatedControlID="uxExchangeCurrencyId" CssClass="span-3 last" runat="server" Text="* ExchangeCurrency Id:" />
        <ektronUI:TextField  ID="uxExchangeCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>           
    <li class="clearfix">
        <ektronUI:Label ID="uxEffectiveDateLabel" AssociatedControlID="uxEffectiveDate" CssClass="span-3 last" runat="server" Text="* EffectiveDate:" />
        <ektronUI:DatePicker Rows="3" ID="uxEffectiveDate" CssClass="span-4" runat="server"
            Text="MM/DD/YYYY" ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxEffectiveDateTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxEffectiveDatePeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>       
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyRateLabel" AssociatedControlID="uxCurrencyRate" CssClass="span-3 last" runat="server" Text=" Rate:" />
        <ektronUI:TextField  ID="uxCurrencyRate" 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
        {
            ExchangeRateManager exchangeRateManager = new ExchangeRateManager();
            string strEffectiveDate = uxEffectiveDate.Text + " " + uxEffectiveDateTime.SelectedItem.Text + ":00:00 " + uxEffectiveDatePeriod.SelectedItem.Text;
            DateTime EffectiveDate = DateTime.Parse(strEffectiveDate);
                        
            ExchangeRateData exchangeRateData = new ExchangeRateData()
            {
                BaseCurrencyId = int.Parse(uxBaseCurrencyId.Text),
                ExchangeCurrencyId = int.Parse(uxExchangeCurrencyId.Text),
                Rate = decimal.Parse(uxCurrencyRate.Text),
                EffectiveDate = EffectiveDate,
            };

            exchangeRateManager.Update(exchangeRateData);

            MessageUtilities.UpdateMessage(uxMessage, "ExchangeRate is Updated.", Message.DisplayModes.Success);

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

Data Classes

ExchangeRateCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • ExchangeRateCriteria()
    public ExchangeRateCriteria()
  • ExchangeRateCriteria(Ektron.Cms.Commerce.ExchangeRateProperty, EkEnumeration.OrderByDirection)
    public ExchangeRateCriteria(Ektron.Cms.Commerce.ExchangeRateProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the ExchangeRateProperty are:

    • BaseCurrencyId
    • EffectiveDate
    • ExchangeCurrencyId
    • Rate

ExchangeRateData

Namespace

Ektron.Cms.Commerce

Properties

  • BaseCurrency. Gets or sets the Currency Id for the base currency. This is the currency that is being used as the basis for the exchange rate. If you are converting from USD to AUD, USD is the base currency.
    public int BaseCurrencyId { set; get; }
  • ConvertPrice(decimal). Converts a pric ein the base currency to a price in the exchange currency using the rate defined.
    public decimal ConvertPrice(decimal basePrice)
  • EffectiveDate. Gets or sets the date and time in which this rate becomes effective.
    public System.DateTime? EffectiveDate { set; get; }
  • ExchangeCurrencyId. Gets or sets the Currency Id for the exchange currency. This is the currency that the currency amount is being converted to. If you are converting from USD to AUD, AUD is the exchange currency.
    public int ExchangeCurrencyId { set; get; }
  • ExchangeRateData
    public ExchangeRateData()
  • ExchangeRateData(int, int, decimal, System.DateTime?)
    public ExchangeRateData(int baseCurrencyId, 
  int exchangeCurrencyId, decimal rate, 
  System.DateTime? effectiveDate)
  • ExchangeCurrencyId. Gets or sets the Currency Id for the exchange currency. This is the currency that the currency amount is being converted to. If you are converting from USD to AUD, AUD is the exchange currency. 
    public int ExchangeCurrencyId { set; get; }
  • Rate. Gets or sets the actual exchange rate between to currencies. This is the rate applied to base currency to convert it to exchange currency.
    public decimal Rate { set; get; }
  • Validate(). Validates the ExchangeRate data object for saving. Returns a ValidationResult object with results.
    public ValidationResults Validate()