FlagDefinitionManager

The class manages a means by which an end user provides feedback about content (because the content is offensive, or because the user likes the content). The feedback goes to an administrator or moderator for action.

Namespace

Ektron.Cms.Framework.Flag.FlagDefinitionManager

Constructors

  • FlagDefinitionManager()
  • FlagDefinitionManager(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.
  • FlagDefinitionManagerService. Returns an instance of the business objects flag definition 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.FlagDefData)

Adds a flag based on information in FlagDefData object.

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

  • * Title
  • Description
  • * Flag Item Title
  • Flag Item Description

Parameters

  • FlagDefinitionData. The flag object to add.

Returns

FlagDefData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
       <asp:Label ID="uxFlagDefinitionNameLabel" AssociatedControlID="uxFlagDefintionName" CssClass="span-4 last" runat="server" Text="* Title:" />
       <asp:TextField ID="uxFlagDefintionName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
    <li class="clearfix">
       <asp:Label ID="uxFlagDefinitionDescriptionLabel" AssociatedControlID="uxFlagDefinitionDescription" CssClass="span-4 last" runat="server" Text=" Description:" />
       <asp:TextField ID="uxFlagDefinitionDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
   <li class="clearfix">
       <asp:Label ID="uxFlagItemNameLabel" AssociatedControlID="uxFlagItemName" CssClass="span-4 last" runat="server" Text="* Flag Item Title:" />
       <asp:TextField ID="uxFlagItemName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
    <li class="clearfix">
       <asp:Label ID="uxFlagItemDescriptionLabel" AssociatedControlID="uxFlagItemDescription" CssClass="span-4 last" runat="server" Text=" Item Description:" />
       <asp:TextField ID="uxFlagItemDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    <li class="clearfix">
       <asp:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
       <asp: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;
using System.Collections.Generic;
using Ektron.Cms;
using Ektron.Cms.Framework.Flag ;
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
        {
                        
            FlagDefinitionManager flagDefinitionManager=new FlagDefinitionManager();
            List<FlagItemData> flagItemList = new List<FlagItemData>();
            FlagItemData flagItemData = new FlagItemData()
            {
                 Name = uxFlagItemName.Text,
                 Description =uxFlagItemDescription.Text
            };
            flagItemList.Add(flagItemData);
            
            FlagDefData flagDefinitionData = new FlagDefData()
            {
                  Name =uxFlagDefintionName.Text,
                  Description = uxFlagDefinitionDescription.Text,
                  Items = flagItemList.ToArray()
            };
                                   
            flagDefinitionManager.Add(flagDefinitionData);
            MessageUtilities.UpdateMessage(uxMessage, "Flag Definition with ID " + flagDefinitionData.Id, 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 flag 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 ID of the flag to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagDefinitionIdLabel" AssociatedControlID="uxFlagDefinitionId" CssClass="span-4 last" runat="server" Text="* Flag Definition Id:" />
        <ektronUI:TextField ID="uxFlagDefinitionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
                <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                    Text="Status:" />
            </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.Framework.Flag;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
           
            long flagDefinitionId = long.Parse(uxFlagDefinitionId.Text);
            FlagDefinitionManager flagDefinitionManager = new FlagDefinitionManager();
            FlagDefData flagDefinitionData = flagDefinitionManager.GetItem(flagDefinitionId);
            if (flagDefinitionData != null)
            {
                flagDefinitionManager.Delete(flagDefinitionData.ID);                  
                MessageUtilities.UpdateMessage(uxMessage, "Flag Definition deleted.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus,  "Please Enter Valid Flag ID.", Message.DisplayModes.Error);
                return;
            }

            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 FlagDefData object.

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

  • FlagDefinitionId. The ID of the flag to retrieve.

Returns

FlagDefData object found.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagDefinitionIdLabel" AssociatedControlID="uxFlagDefinitionId" CssClass="span-3 last" runat="server" Text="* Flag Definition Id :" />
        <ektronUI:TextField ID="uxFlagDefinitionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFlagDefinitionName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFlagDefinitionDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFlagItemTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFlagItemDescription" 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.Flag;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long flagDefinitionId = long.Parse(uxFlagDefinitionId.Text);
            FlagDefinitionManager flagDefinitionManager = new FlagDefinitionManager();
            FlagDefData flagDefinitionData = flagDefinitionManager.GetItem(flagDefinitionId);
            if (flagDefinitionData != null)
            {
                uxId.Text = "FlagDefinition Id : " + flagDefinitionData.Id.ToString();
                uxFlagDefinitionName.Text = "FlagDefinition Name : " + flagDefinitionData.Name;
                uxFlagDefinitionDescription.Text = "FlagDefinition Description : " + flagDefinitionData.Description;
                foreach (FlagItemData flagItemData in flagDefinitionData.Items)
                {
                    uxFlagItemTitle.Text = "Flag Item Title : " + flagItemData.Name;
                    uxFlagItemDescription.Text = "Flag Item Description : " + flagItemData.Description;
                }                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Flag Definition does not exists. ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetList

GetList(Ektron.Cms.Flag.FlagDefinitionCriteria)

Retrieves lists of objects.

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

  • Flag Definition Data Property
  • * Object Value

Parameters

Returns

A list of FlagDefData objects found.

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="uxFlagDefinitionDataPropertyLabel" AssociatedControlID="uxFlagDefinitionDataProperty" CssClass="span-6 last" runat="server" Text="Flag Definition Data Property:" />
        <asp:DropDownList ID="uxFlagDefinitionDataProperty" runat="server">
            <asp:ListItem>Flag Entry Id</asp:ListItem>
            <asp:ListItem>Object Id</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagDefinitionValueLabel" AssociatedControlID="uxFlagDefinitionValue" CssClass="span-6 last" runat="server" Text="* Object Value:" />
        <ektronUI:TextField ID="uxFlagDefinitionValue" 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-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxFlagDefinitionListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Flag Definition Id
                    </th>
                    <th>
                        Flag Definition Name
                    </th>
                    <th>
                        Flag Definition Description
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("ID")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Description")%>
            </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.Common;
using Ektron.Cms.Framework.Flag;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;

            Ektron.Cms.Flag.FlagDefinitionCriteria criteria = new Ektron.Cms.Flag.FlagDefinitionCriteria();
            if (uxFlagDefinitionDataProperty.SelectedItem.Text == "Flag Definition Id")
            {
                Objectvalue = Convert.ToInt64(uxFlagDefinitionValue.Text);
                criteria.AddFilter( FlagDefinitionProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxFlagDefinitionValue.Text;
                criteria.AddFilter(FlagDefinitionProperty.FlagDefName  , CriteriaFilterOperator.Contains , Objectvalue);
            }

            FlagDefinitionManager flagDefinitionManager = new FlagDefinitionManager();
            List<FlagDefData> flagDefinitionList = flagDefinitionManager.GetList(criteria);

            uxFlagDefinitionListView.Visible = true;
            uxFlagDefinitionListView.DataSource = flagDefinitionList;
            uxFlagDefinitionListView.DataBind();

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

Update

Update(Ektron.Cms.FlagDefData)

Updates an existing flag item in 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
  • * Title
  • * Item ID
  • * Item Title

Parameters

  • FlagDefinitionData. The FlagDefData object to update.

Returns

Returns the FlagDefData object updated.

Remarks

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

NOTE: You cannot change all properties after the initial Add event.

.aspx code snippet

<ol class="formFields">
      <li class="clearfix">
       <ektronUI:Label ID="uxFlagDefinitionIdLabel" AssociatedControlID="uxFlagDefintionId" CssClass="span-4 last" runat="server" Text="* ID:" />
       <ektronUI:TextField ID="uxFlagDefintionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagDefinitionNameLabel" AssociatedControlID="uxFlagDefintionName" CssClass="span-4 last" runat="server" Text="* Title:" />
        <ektronUI:TextField ID="uxFlagDefintionName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
   <li class="clearfix">
       <ektronUI:Label ID="uxFlagItemIdLabel" AssociatedControlID="uxFlagItemId" CssClass="span-4 last" runat="server" Text="* Item ID:" />
       <ektronUI:TextField ID="uxFlagItemId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagItemNameLabel" AssociatedControlID="uxFlagItemName" CssClass="span-4 last" runat="server" Text="* Item Title:" />
        <ektronUI:TextField ID="uxFlagItemName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long flagDefinitionId = long.Parse(uxFlagDefintionId.Text);
            FlagDefinitionManager flagDefinitionManager = new FlagDefinitionManager();
            
            FlagDefData flagDefinitionData = flagDefinitionManager.GetItem(flagDefinitionId);
            FlagItemData flagItemData = new FlagItemData()
            {
                
                 ID = long.Parse(uxFlagItemId.Text),
                 Name  =uxFlagItemName.Text 
            };
            List<FlagItemData> flagItemList = new List<FlagItemData>();
            flagItemList.Add(flagItemData);


            if (flagDefinitionData != null)
            {
                
                flagDefinitionData.Name =uxFlagDefinitionName.Text;
                flagDefinitionData.Items = flagItemList.ToArray();
                flagDefinitionManager.Update(flagDefinitionData);                               
                MessageUtilities.UpdateMessage(uxMessage, "Flag Definition Updated ", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Flag Definition not exists. ", Message.DisplayModes.Error);
            }

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

Data Classes

FlagDefData

Namespace

Ektron.Cms

Properties

  • Description
    public string Description { set; get; }
  • Hidden
    public bool Hidden { set; get; }
  • ID
    public long ID { set; get; }
  • Items
    public Ektron.Cms.Controls.CmsWebService.FlagItemData[] Items { set; get; }
  • Language
    public int Language { set; get; }
  • m_bHidden
    public bool m_bHidden { set; get; }
  • m_strDescription
    public string m_strDescription { set; get; }
  • m_strName
    public string m_strName { set; get; }
  • Name
    public string Name { set; get; }

FlagDefinitionCriteria

Namespace

Ektron.Cms.Flag

Properties

  • FlagDefinitionCriteria()
    public FlagDefinitionCriteria()
  • FlagDefinitionCriteria(Ektron.Cms.Common.FlagDefProperty, EkEnumeration.OrderByDirection)
    public FlagDefinitionCriteria(Ektron.Cms.Common.FlagDefProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the FlagDefinitionProperty are:

    • FlagDefDescription
    • FlagDefLanguage
    • FlagDefName
    • FlagLastEditDate
    • Id
    • IsCommunityFlag