// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ICurrencyConverter.cs" company="Sitecore Corporation">
//   Copyright (c) Sitecore Corporation 1999-2015
// </copyright>
// <summary>
//   Converts totals from one currency to another one.
// </summary>
// --------------------------------------------------------------------------------------------------------------------
// Copyright 2015 Sitecore Corporation A/S
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
//       http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
// -------------------------------------------------------------------------------------------

namespace Sitecore.Ecommerce.DomainModel.Currencies
{
  using Prices;

  /// <summary>
  /// Converts totals from one currency to another one.
  /// </summary>
  /// <typeparam name="TTotals">The type of the totals.</typeparam>
  /// <typeparam name="TCurrency">The type of the currency.</typeparam>
  public interface ICurrencyConverter<TTotals, TCurrency>
    where TTotals : Totals
    where TCurrency : Currency
  {
    /// <summary>
    /// Converts the specified input totals.
    /// </summary>
    /// <param name="inputTotals">The input totals.</param>
    /// <param name="outputCurrency">The output currency.</param>
    /// <returns>The output totals.</returns>
    TTotals Convert(TTotals inputTotals, TCurrency outputCurrency);

    /// <summary>
    /// Converts the specified input totals.
    /// </summary>
    /// <param name="inputTotals">The input totals.</param>
    /// <param name="relativeExchangeRate">The relative exchange rate.</param>
    /// <returns>The output totals.</returns>
    TTotals Convert(TTotals inputTotals, decimal relativeExchangeRate);
  }
}