IAmount.py 4.09 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
##############################################################################
#
# 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.
#
##############################################################################

from Interface import Interface

class IAmount(Interface):
  """
    An amount represents a quantity of a given resource
    in a given quantity unit. Optional efficiency
    or (exclusive) profit/loss quantity can be specified
    in order to represent a profit or loss ratio to take
    into account in calculations.

    The Amount interface is useful each time
    we need to add or substract amounts of resources
    independently of a movement. This is the case for example
    for all Transformation related classes.

    Equations:
      net_quantity = quantity * efficiency

    TODO:
      consider how to make Interface compatible
      with accessor generation (ex. getResource)

    Addition:
      target_quantity is obsolete, it is never defined.
  """

  # Core API
  def getQuantity():
    """
      Returns the quantity of the resource
      in the unit specified by the Amount
    """

  def getResource():
    """
      Returns the resource category relative URL
      of the Amount
    """

  def getQuantityUnit():
    """
      Returns the quantity unit category relative URL
      of the Amount
    """

  def isCancellationAmount():
    """
      A cancellation amount must be interpreted
      reversely write to the sign of qauntity.

      For example, a negative credit for a cancellation
      amount is a negative credit, not a positive
      debit.

      A negative production quantity for a cancellation
      amount is a cancelled production, not
      a consumption
    """

  # Net Quantity API
  def getEfficiency():
    """
      Returns a value which is rate affect to the net quantity
      Only used for transformation for now.
    """

  def getNetQuantity():
    """
      Returns affected quantity by some optional effects.
    """

  # Price API

  def getPrice():
    """
      Returns price
    """
  
  def getTotalPrice():
    """
      Returns total price for the number of items
    """

  # Conversion API
  def getConvertedQuantity():
    """
      Returns the quantity converted by the resource
    """

  def getNetConvertedQuantity():
    """
      Returns the net quantity converted by the resource
    """

  # Make it possible to add amounts
  def __add__(value):
    """
      Add

      If the amount can understands argument as amount for addition,
      returns calculated
    """

  def __sub__(value):
    """
      Substract

      If the amount can understands argument as amount for substraction,
      returns calculated
    """

  def __mul__(value):
    """
      Multiply

      If the amount can understands argument as efficiency for multiplication,
      returns calculated
    """

  def __div__(value):
    """
      Devide

      If the amount can understands argument as efficiency for division,
      returns calculated
    """