##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solane <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.
#
##############################################################################

class Movement:
    """
        Properties which allow to define a generic Resource.

        The underlying idea is that we only define 'base' attributes
        which correspond to a generic variations of the resource.

        Variations can change the base attributes by introduction
        new attributions such as 'option' attributes.
    """

    _properties = (
        {   'id'          : 'quantity_unit',
            'description' : 'The name of the unit to determine quantities',
            'type'        : 'string',
            'mode'        : 'w' },
        # Pricing attributes
        {   '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' },
        {   'id'          : 'default_base_price',
            'description' : 'A default per unit price used for internal price calculations',
            'type'        : 'float',
            'mode'        : 'w' },
        # Physical attributes
        {   'id'          : 'base_weight',
            'description' : 'A typical per unit weight of the resource',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'base_volume',
            'description' : 'A typical per unit volume of the resource',
            'type'        : 'float',
            'mode'        : 'w' },
        # Definition of the variation domain
        {   'id'          : 'variation_base_category_list',
            'description' : 'A list of base categories which define possible discrete variations',
            'type'        : 'tokens',
            'mode'        : 'w' },
        {   'id'          : 'variation_category_list',
            'description' : 'A list of categories which define possible discrete variations',
            'type'        : 'lines',
            'mode'        : 'w' },
        {   'id'          : 'variation_attribute_list',
            'description' : 'A list of attributes which define continuous variations'\
                            'The range is defined by adding _range_max ',
            'type'        : 'tokens',
            'mode'        : 'w' },
        # Sourcing / planning attributes
        {   'id'          : 'source_reference_list',
            'description' : 'The references of the resource for default sources',
            'type'        : 'lines',
            'mode'        : 'w' },
        {   'id'          : 'source_title_list',
            'description' : 'The titles of the destinations of this resource',
            'type'        : 'string',
            'acquisition_base_category'     : ('source',),
            'acquisition_portal_type'       : ('Organisation','MetaNode'),
            'acquisition_copy_value'        : 0,
            'acquisition_accessor_id'       : 'getTitle',
            'acquisition_depends'           : None,
            'mode'        : 'w' },
        {   'id'          : 'destination_reference_list',
            'description' : 'The references of the resource for default destinations',
            'type'        : 'lines',
            'mode'        : 'w' },
        {   'id'          : 'destination_title_list',
            'description' : 'The titles of the destinations of this resource',
            'type'        : 'string',
            'acquisition_base_category'     : ('destination',),
            'acquisition_portal_type'       : ('Organisation','MetaNode'),
            'acquisition_copy_value'        : 0,
            'acquisition_accessor_id'       : 'getTitle',
            'acquisition_depends'           : None,
            'mode'        : 'w' },

    )

    _categories = ( 'source', 'destination' )

