using System;
using System.Threading.Tasks;

namespace gehGassi.Core.Interfaces
{
    /// <summary>
    /// Schnittstellenbeschreibung für einen DBcontext der Auditing vornimmt
    /// </summary>
    public interface IAuditDbContext : IDisposable
    {
        /// <summary>
        /// Speichern der Änderungen mit Auditing (wenn aktiviert) und Benutzername
        /// </summary>
        /// <param name="userName">Benutzer der die Änderungen vorgenommen hat</param>
        /// <param name="noAudit">Gibt an, dass kein Audit-Eintrag erstellt werden soll, auch wenn Audit aktiviert ist</param>
        /// <returns>Anzahl betroffener Datensätze</returns>
        int SaveChanges(string userName, bool noAudit);

        /// <summary>
        /// Speichern der Änderungen mit Auditing (wenn aktiviert) und Benutzername
        /// </summary>
        /// <param name="userName">Benutzer der die Änderungen vorgenommen hat</param>
        /// <param name="noAudit">Gibt an, dass kein Audit-Eintrag erstellt werden soll, auch wenn Audit aktiviert ist</param>
        /// <returns>Anzahl betroffener Datensätze</returns>
        Task<int> SaveChangesAsync(string userName, bool noAudit);
    }

    /// <summary>
    /// Hilfsklasse - Einstellungen des AuditDbContext
    /// </summary>
    public class AuditOptions
    {
        /// <summary>
        /// Erstellt eine Instanz
        /// </summary>
        public AuditOptions()
        {
            IsEnabled = true;
        }

        /// <summary>
        /// Soll das auditing durchgeführt werden?
        /// </summary>
        public bool IsEnabled { get; set; }
    }
}