#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/IForecourtControlEvents.cs $
 * 
 * 5     07-10-22 11:19 roger.månsson
 * Added OnFuelPriceChange event.
 * 
 * 4     07-03-09 15:33 roger.månsson
 * Removed DispId definitions. The automatically generated works just
 * fine.
 * 
 * 3     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 2     07-01-05 9:01 roger.månsson
 * Documentation changes
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Event interface for the IForecourtControl. Contains the event sink interface for the forecourt
    /// control object.
    /// </summary>
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
    public interface IForecourtControlEvents
    {
        #region Response events

        /// <summary>
        /// Event that will be invoked when a call to SetSiteOpenendAsync has completed.
        /// </summary>
        /// <param name="sender">Sender object</param>
        /// <param name="success">True if the operation succeeded</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnSetSiteOpenedCompleted(IForecourtControl sender, bool success, object userToken);

        /// <summary>
        /// Event that will be invoked when a call to SetSiteModeAsync has completed.
        /// </summary>
        /// <param name="sender">Sender object</param>
        /// <param name="success">True if the operation succeeded</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnSetSiteModeCompleted(IForecourtControl sender, bool success, object userToken);

        /// <summary>
        /// Event that will be invoked when a call to ReserveFuelPricesAsync has completed.
        /// </summary>
        /// <param name="sender">Sender object</param>
        /// <param name="success">True if the operation succeeded</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnReserveFuelPricesCompleted(IForecourtControl sender, bool success, object userToken);

        /// <summary>
        /// Event that will be invoked when a call to UnreserveFuelPricesAsync has completed.
        /// </summary>
        /// <param name="sender">Sender object</param>
        /// <param name="success">True if the operation succeeded</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnUnreserveFuelPricesCompleted(IForecourtControl sender, bool success, object userToken);

        /// <summary>
        /// Event that will be invoked when a call to ActivateFuelPricesAsync has completed.
        /// </summary>
        /// <param name="sender">Sender object</param>
        /// <param name="success">True if the operation succeeded</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnActivateFuelPricesCompleted(IForecourtControl sender, bool success, object userToken);


        #endregion

        #region Unsolicited events

        /// <summary>
        /// Site mode has changed. Either the site mode or the site open/closed status has changed.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="siteMode"></param>
        /// <param name="siteOpen"></param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "OnSite")]
        void OnSiteModeChange(IForecourtControl sender, int siteMode, bool siteOpen);

        /// <summary>
        /// Connection state to the Forecourt Control has changed.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="connectionState"></param>
        void OnConnectionStateChange(IForecourtControl sender, DeviceConnectionState connectionState);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "1#e")]
        void OnAlarm(IForecourtControl sender, IAlarmEventArgs e);

        /// <summary>
        /// Event fired when the fuel prices has been changed on the station and a new fuel price shift has been 
        /// created.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="fuelPeriodId">The new Fuel period id.</param>
        void OnFuelPriceChange(IForecourtControl sender, int fuelPeriodId);

        #endregion
    }
}