# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2009 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################
"""
erp5.component.interface.IAmountConversion
"""

from zope.interface import Interface

class IAmountConversion(Interface):
  """Amount Conversion private interface specification

  IAmountConversion defines methods which can be used
  to convert an amount from one quantity unit and to another,
  taking into account efficiency.
  """

  def getNetQuantity():
    """
    Take into account efficiency in quantity. This is
    only useful in Path which define a loss ratio, such
    as Transformation.

    Formula:
      net_quantity = quantity / efficiency
    """

  def getConvertedQuantity(quantity_unit=None, measure=None):
    """
    Returns the quantity of the resource converted in the
    default management unit of the resource.

    quantity_unit -- optional quantity unit to use
                     for conversion.

    measure -- optional quantity unit to use
               for conversion.
    """

  def getNetConvertedQuantity(quantity_unit=None, measure=None):
    """
    Returns the net quantity of the resource converted in the
    default management unit of the resource.

    quantity_unit -- optional quantity unit to use
                     for conversion.

    measure -- optional quantity unit to use
               for conversion.
    """
