# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2002 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.
#
##############################################################################

# This has to be chanegd and improved by the new category acquisition tool
from Products.CMFCore.Expression import Expression

class Amount:
  """
        Properties for Amount. Amounts are a quantity
        of a given resource in a given  variation.

        The variation is stored in the category and properties

        Efficiency may need to be renamed - this
        is a proba value / fuzzy value

        variation is a reserverd name implemented as getVariation and setVariation....
        in the amount class
  """

  _properties = (
    { 'id'          : 'resource_relative_url',
      'description' : "The resource relative url involved",
      'type'        : 'string',
      'acquisition_base_category' : ('resource',),
      'acquisition_portal_type'   : Expression('python: portal.getPortalResourceTypeList()'),
      'acquisition_copy_value'    : 0,
      'acquisition_mask_value'    : 0,
      'acquisition_sync_value'    : 0,
      'acquisition_accessor_id'   : 'getRelativeUrl',
      'acquisition_depends'       : None,
      'mode'        : 'w' },
    # Accounting
    { 'id'          : 'quantity',
      'description' : """The quantity of resource.""",
      'type'        : 'float',
      'range'       : True,
      'default'     : 0.0,
      'acquisition_base_category'     : ('order','delivery',),
      'acquisition_portal_type'       : Expression('python: portal.getPortalAcquisitionMovementTypeList() + portal.getPortalDeliveryTypeList()'),
      'acquisition_copy_value'        : 0,
      'acquisition_mask_value'        : 1,
      'acquisition_accessor_id'       : 'getQuantity',
      'acquisition_depends'           : None,
      'mode'        : 'w' },
    { 'id'          : 'cancellation_amount',
      'description' : 'Defines if this quantity is used in order to cancel another one',
      'type'        : 'boolean',
      'default': False,
      'mode'        : 'w' },
    # quantity_sign is used by QuantitySignMovementGroup
    # When comparing a delivery to a property_dict coming from a MovementGroup,
    # the DeliveryBuilder needs to have at least a specific property for each MovementGroup
    { 'id'          : 'quantity_sign',
      'description' : 'Defines if the quantity is positive or negative',
      'type'        : 'float',
      'mode'        : 'w' },
    { 'id'          : 'efficiency',
      'description' : """The efficiency.""",
      'type'        : 'float',
      'default'     : 1.0,
      'acquisition_base_category'     : ('delivery',),
      'acquisition_portal_type'       : Expression('python: portal.getPortalAcquisitionMovementTypeList() + portal.getPortalDeliveryTypeList()'),
      'acquisition_copy_value'        : 0,
      'acquisition_mask_value'        : 1,
      'acquisition_accessor_id'       : 'getEfficiency',
      'acquisition_depends'           : None,
      #'get_adapter_id'                :
      #'set_adapater_id'               :
      #'has_adapater_id'               :
      'mode'        : 'w' },
    # Profit and loss
    { 'id'          : 'profit_quantity', # XXX-JPS - probably deprecated
      'description' : 'A quantity which represents generation of resource from nowhere',
      'type'        : 'float',
      'default'     : 0.0,
      'mode'        : 'w' },
  )

  _categories = ('resource', 'quantity_unit',
                 'base_application', 'base_contribution', 'use', 'trade_phase', 
                 # Acquired categories
                 'product_line', )
  
