FCC/Extension/WayneClassicFdcClient/ForecourtControl/IFuelPrice.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/IFuelPrice.cs $
 * 
 * 4     07-06-26 9:18 roger.månsson
 * 
 * 3     07-01-05 8:59 roger.månsson
 * Renamed GeneralPriceChange -> GeneralPriceDelta and AddPrices ->
 * PriceGroupDelta
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// The fuel price represents the prices for one Fuel grade for the whole Forecourt. The prices
    /// are read 
    /// Total fuel price for a fuelling is calculated as <c>FuelPrice.BasePrice + FuelPrice.GeneralPriceChange + FuelPrice.AddPrices[ current price group]</c>
    /// </summary>
    [System.Runtime.InteropServices.ComVisible(true)]
    public interface IFuelPrice
    {
        /// <summary>
        /// The Fuel grade that this fuel price represents.
        /// </summary>
        int FuelGrade { get; }

        /// <summary>
        /// Indicates if the Fuel price is reserved, and thus writable.
        /// </summary>
        bool Reserved { get; }

        /// <summary>
        /// Base price of the fuel grade
        /// </summary>
        decimal BasePrice
        {
            get;
            set;
        }

        /// <summary>
        /// Base price of the fuel grade as currency in COM.
        /// </summary>
        decimal BasePriceAsCurrency
        {
            [return: MarshalAs(UnmanagedType.Currency)]
            get;

            [param: MarshalAs(UnmanagedType.Currency)]
            set;
        }


        /// <summary>
        /// A general price deviation from the base price that is used for all PriceGroups.
        /// </summary>
        decimal GeneralPriceDelta
        {
            get;
            set;
        }


        /// <summary>
        /// A general price deviation from the base price that is used for all PriceGroups.
        /// </summary>
        decimal GeneralPriceDeltaAsCurrency
        {
            [return: MarshalAs(UnmanagedType.Currency)]
            get;

            [param: MarshalAs(UnmanagedType.Currency)]
            set;
        }

        /// <summary>
        /// The Price deviation from the 
        /// </summary>
        IFuelPriceAddPricePerPriceGroup PriceGroupDelta { get; }

        /// <summary>
        /// Validates the price setup against the min/max prices. 
        /// </summary>
        /// <returns></returns>
        bool Validate();
    }
}