##############################################################################
#
# 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.
#
##############################################################################

from Products.CMFCore.Expression import Expression

class Price:
    """
        Properties which allow to define a generic Price.
    """

    _properties = (
        # Pricing properties
        {   'id'          : 'price',
            'description' : 'A typical per unit price',
            'type'        : 'float',
            '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'       : 'getPrice',
            'acquisition_depends'           : None,
            'mode'        : 'w' },
        {   'id'          : 'base_price',
            'description' : 'A typical per unit base price',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'priced_quantity',
            'description' : 'Number of units involved in base prices',
            'type'        : 'float',
            'default'     : 1.0,
            'mode'        : 'w' },
        # Asset Value Pricing
        {   'id'          : 'source_asset_price',
            'description' : 'Asset price from the source point of view',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'destination_asset_price',
            'description' : 'Asset price from the source point of view',
            'type'        : 'float',
            'mode'        : 'w' },
        # Pricing properties related to sourcing
        # Such price should be used very carefully since
        # They are incompatible with the multi company model
        {   'id'          : 'source_base_price',
            'description' : 'A typical per unit price at which this resource can be sourced (bought)',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'source_base_price_validity',
            'description' : 'Validity of the typical per unit price at which this resource can be sourced',
            'type'        : 'date',
            'mode'        : 'w' },
        {   'id'          : 'destination_base_price',
            'description' : 'A typical per unit price at which this resource can be supplied (sold)',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'destination_base_price_validity',
            'description' : 'Validity of the typical per unit price at which this resource can be supplied',
            'type'        : 'date',
            'mode'        : 'w' },
        # They are incompatible with the multi company model
        {   'id'          : 'quantity_step',
            'description' : 'A list of quantity values which define acceptable ranges',
            'type'        : 'float',
            'multivalued' : 1,
            'mode'        : 'w' },
    )

