FavoriteTaxonomyManager

The FavoriteTaxonomyManager class manages user favorite taxonomies.

Ektron’s taxonomy is a content-level categorization system that uses one-to-many relationships to create a scalable organization of content. Content is categorized in the database by how it relates to multiple categories, allowing it to be accessed in multiple ways for multiple purposes. The hierarchy of the content is arranged from the general to the specific, and there may be multiple “routes” that define the content at the end of the hierarchy.

Namespace

Ektron.Cms.Framework.Community.FavoriteTaxonomyManager

Constructors

  • FavoriteTaxonomyManager()
  • FavoriteTaxonomyManager(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.
  • FavoriteFolderManagerService. Returns an instance of the business objects task manager service.
  • 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.Community.FavoriteTaxonomyData)

Adds a favorite taxonomy.

When you add the FavoriteTaxonomyData object, the method returns a favorite taxonomy ID object.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Title
  • * Parent ID (Taxonomy ID)
  • Description

Parameters

  • favoriteTaxonomyData. The FavoriteTaxonomyData object to add

.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="Favorites"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxParentIdLabel" AssociatedControlID="uxParentId" CssClass="span-4 last" runat="server" Text="* Parent Id(Taxonomy Id):" />
        <ektronUI:TextField ID="uxParentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"/>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-4 last" runat="server" Text=" Description:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" 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.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            FavoriteTaxonomyManager favoritetaxonomyManager = new FavoriteTaxonomyManager();
          
            long taxonomyId = long.Parse(uxParentId.Text);
            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = 100;

            Ektron.Cms.Community.FavoriteTaxonomyData favoriteTaxonomyData = favoritetaxonomyManager.GetTree(taxonomyId, 3, true, pagingInfo);

            if (favoriteTaxonomyData != null)
            {
                Ektron.Cms.Community.FavoriteTaxonomyData favoriteTaxonomyData1 = new Ektron.Cms.Community.FavoriteTaxonomyData()
                {
                    Name = uxTitle.Text,
                    ParentId = taxonomyId,
                    Description = uxDescription.Text, 
                };

                favoritetaxonomyManager.Add(favoriteTaxonomyData1);
                MessageUtilities.UpdateMessage(uxMessage, "Favorite taxonomy Added with Id " + favoriteTaxonomyData.Id, Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "please enter valid parent id (taxonomy id).", Message.DisplayModes.Error);
                return;
            }
            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a favorite taxonomy from the CMS.

