using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.BL.Enumerations;
using Tango.BL.ValueObjects;

namespace Tango.BL.ActionLogs
{
    /// <summary>
    /// Represents an ActionLog manager which is responsible for inserting and comparing new action logs to a data store.
    /// </summary>
    public interface IActionLogManager
    {
        /// <summary>
        /// Gets or sets the action log comparer used to compare related objects.
        /// </summary>
        IActionLogComparer ActionLogComparer { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to perform the logging operations asynchronously.
        /// </summary>
        bool IsAsync { get; set; }

        /// <summary>
        /// Inserts a new action log (main entry point).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectGuid">The related object unique identifier.</param>
        /// <param name="diffference">The diffference node tree.</param>
        /// <param name="message">The message.</param>
        void InsertLog(ActionLogType type, String userGuid, String relatedObjectName, String relatedObjectGuid, ActionLogDifference diffference, String message = null);

        /// <summary>
        /// Inserts a new action log (comparison entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectBefore">The related object before the change.</param>
        /// <param name="relatedObjectAfter">The related object after the change.</param>
        /// <param name="message">The message.</param>
        void InsertLog(ActionLogType type, String userGuid, String relatedObjectName, IActionLogComparable relatedObjectBefore, IActionLogComparable relatedObjectAfter, String message = null);

        /// <summary>
        /// Inserts a new action log (comparison entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="user">The user.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectBefore">The related object before the change.</param>
        /// <param name="relatedObjectAfter">The related object after the change.</param>
        /// <param name="message">The message.</param>
        void InsertLog(ActionLogType type, User user, String relatedObjectName, IActionLogComparable relatedObjectBefore, IActionLogComparable relatedObjectAfter, String message = null);

        /// <summary>
        /// Inserts a new action log (deletion/creation entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="user">The user.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObject">The related object.</param>
        /// <param name="message">The message.</param>
        /// <param name="serializeRelatedObject">if set to <c>true</c> will create a one way difference tree (use when the related object was deleted and needs to be monitored).</param>
        void InsertLog(ActionLogType type, User user, String relatedObjectName, IActionLogComparable relatedObject, String message = null, bool serializeRelatedObject = false);

        /// <summary>
        /// Inserts a new action log (creation entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectGuid">The related object unique identifier.</param>
        /// <param name="message">The message.</param>
        void InsertLog(ActionLogType type, String userGuid, String relatedObjectName, String relatedObjectGuid, String message = null);

        /// <summary>
        /// Inserts a new action log (neutral entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="message">The message.</param>
        void InsertLog(ActionLogType type, String userGuid, String message = null);

        /// <summary>
        /// Inserts a new action log (neutral entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="user">The user.</param>
        /// <param name="message">The message.</param>
        void InsertLog(ActionLogType type, User user, String message = null);
    }
}