TaskCommentManager

Add

Add(Ektron.Cms.TaskCommentData)

Adds a task comment based on information in an TaskCommentData object. The method populates the message.Id with the newly created ID.

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

Parameters

• TaskCommentData. The TaskCommentData object to add.

Returns

Added TaskCommentData object.

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TaskCommentManager taskCommentManager = new TaskCommentManager();
            TaskCommentData taskCommentData = new TaskCommentData()
            {
                TaskComment = uxTaskComment.Text,
                UserId = long.Parse(uxUserId.Text)
            };

             TaskCommentData retData= taskCommentManager.Add(taskCommentData);
            

            MessageUtilities.UpdateMessage(uxMessage, "Task added with Id " + retData.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 task comment 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 task comment to delete.

Remarks

Validate the item with GetItem() before deleting it.

.aspx.cs code-behind method

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

            TaskCommentManager taskCommentManager = new TaskCommentManager();
            TaskCommentData taskCommentData = taskCommentManager.GetItem(taskCommentId);

             if (taskCommentData != null)
             {
                 taskCommentManager.Delete(taskCommentId);
                 MessageUtilities.UpdateMessage(uxMessage, "Task comment deleted.", Message.DisplayModes.Success);
             }
             else
             {
                 MessageUtilities.UpdateMessage(uxMessage,"Task comment does not exists.", Message.DisplayModes.Error);
             }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.TaskCommentData)

Retrieves the properties of a specific TaskCommentData 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

• id. ID of the task comment to retrieve.

.aspx.cs code-behind method

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

            TaskCommentManager taskCommentManager = new TaskCommentManager();
            TaskCommentData taskCommentData = taskCommentManager.GetItem(taskCommentId);

            if (taskCommentData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for task comment with ID " + taskCommentData.Id.ToString() + " are below", Message.DisplayModes.Success);

                uxTaskId.Text = "TaskId : " + taskCommentData.TaskId;
                uxTaskComment.Text = "TaskComment : " + taskCommentData.TaskComment;
                uxUserId.Text = "UserID : " + taskCommentData.UserId;
                uxCommentedDate.Text = "CreatedDate : " + taskCommentData.Commenteddate;
                uxModifiedDate.Text = "Modified Date : " + taskCommentData.CommentUpdateddate;
                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Task comment 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.TaskCommentCriteria)

Retrieves lists of objects through the GetList(TaskCommentCriteria) method.

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

• * Task Category Property
• * Object Value

Parameters

• criteria. Criteria used to retrieve task categories.

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.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;
            TaskCommentManager taskCommentManager = new TaskCommentManager();

            TaskCommentCriteria criteria = new TaskCommentCriteria();
            if (uxTaskCommentDataProperty.SelectedItem.Text == "TaskId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaskCommentProperty.TaskId , CriteriaFilterOperator.Contains, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaskCommentProperty.Comments, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<TaskCommentData> taskCommentDataList = taskCommentManager.GetList(criteria);

            uxTaskDataListView.Visible = true;
            uxTaskDataListView.DataSource = taskCommentDataList;
            uxTaskDataListView.DataBind();

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

Update

Update(Ektron.Cms.SmartFormConfigurationData)

Updates an existing task comment 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

Parameters

• TaskCommentData. The TaskCommentData object to update.

Returns

Updated TaskCommentData object.

Remarks

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

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

.aspx.cs code-behind method

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

            TaskCommentManager taskCommentManager = new TaskCommentManager();
            TaskCommentData taskCommentData = taskCommentManager.GetItem(taskCommentId);

           if (taskCommentData != null)
            {
                taskCommentData.TaskComment = uxTaskComment.Text;                
                taskCommentManager.Update(taskCommentData);

                MessageUtilities.UpdateMessage(uxMessage, "Task comment updated", Message.DisplayModes.Success);
           }
           else
           {
               MessageUtilities.UpdateMessage(uxMessage, "Task comment does not exists.", Message.DisplayModes.Error);
           }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }