Resource.py 9.55 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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 Resource:
    """
        Properties which allow to define a generic Resource.

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

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

    _properties = (
        # Pricing properties
        {   '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'          : 'base_price',
            'description' : 'A default per unit price used for internal price calculations',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'priced_quantity',
            'description' : 'Number of units involved in base prices',
            'type'        : 'float',
            'default'     : 1.0,
            'mode'        : 'w' },
67 68 69 70 71
        {   'id'          : 'consumer_unit_quantity',
            'description' : 'Number of consumer_unit involved in the resoure (sku)',
            'type'        : 'float',
            'default'     : 1.0,
            'mode'        : 'w' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
72 73 74 75 76 77 78 79 80 81
        # Physical properties
        {   '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' },
        {   'id'          : 'base_length',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
82
            'description' : 'A typical per unit length of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
83 84 85
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'base_width',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
86
            'description' : 'A typical per unit width of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
87 88 89
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'base_height',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
90 91 92 93 94
            'description' : 'A typical per unit height of the resource',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'base_surface',
            'description' : 'A typical per unit surface of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
95 96 97 98 99 100 101 102 103 104 105 106
            'type'        : 'float',
            'mode'        : 'w' },
        # Basic conversion properties
        # A property is set on categories to define if it is length, weight etc.
        # another property defines the conversion to the default lenght
        #                                         (ie. nomber of meters in 1 inch)
        # This allows to implement universal conversions
        {   'id'          : 'length_quantity',
            'description' : 'length of the resource',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'weight_quantity',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
107 108 109 110
            'description' : 'weight of the resource',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'height_quantity',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
111 112 113 114
            'description' : 'height of the resource',
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'surface_quantity',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
115
            'description' : 'surface area of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
116 117 118
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'volume_quantity',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
119
            'description' : 'volume of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
120 121 122
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'unit_quantity',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
123
            'description' : 'units of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124 125 126
            'type'        : 'float',
            'mode'        : 'w' },
        {   'id'          : 'time_quantity',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
127
            'description' : 'time of the resource',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
            'type'        : 'float',
            'mode'        : 'w' },
        # Definition of the variation domain
        {   'id'          : 'variation_base_category',
            'storage_id'  : 'variation_base_category_list', # Coramy Compatibility
            'description' : 'A list of base categories which define possible discrete variations. '\
                            'Variation ranges are stored as category membership. '\
                            '(prev. variation_category_list).',
            'type'        : 'tokens',
            'default'     : [],
            'mode'        : 'w' },
        {   'id'          : 'variation_property',
            'storage_id'  : 'variation_property_list', # Coramy Compatibility
            'description' : 'A list of properties which define continuous variations'\
                            'The range is defined by adding _range_min '\
                            'and _range_max. During the indexation process'\
                            'the variation properties are stores in the index',
            'type'        : 'tokens',
            'default'     : [],
            'mode'        : 'w' },
        # Sourcing / planning properties
        {   'id'          : 'source_reference',
            'storage_id'  : 'default_source_reference', # Compatibility
            'description' : 'The references of the resource for default sources',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'source_title',
            'storage_id'  : 'default_source_title', # Compatibility
            'description' : 'The titles of the sources 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',
            'storage_id'  : 'default_destination_reference', # Compatibility
            'description' : 'The references of the resource for default destinations',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'destination_title',
            'storage_id'  : 'default_destination_title', # Compatibility
            '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' },
179 180 181 182 183 184 185 186 187 188 189
        # Default attributes overriden in supply lines (should be in supply line)
        {   'id'          : 'trade_description',
            'description' : 'A description of the document intended for client',
            'type'        : 'text',
            'default'     : '',
            'mode'        : 'w' },
        {   'id'          : 'instructions',
            'description' : 'instructions in order to explain how to use the resource',
            'type'        : 'text',
            'default'     : '',
            'mode'        : 'w' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
190 191 192 193 194 195 196

    )

    _categories = ( 'source', 'destination', 'quantity_unit', 'price_unit',
                    'weight_unit', 'length_unit', 'height_unit', 'width_unit',
                    'volume_unit',
                    'price_currency',  'source_price_currency',
197
                    'destination_price_currency', 'product_line',)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
198