Amount.py 24 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 30 31
#
# 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 Globals import InitializeClass
from AccessControl import ClassSecurityInfo
32 33
from Products.ERP5.Variated import Variated
from Products.ERP5.VariationValue import VariationValue
34
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from Products.ERP5Type.Base import Base
36
from Products.ERP5Type.Base import TempBase
37
from Products.CMFCategory.Renderer import Renderer
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38

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
  __implements__ = (interfaces.IVariated)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
72 73
  # A few more mix-in methods which should be relocated
  # THIS MUST BE UPDATE WITH CATEGORY ACQUISITION
74 75
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getVariationCategoryList')
76
  def getVariationCategoryList(self, default=[], base_category_list=(),
77
      omit_optional_variation=0, omit_option_base_category=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
78 79 80 81
    """
      Returns the possible discrete variations
      (as a list of relative urls to categories)
    """
82 83 84 85 86 87
    #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
88 89 90
    result = []
    resource = self.getDefaultResourceValue()
    if resource is not None:
91
      resource_variation_list = resource.getVariationBaseCategoryList(
92
          omit_optional_variation=omit_optional_variation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
93
      if len(base_category_list) > 0 :
94 95
        variation_list = filter(lambda x: x in base_category_list,
                                resource_variation_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96 97 98
      else :
        variation_list = resource_variation_list
      if len(variation_list) > 0:
99
        result = self.getAcquiredCategoryMembershipList(variation_list, base=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100 101
    return result

102
  security.declareProtected(Permissions.AccessContentsInformation,
103
                            'getVariationCategoryItemList')
104
  def getVariationCategoryItemList(self, base_category_list=(), base=1,
105
                                   display_id='logical_path',
106
                                   current_category=None,**kw):
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    """
      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,
128
                             display_id=display_id, **kw).\
129 130 131 132 133
                                               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,
134
                             base_category=base_category,
135 136
                             display_none_category=0, base=base,
                             current_category=current_category,
137
                             display_id='title', **kw).\
138 139 140
                                               render(object_list))
    return variation_category_item_list

141 142
  security.declareProtected(Permissions.ModifyPortalContent, 
                            '_setVariationCategoryList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
143 144 145 146 147 148 149 150
  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)

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

157
  security.declareProtected(Permissions.AccessContentsInformation,
158
                            'getVariationBaseCategoryList')
159
  def getVariationBaseCategoryList(self, default=[],
160
      omit_optional_variation=0, omit_option_base_category=None):
161
    """
162
      Return the list of base_category from all variation related to
163
      amount.
164 165
      It is maybe a nonsense, but useful for correcting user errors.
    """
166 167 168 169 170 171
    #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

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

180 181
  security.declareProtected(Permissions.AccessContentsInformation, 
                            'getVariationBaseCategoryItemList')
182
  def getVariationBaseCategoryItemList(self,display_id='getTitleOrId',**kw):
183 184 185 186 187 188 189 190 191
    """
    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
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
  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()

213 214
  security.declareProtected(Permissions.AccessContentsInformation, \
                            'getVariationRangeCategoryItemList')
215
  def getVariationRangeCategoryItemList(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
216
    """
217 218 219 220 221 222
      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
223
    """
224 225 226
    resource = self.getResourceValue()
    if resource != None:
      result = resource.getVariationCategoryItemList(
227
                               omit_individual_variation=0,**kw)
228 229 230
    else:
      result = []
    return result
231

232 233
  security.declareProtected(Permissions.AccessContentsInformation, \
                            'getVariationRangeCategoryList')
234 235
  def getVariationRangeCategoryList(self, default=[], base_category_list=(),
      base=1, **kw):
236
    """
237 238
      Returns possible variation category values for the
      order line according to the default resource.
239
    """
240 241
    return [x[1] for x in self.getVariationRangeCategoryItemList(
                                     base_category_list=base_category_list,
242
                                     base=base, **kw)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
243 244

  security.declareProtected(Permissions.AccessContentsInformation,
245
                            'getVariationRangeBaseCategoryList')
246 247
  def getVariationRangeBaseCategoryList(self, default=[],
      omit_optional_variation=0, omit_option_base_category=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
248 249 250 251 252 253 254 255 256 257
    """
        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
    """
258 259 260 261 262 263
    #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

264
    resource = self.getDefaultResourceValue()
265
    if resource is not None:
266
      result = resource.getVariationBaseCategoryList(
267
          omit_optional_variation=omit_optional_variation)
268
    else:
269
      result = Variated.getVariationRangeBaseCategoryList(self)
270
    return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
271

272 273
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getVariationRangeBaseCategoryItemList')
274 275 276
  def getVariationRangeBaseCategoryItemList(self, omit_optional_variation=0,
      omit_option_base_category=None, display_id="title",
      display_none_category=0):
277 278 279 280 281
    """
        Returns possible variations base categories for this amount ie.
        the variation base category of the resource (not the
        variation range).
    """
282 283 284 285 286 287
    #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

288
    return self.portal_categories.getItemList(
289 290 291 292
        self.getVariationRangeBaseCategoryList(
            omit_optional_variation=omit_optional_variation),
        display_id=display_id,
        display_none_category=display_none_category)
293

294 295 296 297 298 299 300 301 302 303
  #####################################################################
  #  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.
304
      The variation property list is defined on resource,
305 306 307
      with setVariationPropertyList.
    """
    property_dict = {}
308
    resource = self.getDefaultResourceValue()
309 310 311 312
    if resource is not None:
      variation_list = resource.getVariationPropertyList()
      for variation_property in variation_list:
        property_dict[variation_property] = \
313
            self.getProperty(variation_property)
314 315
    return property_dict

316
  security.declareProtected(Permissions.ModifyPortalContent,
317 318 319 320 321 322
                            '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.
323
      If one of the property_id is not a variation, a exception
324 325
      KeyError is raised.
    """
326
    resource = self.getDefaultResourceValue()
327 328 329 330 331 332 333 334 335
    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:
336 337 338
        try:
          self.setProperty(property_id, property_value)
        except KeyError:
339
          LOG("Amount", ERROR, "Can not set %s with value %s on %s" % \
340 341
                    (property_id, property_value, self.getRelativeUrl()))
          raise
342

Jean-Paul Smets's avatar
Jean-Paul Smets committed
343 344 345
  security.declareProtected(Permissions.AccessContentsInformation,
                                                 'getQuantityUnitRangeItemList')
  def getQuantityUnitRangeItemList(self, base_category_list=()):
346 347 348 349
    resource = self.getDefaultResourceValue()
    if resource is not None:
      result = resource.getQuantityUnitList()
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
350 351 352 353 354 355
      result = ()
    if result is ():
      return self.portal_categories.quantity_unit.getFormItemList()
    else:
      return result

356 357 358 359 360
  security.declareProtected(Permissions.AccessContentsInformation, 'getResourceDefaultQuantityUnit')
  def getResourceDefaultQuantityUnit(self):
    """
      Return default quantity unit of the resource
    """
361 362 363
    resource = self.getResourceValue()
    resource_quantity_unit = None
    if resource is not None:
364 365
      resource_quantity_unit = resource.getDefaultQuantityUnit()
      #LOG("ERP5 WARNING:", 100, 'could not convert quantity for %s' % self.getRelativeUrl())
366
    return  resource_quantity_unit
367

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

396 397 398 399
  def getPrice(self):
    pass
  
  
400
  security.declareProtected(Permissions.AccessContentsInformation, 'getTotalPrice')
Aurel's avatar
Aurel committed
401
  def getTotalPrice(self, **kw):
402
    """
403 404 405 406
      Return total price for the number of items
      
      Price is defined on 
      
407
    """
408 409 410 411
    price = self.getResourcePrice()
    quantity = self.getNetConvertedQuantity()
    if isinstance(price, (int, float)) and isinstance(quantity, (int, float)):
      return quantity * price
412

Jean-Paul Smets's avatar
Jean-Paul Smets committed
413 414 415 416 417 418
  # Conversion to standard unit
  security.declareProtected(Permissions.AccessContentsInformation, 'getConvertedQuantity')
  def getConvertedQuantity(self):
    """
      Converts quantity to default unit
    """
419 420 421
    resource = self.getResourceValue()
    quantity_unit = self.getQuantityUnit()
    quantity = self.getQuantity()
422 423 424 425 426 427 428 429
    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
430

431 432
  security.declareProtected(Permissions.ModifyPortalContent, 'setConvertedQuantity')
  def setConvertedQuantity(self, value):
433 434
    resource = self.getResourceValue()
    quantity_unit = self.getQuantityUnit()
435 436 437 438 439 440 441
    if value is not None and quantity_unit and resource is not None:
      quantity = resource.convertQuantity(value,
                                          resource.getDefaultQuantityUnit(),
                                          quantity_unit,
                                          self.getVariationCategoryList())
      if quantity is not None:
        return self.setQuantity(quantity)
442

Jean-Paul Smets's avatar
Jean-Paul Smets committed
443 444 445 446 447 448 449
  security.declareProtected(Permissions.AccessContentsInformation, 'getNetQuantity')
  def getNetQuantity(self):
    """
      Take into account efficiency in quantity
    """
    quantity = self.getQuantity()
    efficiency = self.getEfficiency()
450
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
451 452 453 454 455 456 457
      efficiency = 1.0
    return float(quantity) / efficiency

  security.declareProtected(Permissions.AccessContentsInformation, 'getNetTargetQuantity')
  def getNetTargetQuantity(self):
    """
      Take into account efficiency in target quantity
458
      XXX - dreprecated
Jean-Paul Smets's avatar
Jean-Paul Smets committed
459 460 461
    """
    quantity = self.getTargetQuantity()
    efficiency = self.getTargetEfficiency()
462
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
463 464 465 466 467 468 469 470 471 472
      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()
473
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
474
      efficiency = 1.0
475
    if quantity not in (None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
476 477 478 479
      return float(quantity) / efficiency
    else:
      return None

480 481 482 483 484 485
  security.declareProtected(Permissions.ModifyPortalContent, 'setNetConvertedQuantity')
  def setNetConvertedQuantity(self, value):
    """
      Take into account efficiency in converted quantity
    """
    efficiency = self.getEfficiency()
486
    if efficiency in (0, 0.0, None, ''):
487
      efficiency = 1.0
488
    if value not in (None, ''):
489
      quantity = float(value) * efficiency
490 491
    else:
      quantity = value
492 493
    self.setConvertedQuantity(quantity)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
494 495 496 497 498 499 500
  security.declareProtected(Permissions.AccessContentsInformation, 'getNetConvertedTargetQuantity')
  def getNetConvertedTargetQuantity(self):
    """
      Take into account efficiency in converted target quantity
    """
    quantity = self.getConvertedTargetQuantity()
    efficiency = self.getTargetEfficiency()
501
    if efficiency in (0, 0.0, None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
502
      efficiency = 1.0
503
    if quantity not in (None, ''):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
504 505 506 507
      return float(quantity) / efficiency
    else:
      return None

508 509 510 511 512 513 514 515
  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
516
    if value not in (None, ''):
517
      quantity = float(value) * efficiency
518 519
    else:
      quantity = value
520 521
    self.setConvertedTargetQuantity(quantity)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
522 523 524 525 526 527 528 529 530
  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')
531
  def getProductionQuantity(self,quantity=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
532 533 534
    """
      Return the produced quantity
    """
535 536
    if quantity is None:
      quantity = self.getQuantity()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
537 538 539
    source = self.getSource()
    destination = self.getDestination()

540
    if quantity is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
541
      quantity = float(quantity)
542
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
      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')
558
  def getConsumptionQuantity(self,quantity=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
559
    """
560
      Return the consumption quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
561
    """
562 563
    if quantity is None:
      quantity = self.getQuantity()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
564 565 566
    source = self.getSource()
    destination = self.getDestination()

567
    if quantity is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
568
      quantity = float(quantity)
569
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
      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()
591
    quantity = value
Jean-Paul Smets's avatar
Jean-Paul Smets committed
592

593 594 595
    if quantity is not None:
      quantity = float(quantity)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
596 597 598
      quantity = 0.0

    if source in (None, ''):
599
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
600 601 602
        self.setQuantity(quantity)

    if destination in (None, ''):
603
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
604 605 606 607 608 609 610 611 612
        self.setQuantity(- quantity)

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

615 616 617
    if quantity is not None:
      quantity = float(quantity)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
618 619 620
      quantity = 0.0

    if destination in (None, ''):
621
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
622 623 624
        self.setQuantity(quantity)

    if source in (None, ''):
625
      if quantity >= 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
626 627
        self.setQuantity(- quantity)

628 629 630 631 632 633 634 635 636
  # Inventory
  security.declareProtected(Permissions.AccessContentsInformation, 'getConvertedInventory')
  def getConvertedInventory(self):
    """
      provides a default inventory value - None since
      no inventory was defined.
    """
    return None

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
#   # 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  
    
654 655 656 657 658 659 660 661 662 663 664
  # Profit and Loss
  security.declareProtected(Permissions.ModifyPortalContent, 'getLostQuantity')
  def getLostQuantity(self):
    return - self.getProfitQuantity()

  security.declareProtected(Permissions.AccessContentsInformation, 'setLostQuantity')
  def setLostQuantity(self, value):
    return self.setProfitQuantity(- value)

  def _setLostQuantity(self, value):
    return self._setProfitQuantity(- value)