Amount.py 26.7 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002, 2004 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
5
#                    Romain Courteaud <romain@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
import zope.interface
31
from math import log
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32
from AccessControl import ClassSecurityInfo
33 34
from Products.ERP5.Variated import Variated
from Products.ERP5.VariationValue import VariationValue
35
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from Products.ERP5Type.Base import Base
37
from Products.CMFCategory.Renderer import Renderer
38
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
39

40
from zLOG import LOG, ERROR
41
from warnings import warn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42

43

Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45 46 47 48 49 50 51 52 53 54 55
class Amount(Base, Variated):
  """
    A mix-in class which provides some utilities
    (variations, conversions, etc.)

    Utilities include

    - getVariation accesors (allows to access variations of whatever)

    -
  """

56 57 58
  meta_type = 'ERP5 Amount'
  portal_type = 'Amount'

Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60
  # Declarative security
  security = ClassSecurityInfo()
61
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62 63

  # Declarative interfaces
64 65
  zope.interface.implements(interfaces.IVariated,
                            interfaces.IAmount)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
66

67 68 69 70
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
                    , PropertySheet.Amount
                    , PropertySheet.Price
71
                    )
72

Jean-Paul Smets's avatar
Jean-Paul Smets committed
73 74
  # A few more mix-in methods which should be relocated
  # THIS MUST BE UPDATE WITH CATEGORY ACQUISITION
