#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/IFuellingEvents.cs $
 * 
 * 2     07-01-05 9:01 roger.månsson
 * Documentation changes
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Event interface for a IFuelling object.
    /// </summary>
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
    public interface IFuellingEvents
    {
        #region Request completed events
        /// <summary>
        /// Event raised on completion of Reserve request.
        /// </summary>
        /// <param name="sender">Fuelling object that raised the event</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">User token specified when invoking the asynchronous request.</param>
        void OnReserveCompleted(IFuelling sender, bool success, object userToken);

        /// <summary>
        /// Event raised on completion of Unreserve request.
        /// </summary>
        /// <param name="sender">Fuelling object that raised the event</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">User token specified when invoking the asynchronous request.</param>
        void OnUnreserveCompleted(IFuelling sender, bool success, object userToken);

        /// <summary>
        /// Event raised on completion of Transfer request.
        /// </summary>
        /// <param name="sender">Fuelling object that raised the event</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">User token specified when invoking the asynchronous request.</param>
        void OnTransferCompleted(IFuelling sender, bool success, object userToken);

        /// <summary>
        /// Event raised on completion of UndoTransfer request.
        /// </summary>
        /// <param name="sender">Fuelling object that raised the event</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">User token specified when invoking the asynchronous request.</param>
        void OnUndoTransferCompleted(IFuelling sender, bool success, object userToken);

        /// <summary>
        /// Event raised on completion of SetAsPaid request.
        /// </summary>
        /// <param name="sender">Fuelling object that raised the event</param>
        /// <param name="success">True if the request succeeded.</param>
        /// <param name="userToken">User token specified when invoking the asynchronous request.</param>
        void OnSetAsPaidCompleted(IFuelling sender, bool success, object userToken);

        #endregion
    }
}