#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/IAuthorizeParameters.cs $
 *
 * 2     07-02-26 14:06 roger.månsson
 * Mark the Preset value as MarshalAs Currency
 *
 * 1     07-01-05 9:00 roger.månsson
 * Created
 */
#endregion

using System.Runtime.InteropServices;
namespace Wayne.ForecourtControl
{
    /// <summary>
    /// The AuthorizeParameters is a data structure that contains the
    /// parameters that is used when authorizing a fuelling.
    /// </summary>
    [ComVisible(true)]
    public interface IAuthorizeParameters
    {
        /// <summary>
        /// Specifies if the PresetValue should be regarded as a volume or an amount.
        /// </summary>
        /// <see cref="PresetType"/>
        PresetType PresetType { get; set; }

        /// <summary>
        /// Maximum fuelling amount in domestic currency or volume.
        /// May be overridden by the configured maximum volume or
        /// amount in the pump controller. The lowest value will be used.
        /// </summary>

        decimal PresetValue
        {
            [return: MarshalAs(UnmanagedType.Currency)]
            get;
            [param: MarshalAs(UnmanagedType.Currency)]
            set;
        }

        /// <summary>
        /// Specifies the price group for the fuelling that should be used for the price calculation.
        /// </summary>
        int PriceGroup { get; set; }

        /// <summary>
        /// Fuel grades allowed to use for the fuelling are set to true.
        /// </summary>
        IAllowedFuelGrades AllowedFuelGrade { get; }

        /// <summary>
        /// The fuelling can only be reserved and set as paid by the releasing client if this
        /// property is set to true.
        /// </summary>
        bool LockToReleaseClient { get; set; }

        /// <summary>
        /// Prepay flag is true for bank note sale
        /// </summary>
        bool Prepay { get; set; }

        /// <summary>
        /// Payment type: e.g. "ST" for speedpass tag; "FC" for fleet card; "PC" for payment card;
        /// </summary>
        string PayType { get; set; }
    }
}