Authenticated users

  • CMS Administrators

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

  • id. The favorite taxonomy ID to be deleted.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteFolderIdLabel" AssociatedControlID="uxFavoriteFolderId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxFavoriteFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long favoriteTaxonomyId = long.Parse(uxFavoriteFolderId.Text);

            FavoriteTaxonomyManager favoritetaxonomyManager = new FavoriteTaxonomyManager();
            favoritetaxonomyManager.Delete(favoriteTaxonomyId);

            MessageUtilities.UpdateMessage(uxMessage, "Favorite taxonomy deleted.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves the properties of a specific TaxonomyData object.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * ID

Parameters

  • id. ID of the favorite taxonomy to retrieve. Internally the folder is stored as Taxonomy so this is the corresponding taxonomy ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteFolderIdLabel" AssociatedControlID="uxFavoriteFolderId" CssClass="span-5 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxFavoriteFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxParentId" 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.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long favoriteTaxonomyId = long.Parse(uxFavoriteFolderId.Text);

            FavoriteTaxonomyManager favoriteTaxonomyManager = new FavoriteTaxonomyManager();
            Ektron.Cms.Community.FavoriteTaxonomyData favoriteTaxonomyData = favoriteTaxonomyManager.GetItem(favoriteTaxonomyId);

            if (favoriteTaxonomyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Details for favorite taxonomy with ID " + favoriteTaxonomyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + favoriteTaxonomyData.Name;
                uxParentId.Text = "Parent Id : " + favoriteTaxonomyData.ParentId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Favorite taxonomy does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetTree

GetTree(System.Int64,System.Int32,System.Boolean,Ektron.Cms.PagingInfo)

Retrieves the taxonomy tree for a favorite.

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
  • * Depth
  • * Include Items
  • * Records Per Page

Parameters

  • id. The FavoriteTaxonomyData ID to be retrieved. Internally the folder is stored as Taxonomy so this is the corresponding taxonomy ID.
  • depth. The FavoriteTaxonomyData structure depth to retrieve.
  • includeItems. Set whether the returned object contains included items.
  • pagingInfo. Set paging details.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteFolderIdLabel" AssociatedControlID="uxFavoriteFolderId" CssClass="span-5 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxFavoriteFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDepthLabel" AssociatedControlID="uxDepth" CssClass="span-5 last" runat="server" Text="* Depth :" />
        <ektronUI:TextField ID="uxDepth" CssClass="span-6" Text="3" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIncludeItemsLabel" AssociatedControlID="uxIncludeItems" CssClass="span-5 last" runat="server" Text="* Include Items:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxIncludeItems" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRecordsPerPageLabel1" AssociatedControlID="uxRecordsPerPage" CssClass="span-5 last" runat="server" Text="* Records Per Page :" />
        <ektronUI:TextField ID="uxRecordsPerPage" CssClass="span-6" Text="100" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxParentId" 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.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long favoriteTaxonomyId = long.Parse(uxFavoriteFolderId.Text);

            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = int.Parse(uxRecordsPerPage.Text);

            FavoriteTaxonomyManager favoriteTaxonomyManager = new FavoriteTaxonomyManager();
            Ektron.Cms.Community.FavoriteTaxonomyData favoriteTaxonomyData = favoriteTaxonomyManager.GetTree(favoriteTaxonomyId, int.Parse(uxDepth.Text), uxIncludeItems.Checked, pagingInfo);

            if (favoriteTaxonomyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for favorite taxonomy with ID " + favoriteTaxonomyData.Id.ToString() + " are below.", Message.DisplayModes.Success);
                uxName.Text = "Name : " + favoriteTaxonomyData.Name;
                uxParentId.Text = "Parent Id : " + favoriteTaxonomyData.ParentId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Favorite taxonomy does not exist. ", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetUserTaxonomy

GetUserTaxonomy(System.Int64)

Retrieves the taxonomy tree for a favorite.

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

  • * User ID

Parameters

  • userId. The user ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last" runat="server" Text="* User Id :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get User Taxonomy"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxParentId" 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.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long userId = long.Parse(uxUserId.Text);

            FavoriteTaxonomyManager favoriteTaxonomyrManager = new FavoriteTaxonomyManager();
            Ektron.Cms.Community.FavoriteTaxonomyData favoriteTaxonomyData = favoriteTaxonomyrManager.GetUserTaxonomy(userId);

            if (favoriteTaxonomyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Details for favorite taxonomy with ID " + favoriteTaxonomyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + favoriteTaxonomyData.Name;
                uxParentId.Text = "Parent Id : " + favoriteTaxonomyData.ParentId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Favorite taxonomy does not exist. ", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.FavoriteTaxonomyData)

Updates an existing favorite taxonomy item 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

  • * Favorite Taxonomy ID
  • Title
  • Description

Parameters

Remarks

Validate the favorite taxonomy item with GetItem() before you update the properties. Then, call Update with your modified FavoriteTaxonomyData object.

NOTE: You cannot change all properties after the initial Add event, such as the FavoriteTaxonomyData.Type.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteFolderIdLabel" AssociatedControlID="uxFavoriteFolderId" CssClass="span-4 last" runat="server" Text="* Favorite taxonomy Id:" />
        <ektronUI:TextField ID="uxFavoriteFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <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" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-4 last" runat="server" Text="Description:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long favoriteFolderId = long.Parse(uxFavoriteFolderId.Text);

            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = 100;

            FavoriteTaxonomyManager favoriteTaxonomyManager = new FavoriteTaxonomyManager();
            Ektron.Cms.Community.FavoriteTaxonomyData favoriteTaxonomyData = favoriteTaxonomyManager.GetTree(favoriteFolderId, 3, true, pagingInfo);

            if (favoriteTaxonomyData != null)
            {
                favoriteTaxonomyData.Name = uxTitle.Text != string.Empty ? uxTitle.Text : favoriteTaxonomyData.Name;
                favoriteTaxonomyData.Description = uxDescription.Text != string.Empty ? uxDescription.Text : favoriteTaxonomyData.Description;

                favoriteTaxonomyManager.Update(favoriteTaxonomyData);
            
                MessageUtilities.UpdateMessage(uxMessage, "Favorite folder updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Favorite folder does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

FavoriteTaxonomyData

Namespace

Ektron.Cms.Community

Properties

  • ChildTaxonomies. Gets or sets the favorite child taxonomy in the current taxonomy. If not retrieved, this will be an empty list.
    public System.Collections.Generic.List<FavoriteTaxonomyData>
  ChildTaxonomies { set; get; }
  • Description. Gets or sets the description of the favorites's taxonomy.
    public string Description { set; get; }
  • FavoriteTaxonomyData()
    public FavoriteTaxonomyData()
  • Id. Gets or sets the ID of the favorite taxonomy. Overridden to clarify the description and taxonomy relationship
    public override long Id { set; get; }
  • Items. Gets or sets the Favorites in the taxonomy. If not retrieved, this will be an empty list.
    public System.Collections.Generic.List<FriendsData> Items { set; get; }
  • Name. Gets or sets the Favorites taxonomy name.
    public string Name { set; get; }
  • ParentId. Gets or sets the ID of the Favorites folder's parent taxonomy.
    public long ParentId { set; get; }