CatalogEntryManager

The class manipulates the catalog entry data in CMS.

Namespace

Ektron.Cms.Framework.Commerce.CatalogEntryManager

Constructors

  • CatalogEntryManager()
  • CatalogEntryManager(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.EntryData)

Adds a new catalog entry into 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

  • * Title
  • * HTML
  • * Catalog Folder ID
  • * Currency ID
  • * Tax Class ID
  • * Product Type ID

Parameters

  • entryData. The EntryData object to be added.

Returns

Returns added EntryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTitleLabel" AssociatedControlID="uxTitle" CssClass="span-4 last" runat="server" Text="* Title:" />
        <ektronUI:TextField ID="uxTitle" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <asp:Label ID="uxHtmlLabel" AssociatedControlID="uxHtml" CssClass="span-4 last" runat="server" Text="* Html:" />
        <asp:TextBox TextMode="MultiLine" Rows="4"  ID="uxHtml" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxFolderIdLabel" AssociatedControlID="uxFolderId" CssClass="span-4 last" runat="server" Text="* Catalog FolderId:" />
        <ektronUI:TextField ID="uxFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIdLabel" AssociatedControlID="uxCurrencyId" CssClass="span-4 last" runat="server" Text="* CurrencyId:" />
        <ektronUI:TextField ID="uxCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxClassIdLabel" AssociatedControlID="uxTaxClassId" CssClass="span-4 last" runat="server" Text="* TaxClassId:" />
        <ektronUI:TextField ID="uxTaxClassId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxProductTypeIdLabel" AssociatedControlID="uxProductTypeId" CssClass="span-4 last" runat="server" Text="* ProductTypeId:" />
        <ektronUI:TextField ID="uxProductTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </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-4" 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;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long productTypeId = long.Parse(uxProductTypeId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            ProductTypeManager pTypeManager=new ProductTypeManager();
            Pricing pricingManager = new Pricing();

            Criteria<TierPriceProperty> tierCri = new Criteria<TierPriceProperty>();
            tierCri.AddFilter(TierPriceProperty.Id, CriteriaFilterOperator.GreaterThan, 0);
            List<CurrencyPricingData> addlist = new List<CurrencyPricingData>();
            addlist = pricingManager.GetCurrencyPricing(tierCri);
            PricingData priceData = new PricingData()
            {
                CurrencyPricelist = addlist                
            };


            ProductData productData = new ProductData();
            ProductTypeData productTypeData = new Ektron.Cms.Commerce.ProductTypeData();
            productTypeData=pTypeManager.GetItem(productTypeId,true);
            productData.Title = uxTitle.Text;
            productData.Html = uxHtml.Text;
            productData.FolderId = long.Parse(uxFolderId.Text);
            productData.CurrencyId = long.Parse(uxCurrencyId.Text);
            productData.TaxClassId = long.Parse(uxTaxClassId.Text);
            productData.ProductType = productTypeData;
            productData.Pricing = priceData;
            catalogEntryManager.Add(productData);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry Data is added with Id " + productData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Cancel

Cancel(System.Int64)

Undo the last changes of catalog entry item.

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

  • entryId. ID of entry data item.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Cancel"></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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.Cancel(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data with Id " + uxEntryId.Text + " has been cancelled", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

CheckIn

CheckIn(System.Int64)

Check in the catalog entry item.

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

  • entryId. ID of entry data item to be checked in.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="CheckIn"></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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.CheckIn(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data with Id " + uxEntryId.Text + " has been checkin", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

CheckOut

CheckOut(System.Int64)

Check out the catalog entry item.

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

  • entryId. ID of entry data item to be checked out.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="CheckOut"></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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.CheckOut(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data with Id " + uxEntryId.Text + " has been checkout", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a catalog entry based on 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

  • entryId. ID of entry data item to be deleted.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" 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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.Delete(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data with Id " + uxEntryId.Text + "is deleted", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DisableInventory

DisableInventory(System.Int64)

Disables the inventory option specific catalog entry item.

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

  • entryId. ID of the catalog entry item.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="DisableInventory"></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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.DisableInventory(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry inventory with Id " + uxEntryId.Text + " has been disabled", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

EnableInventory

EnableInventory(System.Int64)

Enables the inventory option specific catalog entry item.

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

  • entryId. ID of the catalog entry item.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="EnableInventory"></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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.EnableInventory(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry inventory with Id " + uxEntryId.Text + " has been enabled", 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 single catalog entry in the current language based on the entry's ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • entryId. The ID of catalog entry to be retrieved.

Returns

Entry data object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFolderId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCurrencyId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTaxClassId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsBuyable" 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 entryId = long.Parse(uxEntryId.Text);

            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            ProductData productData = new ProductData();
            productData = (ProductData)catalogEntryManager.GetItem(entryId);
            if (productData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for catalog entry data Id " + productData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxTitle.Text = "Title : " + productData.Title;
                uxFolderId.Text = "FolderId : " + productData.FolderId;
                uxCurrencyId.Text = "CurrencyId : " + productData.Pricing.CurrencyPricelist[0].CurrencyId;
                uxTaxClassId.Text = "TaxClassId : " + productData.TaxClassId;
                uxIsBuyable.Text = "IsBuyable : " + productData.IsBuyable;
               

            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either catalog entry data with ID " + entryId + " does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetList (catalog entries)

GetList(Ektron.Cms.Commerce.CatalogEntryCriteria)

Retrieves a list of EntryData objects based upon 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

  • * Entry Property
  • * Object Value

Parameters

  • criteria. The criteria for retrieving EntryData.

Returns

List of entry data 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="uxEntryPropertyLabel" AssociatedControlID="uxEntryProperty" CssClass="span-4 last" runat="server" Text="* EntryProperty:" />
        <asp:DropDownList ID="uxEntryProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Title</asp:ListItem>
            <asp:ListItem>LanguageId</asp:ListItem>
            <asp:ListItem>CatalogId</asp:ListItem>
            <asp:ListItem>ProductTypeId</asp:ListItem>
            <asp:ListItem>CurrencyId</asp:ListItem>
            <asp:ListItem>TaxClassId</asp:ListItem>
        </asp:DropDownList>
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <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="uxCatalogEntryDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria didn't match the records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                <th>Id</th>
                <th>Title</th>
                <th>FolderId</th>
                <th>CurrencyId</th> 
                <th>TaxClassId</th> 
                <th>IsBuyable</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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FolderId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CurrencyId")%>
            </td>
                <td class="devsite-method">
                <%# Eval("TaxClassId")%>
            </td>
                <td class="devsite-method">
                <%# Eval("IsBuyable")%>
            </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;

            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            CatalogEntryCriteria criteria = new CatalogEntryCriteria();
            if (uxObjectValue.Text == null || uxObjectValue.Text == "")
            {
                MessageUtilities.UpdateMessage(uxMessage, "Enter the criteria object value ", Message.DisplayModes.Error);
                uxPageMultiView.SetActiveView(uxViewMessage);
            }
            else
            {
                if (uxEntryProperty.SelectedItem.Text == "Id")
                {
                    Objectvalue = long.Parse(uxObjectValue.Text);
                    criteria.AddFilter(EntryProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else if (uxEntryProperty.SelectedItem.Text == "Title")
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryProperty.Title, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else if (uxEntryProperty.SelectedItem.Text == "CatalogId")
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryProperty.CatalogId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else if (uxEntryProperty.SelectedItem.Text == "LanguageId")
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryProperty.LanguageId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else if (uxEntryProperty.SelectedItem.Text == "ProductTypeId")
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryProperty.ProductTypeId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else if (uxEntryProperty.SelectedItem.Text == "CurrencyId")
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryProperty.CurrencyId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryProperty.TaxClassId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }

                List<EntryData> entryDataList = catalogEntryManager.GetList(criteria);
                uxCatalogEntryDataListView.Visible = true;
                uxCatalogEntryDataListView.DataSource = entryDataList;
                uxCatalogEntryDataListView.DataBind();

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

GetList (entry attribute)

GetList(Ektron.Cms.Commerce.EntryAttributeCriteria)

Retrieves a list of EntryData objects based upon 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

  • * Entry Attribute Property
  • * Object Value
  • * Attribute Value

Parameters

  • criteria. EntryAttributeCriteria.

Returns

Returns list of entry data 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="uxEntryPropertyLabel" AssociatedControlID="uxEntryProperty" CssClass="span-4 last" runat="server" Text="* EntryAttributeProperty:" />
        <asp:DropDownList ID="uxEntryProperty" runat="server">
            <asp:ListItem>AttributeId</asp:ListItem>
            <asp:ListItem>AttributeName</asp:ListItem>
        </asp:DropDownList>
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAttributeValueLabel" AssociatedControlID="uxAttributeValue" CssClass="span-4 last" runat="server" Text="* AttributeValue:" />
        <ektronUI:TextField ID="uxAttributeValue" 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-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>            
 <asp:ListView ID="uxCatalogEntryDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria didn't match the records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                <th>Id</th>
                <th>Title</th>
                <th>FolderId</th>
                <th>CurrencyId</th> 
                <th>TaxClassId</th> 
                <th>IsBuyable</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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FolderId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CurrencyId")%>
            </td>
                <td class="devsite-method">
                <%# Eval("TaxClassId")%>
            </td>
                <td class="devsite-method">
                <%# Eval("IsBuyable")%>
            </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;

            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            EntryAttributeCriteria criteria = new EntryAttributeCriteria();

            if (uxObjectValue.Text == null || uxObjectValue.Text=="")
            {
                MessageUtilities.UpdateMessage(uxMessage, "Enter the criteria object value ", Message.DisplayModes.Error);
                
            }
            else if (uxAttributeValue.Text == "")
            {
                MessageUtilities.UpdateMessage(uxMessage, "Enter the attribute value", Message.DisplayModes.Error);
                
            }
            else
            {
                if (uxEntryProperty.SelectedItem.Text == "AttributeId")
                {
                    Objectvalue = long.Parse(uxObjectValue.Text);
                    criteria.AddFilter(EntryAttributeCriteriaProperty.AttributeId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else
                {
                    Objectvalue = uxObjectValue.Text;
                    criteria.AddFilter(EntryAttributeCriteriaProperty.AttributeName, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                criteria.AddFilter(EntryAttributeCriteriaProperty.AttributeValue, CriteriaFilterOperator.EqualTo, uxAttributeValue.Text);
                List<EntryData> entryDataList = catalogEntryManager.GetList(criteria);
                uxCatalogEntryDataListView.Visible = true;
                uxCatalogEntryDataListView.DataSource = entryDataList;
                uxCatalogEntryDataListView.DataBind();
              
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Restore

Restore(System.Int64,System.Int64)

Restores a previous version of a catalog entry based on its ID and the version ID to restore.

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
  • * Version ID

Parameters

  • entryId. The ID of the catalog entry to restore.
  • versionId. Version ID to restore.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxVersionIdLabel" AssociatedControlID="uxVersionId" CssClass="span-3 last" runat="server" Text="* VersionId:" />
        <ektronUI:TextField ID="uxVersionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <div class="ektronTopSpace"></div>
    <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">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFolderId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCurrencyId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTaxClassId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsBuyable" 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 entryId = long.Parse(uxEntryId.Text);
            long versionId = long.Parse(uxVersionId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.Restore(entryId, versionId);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data has been restored", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Submit

Submit(System.Int64)

Submits the catalog entry item for publish.

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

  • entryId. ID of catalog entry item.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryIdId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Submit"></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(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            catalogEntryManager.Submit(ID);
            MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data with Id " + uxEntryId.Text + " has been submitted", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Commerce.EntryData)

Updates an existing catalog entry data.

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

  • * Title
  • * HTML
  • * Currency ID
  • * Tax Class ID

Parameters

  • entryData. The EntryData object to be updated.

Returns

Returns updated EntryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryId" CssClass="span-4 last" runat="server" Text=" Id:" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxTitleLabel" AssociatedControlID="uxTitle" CssClass="span-4 last" runat="server" Text="* Title:" />
        <ektronUI:TextField ID="uxTitle" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <asp:Label ID="uxHtmlLabel" AssociatedControlID="uxHtml" CssClass="span-4 last" runat="server" Text="* Html:" />
        <asp:TextBox TextMode="MultiLine" Rows="4"  ID="uxHtml" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIdLabel" AssociatedControlID="uxCurrencyId" CssClass="span-4 last" runat="server" Text="* CurrencyId:" />
        <ektronUI:TextField ID="uxCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxClassIdLabel" AssociatedControlID="uxTaxClassId" CssClass="span-4 last" runat="server" Text="* TaxClassId:" />
        <ektronUI:TextField ID="uxTaxClassId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </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 entryId = long.Parse(uxEntryId.Text);
            CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
            ProductData productData = new ProductData();
            productData = (ProductData)catalogEntryManager.GetItem(entryId);

            if (entryId > 0 && productData != null)
            {
                productData.Title = uxTitle.Text;
                productData.Html = uxHtml.Text;
                productData.CurrencyId = long.Parse(uxCurrencyId.Text);
                productData.TaxClassId = long.Parse(uxTaxClassId.Text);

                if (productData.Status != "O")
                {
                    catalogEntryManager.CheckOut(productData.Id);
                }
                catalogEntryManager.Update(productData);
                MessageUtilities.UpdateMessage(uxMessage, "Catalog entry data is updated with Id " + uxEntryId.Text, Message.DisplayModes.Success);
                
            }               
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid catalog entry ID.", Message.DisplayModes.Error);
                
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Data Classes

CatalogEntryCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • CatalogEntryCriteria()
    public CatalogEntryCriteria()
  • CatalogEntryCriteria(Ektron.Cms.Commerce.EntryProperty, EkEnumeration.OrderByDirection)
    public CatalogEntryCriteria(Ektron.Cms.Commerce.EntryProperty 
  entryProperty, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the EntryPropertyare:

    • AverageRating
    • CatalogId
    • CollItemsDisplayOrder
    • ContentStatus
    • CurrencyId
    • EndDate
    • EntryType
    • GoLive
    • Html
    • Id
    • IsArchived
    • IsBuyable
    • IsPublished
    • IsSearchable
    • LanguageId
    • LastEditDate
    • LastEditorFirstName
    • LasteditorLastName
    • ListPrice
    • Media
    • NumberRated
    • ProductTypeId
    • ReturnEntryPricebookprice
    • SalePrice
    • Sku
    • Status
    • Summary
    • TaxClassId
    • TaxItemDisplayOrder
    • Title
    • ViewCount

EntryAttributeCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • AddAttributeFilter(string, Ektron.Cms.Common.CriteriaFilterOperator, object)
    public Ektron.Cms.Common.CriteriaFilterGroup<EntryAttributeCriteriaProperty>
  AddAttributeFilter(string attributeName, 
    Ektron.Cms.Common.CriteriaFilterOperator filterOperator, 
    object value)
  • AddAttributeFilter(long, Ektron.Cms.Common.CriteriaFilterOperator, object)
    public 
  Ektron.Cms.Common.CriteriaFilterGroup<EntryAttributeCriteriaProperty>
  AddAttributeFilter(long attributeId, 
    Ektron.Cms.Common.CriteriaFilterOperator filterOperator, 
    object value)
  • AddFilter(Ektron.Cms.Commerce.EntryAttributeCriteriaProperty, Ektron.Cms.Common.CriteriaFilterOperator, object)
    public override 
  Ektron.Cms.Common.CriteriaFilter<EntryAttributeCriteriaProperty>
  AddFilter(Ektron.Cms.Commerce.EntryAttributeCriteriaProperty field,
    Ektron.Cms.Common.CriteriaFilterOperator filterOperator, 
    object value)
  • EntryAttributeCriteria() 
    public EntryAttributeCriteria()
  • EntryAttributeCriteria(Ektron.Cms.Commerce.EntryAttributeCriteriaProperty, EkEnumeration.OrderByDirection)
    public 
  EntryAttributeCriteria(Ektron.Cms.Commerce.EntryAttributeCriteriaProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the EntryAttributeCriteriaProperty are:

    • AttributeDataType
    • AttributeDisplayOrder
    • AttributeId
    • AttributeName
    • AttributeValue
    • CatalogId
    • CurrencyId
    • EndDate
    • EntryId
    • EntryType
    • GoLive
    • IsArchived
    • IsBuyable
    • IsPublished
    • IsSearchable
    • LanguageId
    • LastEditDate
    • LastEditorFirstName
    • LasteditorLastName
    • ListPrice
    • PricebookId
    • PricebookPrice
    • ProductTypeId
    • SalePrice
    • Sku
    • TaxClassId
    • Title
  • FindAttributeValueFilter(string)
    public Ektron.Cms.Common.CriteriaFilter<EntryAttributeCriteriaProperty> 
  FindAttributeValueFilter(string attributeName)
  • FindAttributeValueFilter(long)
    public Ektron.Cms.Common.CriteriaFilter<EntryAttributeCriteriaProperty> 
  FindAttributeValueFilter(long attributeId)

EntryData

Namespace

Ektron.Cms.Commerce

Properties

  • AnalyticsInfo
    public AnalyticsData AnalyticsInfo { set; get; }
  • Attributes. Gets or sets the attributes of the Catalog Entry.
    public System.Collections.Generic.List<EntryAttributeData> 
  Attributes { set; get; }
  • Comment
    public string Comment { set; get; }
  • ContentStatus. The status of the content information.
    public string ContentStatus { set; get; }
  • CurrencyId. Gets or sets the Id of the currency used for the current Sale and List prices.
    public long CurrencyId { set; get; }
  • DateModified
    public System.DateTime DateModified { set; get; }
  • Dimensions. Gets or sets the dimensions of the product. Used for shipping.
    public Ektron.Cms.Commerce.Dimensions Dimensions { set; get; }
  • DisableInventoryManagement. Gets or sets the disable inventory management flag. If true, this product does not track inventory and no inventory management is performed.
    public bool DisableInventoryManagement { set; get; }
  • EndDate. Get or sets the enddate of the EntryData object. Returns the datetime of the entry enddate.
    public System.DateTime EndDate { set; get; }
  • EndDateAction
    public int EndDateAction { set; get; }
  • EntryData()
    public EntryData()
  • EntryData(EkEnumeration.CatalogEntryType)
    public EntryData(EkEnumeration.CatalogEntryType entryType)
  • EntryData(int, EkEnumeration.CatalogEntryType)
    public 
  EntryData(int languageId, EkEnumeration.CatalogEntryType 
  entryType)
  • EntryType. The type of entry. Returns an integer of the entry quantity multiple.
    public virtual EkEnumeration.CatalogEntryType EntryType 
  { set; get; }
  • FolderId. Gets or sets the folder ID of the EntryData object. Returns the ID of the entry folder.
    public long FolderId { set; get; }
  • GoLive. Get or sets the golive of the EntryData object. Returns the datetime of the entry golive.
    public System.DateTime GoLive { set; get; }
  • Html. Get or sets the HTML or XML of the EntryData object. Returns the string of the entry HTML.
    public string Html { set; get; }
  • Id. Gets or sets the ID of the EntryData object. Returns the ID of the entry title.
    public long Id { set; get; }
  • Image
    public string Image { set; get; }
  • Imagethumbnail
    public string ImageThumbnail { set; get; }
  • IsArchived. Get or sets the Archive flag of the EntryData object.
    public bool IsArchived { set; get; }
  • IsAvailable
    public bool IsAvailable { set; get; }
  • IsBuyable. Get or sets whether the entry is buyable. Returns a Boolean of the entry flag Buyable.
    public bool IsBuyable { set; get; }
  • IsMarkedForDeletion. Get or sets the MarkForDeletion flag on the EntryData object. Returns a Boolean of the entry flag MarkForDeletion.
    public bool IsMarkedForDeletion { set; get; }
  • IsPublished. 
    public bool IsPublished { set; get; }
  • IsSearchable. Gets or sets whether the entry is searchable for the object. True = searchable. Returns a boolean based on whether the entry is searchable. * True = entry is searchable. * False = entry is not searchable.
    public bool IsSearchable { set; get; }
  • IsTangible. Indicates if this product is a tangible good. Returns a Boolean value indicating if this product is a tangible good.
    public bool IsTangible { get; }
  • LanguageId. Gets or sets the language of the EntryData object.
    public int LanguageId { set; get; }
  • LastEditorFirstName. 
    public string LastEditorFirstName { set; get; }
  • LastEditorId
    public long LastEditorId { set; get; }
  • LastEditorLastName
    public string LastEditorLastName { set; get; }
  • ListPrice. Gets the current List price from the Pricing object. To set an item's price, Use the Pricing property. Create a TierPrice with a quantity of 1. Use the PricingData(CurrencyId, SalePrice, ListPrice) constructor.
    public decimal ListPrice { get; }
  • Media
    public Ektron.Cms.MediaGalleryData Media { set; get; }
  • Metadata
    public System.Collections.Generic.List<ContentMetaData> 
  Metadata { set; get; }
  • NumberSold. Gets or sets the Number Sold for this entry. Returns a content item's Quicklink information.
    public long NumberSold { set; get; }
  • Pricing. The entry pricing, including currencies and quantity. Returns the pricing data of the catalog entry.
    public Ektron.Cms.Commerce.PricingData Pricing { set; get; }
  • ProductType
    public Ektron.Cms.Commerce.ProductTypeData ProductType 
  { set; get; }
  • QuantityMultiple. The catalog has these number of items in it. Returns the integer of the entry quantity multiple.
    public int QuantityMultiple { set; get; }
  • Quicklink. Gets or sets the entry's Quicklink. Returns a content item's Quicklink information.
    public string Quicklink { set; get; }
  • SalePrice. Gets the current Sale price from the Pricing object. To set an item's sale price, Use the Pricing property. Create a TierPrice with a quantity of 1. Use the PricingData(CurrencyId, SalePrice, ListPrice) constructor.
    public decimal SalePrice { get; }
  • Sku. Get or sets the sku of the EntryData object. Returns the string of the entry SKU.
    public string Sku { set; get; }
  • Status. The status of the entry information.
    public string Status { set; get; }
  • StatusLanguage. The language that the entry is checked out to, if any.
    public int StatusLanguage { set; get; }
  • Summary. Get or sets the summary of the EntryData object. Returns the string of the entry summary.
    public string Summary { set; get; }
  • TaxClassId
    public long TaxClassId { set; get; }
  • TemplateId
    public long TemplateId { set; get; }
  • Title. Get or sets the title of the EntryData object. Returns the string of the entry URL.
    public string Title { set; get; }
  • Url. Get or sets the url of the EntryData object. Returns the string of the entry URL.
    public string Url { set; get; }
  • VersionId. The version Id of the catalog entry. 0 is the current version.
    public long VersionId { set; get; }
  • Weight. Gets or sets the weight of the product. Used for shipping.
    public Ektron.Cms.Commerce.Weight Weight { set; get; }