75 76
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getVariationCategoryList')
77
  def getVariationCategoryList(self, default=[], base_category_list=(),
78
      omit_optional_variation=0, omit_option_base_category=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
79 80 81 82
    """
      Returns the possible discrete variations
      (as a list of relative urls to categories)
    """
83 84 85 86 87 88
    #XXX backwards compatibility
    if omit_option_base_category is not None:
      warn("Please use omit_optional_variation instead of"\
          " omit_option_base_category.", DeprecationWarning)
      omit_optional_variation = omit_option_base_category

Jean-Paul Smets's avatar
Jean-Paul Smets committed
89 90 91
    result = []
    resource = self.getDefaultResourceValue()
    if resource is not None:
92
      resource_variation_list = resource.getVariationBaseCategoryList(
93
          omit_optional_variation=omit_optional_variation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
94
      if len(base_category_list) > 0 :
95 96
        variation_list = filter(lambda x: x in base_category_list,
                                resource_variation_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
97 98 99
      else :
        variation_list = resource_variation_list
      if len(variation_list) > 0:
100
        result = self.getAcquiredCategoryMembershipList(variation_list, base=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
101 102
    return result

103
  security.declareProtected(Permissions.AccessContentsInformation,
104
                            'getVariationCategoryItemList')
105
  def getVariationCategoryItemList(self, base_category_list=(), base=1,
106
                                   display_id='logical_path',
107
                                   current_category=None,**kw):
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    """
      Returns the list of possible variations
      XXX Copied and modified from Variated
      Result is left display.
    """
    variation_category_item_list = []
    if base_category_list == ():
      base_category_list = self.getVariationRangeBaseCategoryList()

    for base_category in base_category_list:
      variation_category_list = self.getVariationCategoryList(
                                          base_category_list=[base_category])

      resource_list = [self.portal_categories.resolveCategory(x) for x in\
                       variation_category_list]
      category_list = [x for x in resource_list \
                       if x.getPortalType() == 'Category']
      variation_category_item_list.extend(Renderer(
                             is_right_display=0,
                             display_none_category=0, base=base,
                             current_category=current_category,
129
                             display_id=display_id, **kw).\
130 131 132 133 134
                                               render(category_list))
      object_list = [x for x in resource_list \
                       if x.getPortalType() != 'Category']
      variation_category_item_list.extend(Renderer(
                             is_right_display=0,
135
                             base_category=base_category,
136 137
                             display_none_category=0, base=base,
                             current_category=current_category,
138
                             display_id='title', **kw).\
139 140 141
                                               render(object_list))
    return variation_category_item_list

142 143
  security.declareProtected(Permissions.ModifyPortalContent, 
                            '_setVariationCategoryList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144 145 146 147 148 149 150 151
  def _setVariationCategoryList(self, value):
    result = []
    resource = self.getDefaultResourceValue()
    if resource is not None:
      variation_list = resource.getVariationBaseCategoryList()
      if len(variation_list) > 0:
        self._setCategoryMembership(variation_list, value, base = 1)

152 153
  security.declareProtected(Permissions.ModifyPortalContent, 
                            'setVariationCategoryList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
154 155 156 157
  def setVariationCategoryList(self, value):
    self._setVariationCategoryList(value)
    self.reindexObject()

158
  security.declareProtected(Permissions.AccessContentsInformation,
159
                            'getVariationBaseCategoryList')
160
  def getVariationBaseCategoryList(self, default=[],
161
      omit_optional_variation=0, omit_option_base_category=None):
162
    """
163
      Return the list of base_category from all variation related to
164
      amount.
165 166
      It is maybe a nonsense, but useful for correcting user errors.
    """
167 168 169 170 171 172
    #XXX backwards compatibility
    if omit_option_base_category is not None:
      warn("Please use omit_optional_variation instead of"\
          " omit_option_base_category.", DeprecationWarning)
      omit_optional_variation = omit_option_base_category

173
    base_category_list = []
174
    for category in self.getVariationCategoryList(
175
        omit_optional_variation=omit_optional_variation):
176 177 178 179
      base_category = category.split('/')[0]
      if base_category not in base_category_list:
        base_category_list.append(base_category)
    return base_category_list
180

181 182 183 184 185 186 187 188
  security.declareProtected(Permissions.ModifyPortalContent,
                            'setVariationBaseCategoryList')
  def setVariationBaseCategoryList(self, node_list):
    """Do nothing in the case of an amount, because variation base category
    list are set on the resource.
    """
    pass

189 190
  security.declareProtected(Permissions.AccessContentsInformation, 
                            'getVariationBaseCategoryItemList')
191
  def getVariationBaseCategoryItemList(self,display_id='getTitleOrId',**kw):
192 193 194 195 196 197 198 199 200
    """
    Returns a list of base_category tuples.
    """
    return self.portal_categories.getItemList(
                                    self.getVariationBaseCategoryList(),
                                    display_id=display_id,**kw)

  security.declareProtected(Permissions.AccessContentsInformation, 
                            'getVariationValue')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  def getVariationValue(self):
    """
      New Method for dicrete and countinuous variations
      using a VariantValue instance

      A new instance of VariationValue is created with categories
      and attributes set to what they should be.

      A this point, we only implement discrete variations
    """
    return VariationValue(context = self)

  security.declareProtected(Permissions.ModifyPortalContent, '_setVariationValue')
  def _setVariationValue(self, variation_value):
    return variation_value.setVariationValue(self)

  security.declareProtected(Permissions.ModifyPortalContent, 'setVariationValue')
  def setVariationValue(self, variation_value):
    self._setVariationValue(variation_value)
    self.reindexObject()

222
  security.declareProtected(Permissions.AccessContentsInformation, \
223
                            'getVariationRangeCategoryItemList')
224
  def getVariationRangeCategoryItemList(self, *args, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
225
    """
226 227 228 229 230 231
      Returns possible variation category values for the
      order line according to the default resource.
      Possible category values is provided as a list of
      tuples (id, title). This is mostly
      useful in ERP5Form instances to generate selection
      menus.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
232
    """
233
    resource = self.getResourceValue()
234 235
    if resource is None:
      return []
236
    kw['omit_individual_variation'] = 0
237
    return resource.getVariationCategoryItemList(*args, **kw)
238

239 240
  security.declareProtected(Permissions.AccessContentsInformation, \
                            'getVariationRangeCategoryList')
241 242
  def getVariationRangeCategoryList(self, default=[], base_category_list=(),
      base=1, **kw):
243
    """
244 245
      Returns possible variation category values for the
      order line according to the default resource.
246
    """
247 248
    return [x[1] for x in self.getVariationRangeCategoryItemList(
                                     base_category_list=base_category_list,
249
                                     base=base, **kw)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
250 251

  security.declareProtected(Permissions.AccessContentsInformation,
252
                            'getVariationRangeBaseCategoryList')
253 254
  def getVariationRangeBaseCategoryList(self, default=[],
      omit_optional_variation=0, omit_option_base_category=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
255 256 257 258 259 260 261 262 263 264
    """
        Returns possible variations base categories for this amount ie.
        the variation base category of the resource (not the
        variation range).

        Should be a range because we shall variate the amount
        into cells (ie. the line into cells) on part of the
        getVariationRangeBaseCategoryList -> notion of
        getVariationBaseCategoryList is different
    """
265 266 267 268 269 270
    #XXX backwards compatibility
    if omit_option_base_category is not None:
      warn("Please use omit_optional_variation instead of"\
          " omit_option_base_category.", DeprecationWarning)
      omit_optional_variation = omit_option_base_category

271
    resource = self.getDefaultResourceValue()
272
    if resource is not None:
273
      result = resource.getVariationBaseCategoryList(
274
          omit_optional_variation=omit_optional_variation)
275
    else:
276
      result = Variated.getVariationRangeBaseCategoryList(self)
277
    return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
278

279 280
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getVariationRangeBaseCategoryItemList')
281 282 283
  def getVariationRangeBaseCategoryItemList(self, omit_optional_variation=0,
      omit_option_base_category=None, display_id="title",
      display_none_category=0):
284 285 286 287 288
    """
        Returns possible variations base categories for this amount ie.
        the variation base category of the resource (not the
        variation range).
    """
289 290 291 292 293 294
    #XXX backwards compatibility
    if omit_option_base_category is not None:
      warn("Please use omit_optional_variation instead of"\
          " omit_option_base_category.", DeprecationWarning)
      omit_optional_variation = omit_option_base_category

295
    return self.portal_categories.getItemList(
296 297 298 299
        self.getVariationRangeBaseCategoryList(
            omit_optional_variation=omit_optional_variation),
        display_id=display_id,
        display_none_category=display_none_category)
300

301 302 303 304 305 306 307 308 309 310
  #####################################################################
  #  Variation property API
  #####################################################################
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getVariationPropertyDict')
  def getVariationPropertyDict(self):
    """
      Return a dictionary of:
        {property_id: property_value,}
      Each property is a variation of the resource.
311
      The variation property list is defined on resource,
312 313 314
      with setVariationPropertyList.
    """
    property_dict = {}
315
    resource = self.getDefaultResourceValue()
316 317 318 319
    if resource is not None:
      variation_list = resource.getVariationPropertyList()
      for variation_property in variation_list:
        property_dict[variation_property] = \
320
            self.getProperty(variation_property)
321 322
    return property_dict

323
  security.declareProtected(Permissions.ModifyPortalContent,
324 325 326 327 328 329
                            'setVariationPropertyDict')
  def setVariationPropertyDict(self, property_dict):
    """
      Take a parameter a property dict like:
        {property_id: property_value,}
      Each property is a variation of the resource.
330
      If one of the property_id is not a variation, a exception
331 332
      KeyError is raised.
    """
333
    resource = self.getDefaultResourceValue()
334 335 336 337 338 339 340 341 342
    if resource is not None:
      variation_list = resource.getVariationPropertyList()
    else:
      variation_list = []
    for property_id, property_value in property_dict.items():
      if property_id not in variation_list:
        raise KeyError, "Can not set the property variation '%s'" % \
                        property_id
      else:
343 344 345
        try:
          self.setProperty(property_id, property_value)
        except KeyError:
346
          LOG("Amount", ERROR, "Can not set %s with value %s on %s" % \
347 348
                    (property_id, property_value, self.getRelativeUrl()))
          raise
349

Jean-Paul Smets's avatar
Jean-Paul Smets committed
350 351 352
  security.declareProtected(Permissions.AccessContentsInformation,
                                                 'getQuantityUnitRangeItemList')
  def getQuantityUnitRangeItemList(self, base_category_list=()):
353 354 355 356
    resource = self.getDefaultResourceValue()
    if resource is not None:
      result = resource.getQuantityUnitList()
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
357 358 359 360 361 362
      result = ()
    if result is ():
      return self.portal_categories.quantity_unit.getFormItemList()
    else:
      return result

363 364 365 366 367
  security.declareProtected(Permissions.AccessContentsInformation, 'getResourceDefaultQuantityUnit')
  def getResourceDefaultQuantityUnit(self):
    """
      Return default quantity unit of the resource
    """
368 369 370
    resource = self.getResourceValue()
    resource_quantity_unit = None
    if resource is not None:
371 372
      resource_quantity_unit = resource.getDefaultQuantityUnit()
      #LOG("ERP5 WARNING:", 100, 'could not convert quantity for %s' % self.getRelativeUrl())
373
    return  resource_quantity_unit
374

375 376
  security.declareProtected(Permissions.AccessContentsInformation, 'getResourcePrice')
  def getResourcePrice(self):
377
    """
378 379 380
      Return price of the resource in the current context
      
      The price is expressed in the standard unit of the resource (?)
381 382
    """
    resource = self.getResourceValue()
383 384 385 386
    if resource is not None:
      return resource.getPrice(context=self)
    return None
      
387 388 389 390 391 392 393
  security.declareProtected(Permissions.AccessContentsInformation, 'getDuration')
  def getDuration(self):
    """
      Return duration in minute
    """
    quantity = self.getQuantity()
    quantity_unit = self.getQuantityUnit()
394 395
    if quantity_unit is None:
      return None
396
    common_time_category = 'time'
397
    if common_time_category in quantity_unit[:len(common_time_category)]:
398 399 400 401 402
      duration = quantity
    else:
      duration = None
    return duration

403 404 405 406
  def getPrice(self):
    pass
  
  
407
  security.declareProtected(Permissions.AccessContentsInformation, 'getTotalPrice')
Aurel's avatar
Aurel committed
408
  def getTotalPrice(self, **kw):
409
    """
410 411 412 413
      Return total price for the number of items
      
      Price is defined on 
      
414
    """
415 416 417 418
    price = self.getResourcePrice()
    quantity = self.getNetConvertedQuantity()
    if isinstance(price, (int, float)) and isinstance(quantity, (int, float)):
      return quantity * price
419

420
  def _getBaseUnitPrice(self, context):
421 422 423 424 425 426 427 428 429
    # Stop any recursive call to this method. This happens when a Path
    # does not have base unit price locally, so it looks it up, and
    # each path of a predicate list does the same again.
    tv = getTransactionalVariable(self)
    key = '_getBaseUnitPrice'
    if key in tv:
      return
    tv[key] = 1
    try:
430
      resource = context.getResourceValue()
431 432 433 434 435 436 437
      if resource is not None:
        operand_dict = resource.getPriceParameterDict(context=context)
        if operand_dict is not None:
          base_unit_price = operand_dict.get('base_unit_price', None)
          return base_unit_price
    finally:
      del tv[key]
438 439

  security.declareProtected(Permissions.AccessContentsInformation, 'getBaseUnitPrice')
440
  def getBaseUnitPrice(self, context=None, **kw):
441 442 443 444 445 446 447 448
    """
      Get the base unit price.

      If the property is not stored locally, look up one and store it.
    """
    local_base_unit_price = self._baseGetBaseUnitPrice()
    if local_base_unit_price is None:
      # We must find a base unit price for this movement
449 450 451
      if context is None:
        context = self
      local_base_unit_price = self._getBaseUnitPrice(context=context)
452 453 454 455 456 457 458 459 460 461 462 463 464 465
    return local_base_unit_price

  security.declareProtected(Permissions.AccessContentsInformation, 
                            'getPricePrecision')
  def getPricePrecision(self):
    """Return the floating point precision of a price.
    """
    # First, try to use a base unit price. If not available, use
    # the older way of using a price currency.
    try:
      return int(round(- log(self.getBaseUnitPrice(), 10), 0))
    except TypeError:
      return self.getQuantityPrecisionFromResource(self.getPriceCurrency())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
466 467 468 469 470 471
  # Conversion to standard unit
  security.declareProtected(Permissions.AccessContentsInformation, 'getConvertedQuantity')
  def getConvertedQuantity(self):
    """
      Converts quantity to default unit
    """
472 473 474
    resource = self.getResourceValue()
    quantity_unit = self.getQuantityUnit()
    quantity = self.getQuantity()
475 476 477 478 479 480 481 482
    if quantity is not None and quantity_unit and resource is not None:
      converted = resource.convertQuantity(quantity, quantity_unit,
                                           resource.getDefaultQuantityUnit(),
                                           self.getVariationCategoryList())
      # For compatibility, return quantity non-converted if conversion fails.
      if converted is not None:
        return converted
    return quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
483

484 485
  security.declareProtected(Permissions.ModifyPortalContent, 'setConvertedQuantity')
  def setConvertedQuantity(self, value):
486 487
    resource = self.getResourceValue()
    quantity_unit = self.getQuantityUnit()
488 489 490 491 492
    if value is not None and quantity_unit and resource is not None:
      quantity = resource.convertQuantity(value,
                                          resource.getDefaultQuantityUnit(),
                                          quantity_unit,
                                          self.getVariationCategoryList())
493 494 495 496
    else:
      quantity = value
    if quantity is not None:
      return self.setQuantity(quantity)
497

Jean-Paul Smets's avatar
Jean-Paul Smets committed
498 499 500 501 502 503 504
  security.declareProtected(Permissions.AccessContentsInformation, 'getNetQuantity')
  def getNetQuantity(self):
    """
      Take into account efficiency in quantity
    """
    quantity = self.getQuantity()
    efficiency = self.getEfficiency()
505
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
506 507 508 509 510 511 512
      efficiency = 1.0
    return float(quantity) / efficiency

  security.declareProtected(Permissions.AccessContentsInformation, 'getNetTargetQuantity')
  def getNetTargetQuantity(self):
    """
      Take into account efficiency in target quantity
513
      XXX - dreprecated
Jean-Paul Smets's avatar
Jean-Paul Smets committed
514 515 516
    """
    quantity = self.getTargetQuantity()
    efficiency = self.getTargetEfficiency()
517
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
518 519 520 521 522 523 524 525 526 527
      efficiency = 1.0
    return float(quantity) / efficiency

  security.declareProtected(Permissions.AccessContentsInformation, 'getNetConvertedQuantity')
  def getNetConvertedQuantity(self):
    """
      Take into account efficiency in converted quantity
    """
    quantity = self.getConvertedQuantity()
    efficiency = self.getEfficiency()
528
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
529
      efficiency = 1.0
530
    if quantity not in (None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
531 532 533 534
      return float(quantity) / efficiency
    else:
      return None

535 536 537 538 539 540
  security.declareProtected(Permissions.ModifyPortalContent, 'setNetConvertedQuantity')
  def setNetConvertedQuantity(self, value):
    """
      Take into account efficiency in converted quantity
    """
    efficiency = self.getEfficiency()
541
    if efficiency in (0, 0.0, None, ''):
542
      efficiency = 1.0
543
    if value not in (None, ''):
544
      quantity = float(value) * efficiency
545 546
    else:
      quantity = value
547 548
    self.setConvertedQuantity(quantity)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
549 550 551 552 553 554 555
  security.declareProtected(Permissions.AccessContentsInformation, 'getNetConvertedTargetQuantity')
  def getNetConvertedTargetQuantity(self):
    """
      Take into account efficiency in converted target quantity
    """
    quantity = self.getConvertedTargetQuantity()
    efficiency = self.getTargetEfficiency()
556
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
557
      efficiency = 1.0
558
    if quantity not in (None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
559 560 561 562
      return float(quantity) / efficiency
    else:
      return None

563 564 565 566 567 568 569 570
  security.declareProtected(Permissions.ModifyPortalContent, 'setNetConvertedTargetQuantity')
  def setNetConvertedTargetQuantity(self, value):
    """
      Take into account efficiency in converted quantity
    """
    efficiency = self.getEfficiency()
    if efficiency in (0, 0.0, None):
      efficiency = 1.0
571
    if value not in (None, ''):
572
      quantity = float(value) * efficiency
573 574
    else:
      quantity = value
575 576
    self.setConvertedTargetQuantity(quantity)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
577 578 579 580 581 582 583 584 585
  security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedQuantity')
  def getInventoriatedQuantity(self):
    """
      Take into account efficiency in converted target quantity
    """
    return self.getNetConvertedQuantity()

  # Helper methods to display quantities as produced / consumed
  security.declareProtected(Permissions.AccessContentsInformation, 'getProductionQuantity')
586
  def getProductionQuantity(self,quantity=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
587 588 589
    """
      Return the produced quantity
    """
590 591
    if quantity is None:
      quantity = self.getQuantity()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
592 593 594
    source = self.getSource()
    destination = self.getDestination()

595
    if quantity is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
596
      quantity = float(quantity)
597
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
      quantity = 0.0

    if source in (None, ''):
      if quantity > 0:
        return quantity
      else:
        return 0.0

    if destination in (None, ''):
      if quantity < 0:
        return - quantity
      else:
        return 0.0

  security.declareProtected(Permissions.AccessContentsInformation, 'getConsumptionQuantity')
613
  def getConsumptionQuantity(self,quantity=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
614
    """
615
      Return the consumption quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
616
    """
617 618
    if quantity is None:
      quantity = self.getQuantity()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
619 620 621
    source = self.getSource()
    destination = self.getDestination()

622
    if quantity is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
623
      quantity = float(quantity)
624
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
      quantity = 0.0

    if destination in (None, ''):
      if quantity > 0:
        return quantity
      else:
        return 0.0

    if source in (None, ''):
      if quantity < 0:
        return - quantity
      else:
        return 0.0

  security.declareProtected(Permissions.ModifyPortalContent, 'setProductionQuantity')
  def setProductionQuantity(self, value):
    """
      Return the produced quantity
    """
    source = self.getSource()
    destination = self.getDestination()
646
    quantity = value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
647

648 649 650
    if quantity is not None:
      quantity = float(quantity)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
651 652 653
      quantity = 0.0

    if source in (None, ''):
654
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
655 656 657
        self.setQuantity(quantity)

    if destination in (None, ''):
658
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
659 660 661 662 663 664 665 666 667
        self.setQuantity(- quantity)

  security.declareProtected(Permissions.ModifyPortalContent, 'setConsumptionQuantity')
  def setConsumptionQuantity(self, value):
    """
      Return the produced quantity
    """
    source = self.getSource()
    destination = self.getDestination()
668
    quantity = value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
669

670 671 672
    if quantity is not None:
      quantity = float(quantity)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
673 674 675
      quantity = 0.0

    if destination in (None, ''):
676
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
677 678 679
        self.setQuantity(quantity)

    if source in (None, ''):
680
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
681 682
        self.setQuantity(- quantity)

683 684 685 686 687 688 689 690 691
  # Inventory
  security.declareProtected(Permissions.AccessContentsInformation, 'getConvertedInventory')
  def getConvertedInventory(self):
    """
      provides a default inventory value - None since
      no inventory was defined.
    """
    return None

692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
#   # SKU vs. CU
#   security.declareProtected(Permissions.AccessContentsInformation, 'getStandardInventoriatedQuantity')
#   def getStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
#       
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
#       
#       For accounting, returns the quantity converted in a default unit
#     """
#     resource = self.getResourceValue()
#     result = self.getInventoriatedQuantity()
#     if resource is not None:
#       result = resource.standardiseQuantity(result)
#     return result  
    
709
  # Profit and Loss
710
  security.declareProtected(Permissions.AccessContentsInformation, 'getLostQuantity')
711 712 713
  def getLostQuantity(self):
    return - self.getProfitQuantity()

714
  security.declareProtected(Permissions.ModifyPortalContent, 'setLostQuantity')
715 716 717 718 719
  def setLostQuantity(self, value):
    return self.setProfitQuantity(- value)

  def _setLostQuantity(self, value):
    return self._setProfitQuantity(- value)
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740

  ## quantity_unit accessors for backward compatibility:
  ## (we used to acquire quantity_unit from the resources)
  security.declareProtected(Permissions.AccessContentsInformation,
      'getQuantityUnitValue')
  def getQuantityUnitValue(self):
    result = self.getDefaultValue('quantity_unit')
    if result is None:
      resource = self.getResourceValue()
      if resource is not None:
        result = resource.getQuantityUnitValue()
    return result

  security.declareProtected(Permissions.AccessContentsInformation,
      'getQuantityUnit')
  def getQuantityUnit(self):
    value = self.getQuantityUnitValue()
    if value is not None:
      return value.getCategoryRelativeUrl()
    return None