// --------------------------------------------------------------------------------------------------------------------
// <copyright file="Tracer.cs" company="Developpez.com">
//   
// </copyright>
// <summary>
//   Classe obstraite pour l'utilisation de tracer
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Tools
{
    using System;

    // <summary>
    /// Classe obstraite pour l'utilisation de tracer
    /// </summary>
    public abstract class Tracer
    {
        #region Constructors and Destructors

        /// <summary>
        /// Initialise une nouvelle instance de la classe  <see cref="Tracer"/>. 
        ///   Constructeur en internal, non accessible depuis une autre assembly
        /// </summary>
        internal Tracer()
        {
        }

        #endregion

        #region Public Methods

        /// <summary>
        /// Fabrique de tracer.
        /// </summary>
        /// <param name="traceName">
        /// Non de la trace.
        /// </param>
        /// <returns>
        /// L'objet tracer fabriqué
        /// </returns>
        public static Tracer Create(string traceName)
        {
            //return new NLogTracer(traceName);
            return new DotNet.TraceSourceTracer(traceName);
        }

        /// <summary>
        /// Writes the error.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        public abstract void WriteError(string component, string methodProperty, string message);

        /// <summary>
        /// Writes the error.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="exception">
        /// The exception.
        /// </param>
        public abstract void WriteError(string component, string methodProperty, Exception exception);

        /// <summary>
        /// Writes the error.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        /// <param name="exc">
        /// The exception
        /// </param>
        public abstract void WriteError(string component, string methodProperty, string message, Exception exc);

        /// <summary>
        /// Writes the information.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        public abstract void WriteInformation(string component, string methodProperty, string message);

        /// <summary>
        /// Writes the start operation.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        public abstract void WriteStartOperation(string component, string methodProperty, string message);

        /// <summary>
        /// Writes the stop operation.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        public abstract void WriteStopOperation(string component, string methodProperty, string message);

        /// <summary>
        /// Writes the verbose.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        public abstract void WriteVerbose(string component, string methodProperty, string message);

        /// <summary>
        /// Writes the warning.
        /// </summary>
        /// <param name="component">
        /// Name of the component.
        /// </param>
        /// <param name="methodProperty">
        /// Operation done.
        /// </param>
        /// <param name="message">
        /// The message.
        /// </param>
        public abstract void WriteWarning(string component, string methodProperty, string message);

        #endregion
    }
}