/*
 * IProgressAware.cs
 * 
 * Copyright © 2009
 * Diversified Technical Systems, Inc.
 * All Rights Reserved
 */

namespace DTS.Serialization
{
    /// <summary>
    /// Interface for receiving progress updates from DTS.Serialization-based objects.
    /// </summary>
    interface IProgressAware
    {
        /// <summary>
        /// <see cref="DTS.Serialization.EventHandler"/> to notify subscribers of begin serialization task events.
        /// </summary>
        event BeginEventHandler OnBegin;

        /// <summary>
        /// <see cref="DTS.Serialization.EventHandler"/> to notify subscribers of end serialization task events.
        /// </summary>
        event EndEventHandler OnEnd;

        /// <summary>
        /// <see cref="DTS.Seralization.EventHandler"/> to notify subscribers of serialization task-tick notified.
        /// </summary>
        event TickEventHandler OnTick;

        /// <summary>
        /// notify subscribers of serialization cancelled
        /// </summary>
        event CancelEventHandler OnCancel;

        /// <summary>
        /// notify subscribers of serialization fatal errored
        /// </summary>
        event ErrorEventHandler OnError;
    }
}