#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/ITankGroupEvents.cs $
 * 
 * 2     07-03-09 15:35 roger.månsson
 * Made interface public .
 * 
 * 1     07-01-05 15:13 roger.månsson
 * Created
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Event interface for ITankGroup
    /// </summary>
    [ComVisible(true)]
    [InterfaceType( ComInterfaceType.InterfaceIsIDispatch)]
    public interface ITankGroupEvents
    {
        #region Request completed events

        /// <summary>
        /// Event invoked when a Block request has completed.
        /// </summary>
        /// <param name="sender">The TankGroup object where the method was invoked.</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">Token object that was supplied in the asynchronous request.</param>
        void OnBlockCompleted(ITankGroup sender, bool success, object userToken);

        /// <summary>
        /// Event invoked when a Unblock request has completed.
        /// </summary>
        /// <param name="sender">The TankGroup object where the method was invoked.</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">Token object that was supplied in the asynchronous request.</param>
        void OnUnblockCompleted(ITankGroup sender, bool success, object userToken);

        /// <summary>
        /// Event invoked when a RegisterManualDelivery request has completed.
        /// </summary>
        /// <param name="sender">The TankGroup object where the method was invoked.</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">Token object that was supplied in the asynchronous request.</param>
        void OnRegisterManualDeliveryCompleted(ITankGroup sender, bool success, object userToken);

        #endregion 

        #region Unsolicited events
        /// <summary>
        /// Event that is raised when a fuel delivery is detected. It can be both manual and probe detected deliveries.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        void OnFuelDelivery(ITankGroup sender, IFuelDeliveryEventArgs e);
        #endregion 
    }
}