Movement.py 39.8 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.
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
#
# 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.
#
##############################################################################

29
import zope.interface
30
from warnings import warn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from AccessControl import ClassSecurityInfo

33
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
34 35
from Products.ERP5Type.Base import Base

36
#from Products.ERP5.Core import MetaNode, MetaResource
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37 38 39

from Products.ERP5Type.XMLObject import XMLObject

40
from Products.ERP5.Document.Amount import Amount
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41

42
from zLOG import LOG, WARNING, DEBUG
43

Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
class Movement(XMLObject, Amount):
  """
    The Movement class allows to implement ERP5 universal accounting model.

    Movement instances are used in different situations:

    - Orders: Movement instances are use as a documentary object
      to define quantities in orders

    - Deliveries: movements track the actual transfer of resources
      in the past (accounting) or in the future (planning / budgetting)

    For example, the following objects are Orders:

    - a purchase order (the document we send to a supplier
      when we need some goods)

    - a sales order (the document we ask our customer
      to sign to confirm a sale)

    - a production order (the document we send to the workshop
      to confirm we need some operation / service to be achieved)

    Orders allow to describe a target, but can not be used to account
    the reality of actual transfered quantities.

    This is not the case for Deliveries:

    - an invoice (a delivery of money between abstract accounts)

    - a packing list (ie. a delivery of goods shipped)

    - a delivery report (ie. a delivery of goods received)

    - a production report (ie. a delivery of service)

    - a T/T report (a delivery of money between reals accounts)


83
    For planning, the following approach is used:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

    1- Movements from an order are never modified once the order
       is confirmed. This is a rule. An Order is like a contract.
       It can only be amended, if all parties agree.

    2- Movements in a delivery may exist on their own
       (ex. an accounting transaction). Past movements
       can not be modified. Future movements may or may
       not be modified

    When an order is confirmed, the list of "order" movements
    it contains is copied into "delivery" movements. Each delivery
    movement contains a "causality" reference to the order
    it. This allows delivery to be completely different from order
    (ex. different resource, different date, different quantity)
    and allows to keep track of the causal relation between
    a delivery and an order.

102
    A delivery document (actually a delivery line) then points to one or more of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
    the "delivery" movements in the simulation. It is possible to know
    which items have been delivered by making sure each movement in the simulation
    is associated to a "delivery document".

    By looking at all "simulation"

    Delivery movements can be applied the following transformations:

    - split : one movement is cut into 2 or more movements

    - submovements : one movement "generates" many other movements.
      For example, a delivery of goods from the workshop to the stock,
      will result in a "pull" calculation which generates operations
      and sourcing based on a BOM document. The causality of each
      delivery is the "applied rule" which was used to generate submovements

    One should note that

121
    - movements are never joined (because it would break causality and
Jean-Paul Smets's avatar
Jean-Paul Smets committed
122 123 124 125 126 127 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
      tracability)

    - movements acquire some context information from their causality

    Some submovements need no order to be "confirmed". Some submovements
    need an order to be "confirmed". For example

    - a submovement which allows to compute the CO2 emissions
      of a production facility needs no order confirmation
      (this kind of movement is mostly ised for reporting)

    - a submovement which takes some goods in a stock and
      brings them to a workshop needs some "stock movement"
      order to be "confirmed"

    - a submovement which requires someone to take his time
      for some operation nees a "service order" to be confirmed

    This means that the simulation process must make a distinction
    between different workflows applicable to a movement. For
    movements which require an order to be confirmed, the workflow
    involves the following steps:

    - an order is automaticaly generated, with "order movements"
      which become "causalities" for delivery movements (XXX
      this sound strange...)

    - each order movement is associated to one of the delivery

    As a result, a delivery movement which requires an order may
    have 2 causalities

    - one causality (ie. application of a rule)

    - another causality (ie. confirmation in an order)

    Each causality may define its own context. One context
    may be related for example to a customer request, another context
    may be related to an "internal customer" request (eg. the production manager).
    Context may eventually conflict each other.

    In a customer oriented company, movements should probably
    always be stored within the customer order and acquire
    from the order all context information.

    In a mass production facility, context may be defined in more
    than one location. This is an incentive for putting
    all movements in a simulation "box".

    The second approach is chosen for documentary consistency approach :
      in ERP5, documents rules, can be synchronized. Simulation can not be
      synchronized
  """
  meta_type = 'ERP5 Movement'
  portal_type = 'Movement'
177
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178 179 180 181 182 183
  isPortalContent = 1
  isRADContent = 1
  isMovement = 1

  # Declarative security
  security = ClassSecurityInfo()
184
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
185 186

  # Declarative interfaces
187 188
  zope.interface.implements( interfaces.IVariated,
                             interfaces.IMovement )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
189 190 191 192

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
193
                    , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
194 195 196 197 198 199 200 201 202 203 204
                    , PropertySheet.Amount
                    , PropertySheet.Task
                    , PropertySheet.Arrow
                    , PropertySheet.Movement
                    , PropertySheet.Price
                    )

  # Pricing methods
  # _getPrice is defined in the order / delivery
  # Pricing mehod
  def _getPrice(self, context):
205 206
    context = self.asContext(context=context,
                             quantity=self.getConvertedQuantity())
207 208
    operand_dict = self.getPriceCalculationOperandDict(context=context)
    if operand_dict is not None:
209 210 211 212 213 214 215 216
      price = operand_dict['price']
      resource = self.getResourceValue()
      quantity_unit = self.getQuantityUnit()
      if price is not None and quantity_unit and resource is not None:
        return resource.convertQuantity(price, quantity_unit,
                                        resource.getDefaultQuantityUnit(),
                                        self.getVariationCategoryList())
      return price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
217

218
  def _getTotalPrice(self, default=None, context=None, fast=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
219 220
    price = self.getPrice(context=context)
    quantity = self.getQuantity()
221 222
    if isinstance(price, (int, float)) and \
      isinstance(quantity, (int, float)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
223 224
      return quantity * price
    else:
225
      return default
Jean-Paul Smets's avatar
Jean-Paul Smets committed
226

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
  security.declareProtected(Permissions.AccessContentsInformation, 
          'getPriceCalculationOperandDict')
  def getPriceCalculationOperandDict(self, default=None, context=None, **kw):
    """Return a dict object which contains operands used for price
    calculation. The returned items depend on a site configuration,
    because this will invoke a custom script at the end. The only
    assumption is that the dict must contain a key 'price'
    which represents the final result of the price calculation.
    
    The purpose is to obtain descriptive information to notify the user
    of how a price is calculated in details, in particular, for invoices
    and quotations. So a script which is eventually called should provide
    all values required for generating such reports (e.g. a price,
    a price without a discount, and a discount).
    """
    # First, try a type-based method, and if not present, use 
    # the good-old-days way (which only returns a final result).
    if context is None:
      context = self
    method = context._getTypeBasedMethod('getPriceCalculationOperandDict')
247 248 249 250 251
    if method is None:
      # Try this, because when the context is an instance of a derived
      # class of Movement, Movement_getPriceCalculationOperandDict is
      # not searched.
      method = getattr(context, 'Movement_getPriceCalculationOperandDict', None)
252 253 254 255 256 257 258 259
    if method is not None:
      operand_dict = method(**kw)
      if operand_dict is None:
        return default
      assert 'price' in operand_dict 
      return operand_dict
    return {'price': context.Movement_lookupPrice()}

Jean-Paul Smets's avatar
Jean-Paul Smets committed
260
  security.declareProtected(Permissions.AccessContentsInformation, 'getPrice')
261
  def getPrice(self, default=None, context=None, evaluate=1, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
262
    """
263 264 265
      Get the Price in the context.

      If price is not stored locally, lookup a price and store it.
266 267 268

      FIXME: Don't trust this docstring, this method is not at all using the
      passed context, but uses this movement as context.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
269
    """
270 271 272 273 274 275 276
    # XXX As all accessors can recieve the default value as first positional
    # argument, so we changed the first positional argument from context to
    # default. Here we try to provide backward compatibility for scripts
    # passing the context as first positional argument, and advice them to use:
    #   context.getPrice(context=context)
    # instead of:
    #   context.getPrice(context)
Jérome Perrin's avatar
Jérome Perrin committed
277
    if isinstance(default, Base):
278 279 280 281 282 283 284 285
      msg = 'getPrice first argument is supposed to be the default value'\
            ' accessor, the context should be passed as with the context='\
            ' keyword argument'
      warn(msg, DeprecationWarning)
      LOG('ERP5', WARNING, msg)
      context = default
      default = None

286 287 288 289
    if len(kw):
      warn('Passing keyword arguments to Movement.getPrice has no effect',
           DeprecationWarning)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
290 291
    local_price = self._baseGetPrice()
    if local_price is None:
292
      # We must find a price for this movement
293
      local_price = self._getPrice(context=self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
294 295
    return local_price

296 297
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTotalPrice')
298
  def getTotalPrice(self, default=0.0, context=None, REQUEST=None, fast=None,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
299 300 301 302
                    **kw):
    """Return the total price in the context.

    The optional parameter "fast" is for compatibility, and will be ignored.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
303
    """
304 305 306 307 308 309 310 311 312
    # see getPrice
    if isinstance(default, Base) and context is None:
      msg = 'getTotalPrice first argument is supposed to be the default value'\
            ' accessor, the context should be passed as with the context='\
            ' keyword argument'
      warn(msg, DeprecationWarning)
      LOG('ERP5', WARNING, msg)
      context = default
      default = None
Yoshinori Okuji's avatar
Yoshinori Okuji committed
313 314
    
    tmp_context = self.asContext(context=context, REQUEST=REQUEST, **kw)
315
    result = self._getTotalPrice(default=default, context=tmp_context, fast=fast, **kw)
316
    method = self._getTypeBasedMethod('convertTotalPrice')
317 318 319
    if method is None:
      return result
    return method(result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
320

321 322
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTotalQuantity')
323
  def getTotalQuantity(self, default=0.0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
324 325 326
    """
      Returns the quantity if no cell or the total quantity if cells
    """
327
    return self.getQuantity(default=default)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
328

329
  # Industrial price API
330 331
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getIndustrialPrice')
332 333 334 335 336 337 338 339 340
  def getIndustrialPrice(self):
    """
      Calculates industrial price in context of this movement
    """
    resource = self.getResourceValue()
    if resource is not None:
      return resource.getIndustrialPrice(context=self)
    return None

341
  # Asset price calculation
342 343
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceInventoriatedTotalAssetPrice')
344
  def getSourceInventoriatedTotalAssetPrice(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
345
    """
346 347
      Returns a price which can be used to calculate stock value (asset)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
348 349
      Asset price is used for calculation of inventory asset value
      and for accounting
350 351 352 353 354 355 356 357 358

      If the asset price is specified (as in accounting for multi-currency),
      then it is returned. If no asset price is specified, then we use
      the price as defined on the line, but only for incoming quantities
      (purchase price, industrial price, etc.).

      For outgoing quantities, it is the responsability of database
      to calculate asset prices based on calculation rules (FIFO,
      FILO, AVERAGE, etc.).
Jean-Paul Smets's avatar
Jean-Paul Smets committed
359
    """
360 361 362 363
    # This is what we use for accounting
    result = self.getSourceTotalAssetPrice()
    if result is not None:
      return result
364
    quantity = self.getQuantity()
365 366 367
    if quantity :
      source_asset_price = self.getSourceAssetPrice()
      if source_asset_price :
368
        return source_asset_price * - quantity
369
    return None
370 371 372 373 374 375 376 377 378
  
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceInventoriatedTotalAssetDebit')
  def getSourceInventoriatedTotalAssetDebit(self) :
    """
      Returns the debit part of inventoriated source total asset price.
    """
    result = self.getSourceInventoriatedTotalAssetPrice()
    if result is not None :
379 380 381
      if result > 0 and not self.isCancellationAmount():
        return result
      if result < 0 and self.isCancellationAmount():
382
        return result
383
    return 0.0
384 385 386 387 388 389 390 391 392

  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceInventoriatedTotalAssetCredit')
  def getSourceInventoriatedTotalAssetCredit(self) :
    """
      Returns the credit part of inventoriated source total asset price.
    """
    result = self.getSourceInventoriatedTotalAssetPrice()
    if result is not None :
393 394 395
      if result < 0 and not self.isCancellationAmount():
        return -result
      if result > 0 and self.isCancellationAmount():
396
        return -result
397
    return 0.0
398

399 400
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationInventoriatedTotalAssetPrice')
401
  def getDestinationInventoriatedTotalAssetPrice(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
402
    """
403 404
      Returns a price which can be used to calculate stock value (asset)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
405 406 407
      Asset price is used for calculation of inventory asset value
      and for accounting
    """
408 409 410 411
    # This is what we use for accounting
    result = self.getDestinationTotalAssetPrice()
    if result is not None:
      return result
412
    quantity = self.getQuantity()
413 414 415 416
    if quantity :
      destination_asset_price = self.getDestinationAssetPrice()
      if destination_asset_price :
        return destination_asset_price * quantity
417
    return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
418

419 420 421 422 423 424 425 426
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationInventoriatedTotalAssetDebit')
  def getDestinationInventoriatedTotalAssetDebit(self) :
    """
      Returns the debit part of inventoriated destination total asset price.
    """
    result = self.getDestinationInventoriatedTotalAssetPrice()
    if result is not None :
427 428 429
      if result > 0 and not self.isCancellationAmount():
        return result
      if result < 0 and self.isCancellationAmount():
430
        return result
431
    return 0.0
432 433 434 435 436 437 438 439 440

  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationInventoriatedTotalAssetCredit')
  def getDestinationInventoriatedTotalAssetCredit(self) :
    """
      Returns the credit part of inventoriated destination total asset price.
    """
    result = self.getDestinationInventoriatedTotalAssetPrice()
    if result is not None :
441 442 443
      if result < 0 and not self.isCancellationAmount():
        return -result
      if result > 0 and self.isCancellationAmount():
444
        return -result
445
    return 0.0
446

447 448
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetPrice')
449 450 451 452
  def getSourceAssetPrice(self):
    """
      Returns the price converted to the currency of the source section

453
      This will be implemeted by calling currency conversion on currency resources
454
    """
455
    return self.getPrice() # XXX Not implemented yet TODO
456

457 458
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationAssetPrice')
459 460 461 462
  def getDestinationAssetPrice(self):
    """
      Returns the price converted to the currency of the destination section
    """
463
    return self.getPrice() # XXX Not implemented yet TODO
464

Jean-Paul Smets's avatar
Jean-Paul Smets committed
465
  # Causality computation
466 467
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isConvergent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
468 469 470 471
  def isConvergent(self):
    """
      Returns 0 if the target is not met
    """
472
    return int(not self.isDivergent())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
473

474 475
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isDivergent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
476 477
  def isDivergent(self):
    """
478
      XXX documentation out of sync with actual use
Jean-Paul Smets's avatar
Jean-Paul Smets committed
479 480 481 482 483 484
      Returns 1 if the target is not met according to the current information
      After and edit, the isOutOfTarget will be checked. If it is 1,
      a message is emitted

      emit targetUnreachable !
    """
Sebastien Robin's avatar
Sebastien Robin committed
485 486 487
    for simulation_movement in self.getDeliveryRelatedValueList():
      if simulation_movement.isDivergent():
        return 1
488
    return 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
489

490 491 492 493 494 495 496 497 498 499
  def getDivergenceList(self):
    """
    Return a list of messages that contains the divergences 
    """
    divergence_list = [] 
    for simulation_movement in self.getDeliveryRelatedValueList():
      divergence_list.extend(simulation_movement.getDivergenceList())

    return divergence_list

500 501 502 503
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isFrozen')
  def isFrozen(self):
    """
504
    Returns the frozen status of this movement.
505
    a movement in stopped, delivered or cancelled states is automatically frozen.
506 507
    If frozen is locally set to '0', we must check for a parent set to '1', in
    which case, we want the children to be frozen as well.
508 509

    BPM evaluation allows to set frozen state list per Business Path.
510
    """
511 512 513 514 515 516 517 518 519 520
    business_path = self.getCausalityValue(portal_type='Business Path')
    if business_path is None:
      # XXX Hardcoded
      # Maybe, we should use getPortalCurrentInventoryStateList
      # and another portal method for cancelled (and deleted)
      #     LOG("Movement, isFrozen", DEBUG, "Hardcoded state list")
      if self.getSimulationState() in ('stopped', 'delivered', 'cancelled'):
        return 1
    else:
      # conditional BPM enabled frozen state check
521 522
      LOG("Movement.isFrozen", WARNING, "%s is using BPM experimental "
          "evaluation" % self.getPath())
523 524 525 526 527
      # BPM dynamic configuration
      if self.getSimulationState() in business_path.getFrozenStateList():
        return True

    # manually frozen
528 529
    if self._baseIsFrozen() == 0:
      self._baseSetFrozen(None)
530
    return self._baseGetFrozen() or False
531

532 533
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanation')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
534
  def getExplanation(self):
535
    """
536
      Returns the relative_url of the explanation of this movement.
537
    """
538 539 540
    explanation = self.getExplanationValue()
    if explanation is not None:
      return explanation.getRelativeUrl()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
541

542 543
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationUid')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
544
  def getExplanationUid(self):
545
    """
546
      Returns the uid of the explanation of this movement.
547
    """
548 549 550
    explanation = self.getExplanationValue()
    if explanation is not None:
      return explanation.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
551

552 553
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationValue')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
554
  def getExplanationValue(self):
555
    """
556
      Returns the object explanation of this movement.
557
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
558
    return self.getDeliveryValue()
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
 
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationTitle')
  def getExplanationTitle(self, default=''):
    """
      Returns the title of the explanation of this movement.
    """
    explanation_value = self.getExplanationValue()
    if explanation_value is not None:
      return explanation_value.getTitle()
    return default

  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationReference')
  def getExplanationReference(self, default=''):
    """
      Returns the reference of the explanation of this movement.
    """
    explanation_value = self.getExplanationValue()
    if explanation_value is not None:
      return explanation_value.getReference()
    return default

582
  security.declareProtected( Permissions.AccessContentsInformation,
583
                             'getRootCausalityValueList')
584 585 586 587 588 589 590 591
  def getRootCausalityValueList(self):
    """
      Returns the initial causality value for this movement.
      This method will look at the causality and check if the
      causality has already a causality
    """
    return self.getExplanationValue().getRootCausalityValueList()
    
592 593

  # Simulation
594 595
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isSimulated')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
596
  def isSimulated(self):
597 598
    return (len(self.getDeliveryRelatedValueList()) > 0) or\
           (len(self.getOrderRelatedValueList()) > 0)
599

600
  # New Causality API
601 602
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderQuantity')
603 604 605 606 607
  def getOrderQuantity(self):
    """
      Returns the quantity of related order(s)
    """
    return self.getQuantity()
608

609 610
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryQuantity')
611 612 613 614
  def getDeliveryQuantity(self):
    """
      Returns the quantity of related delivery(s)
    """
615 616
    return self.getQuantity()

617 618
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationQuantity')
619 620 621 622
  def getSimulationQuantity(self):
    """
      Returns the sum of quantities in related simulation movements
    """
623 624
    return self.getQuantity()

625 626
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStartDateList')
627 628
  def getOrderStartDateList(self):
    """
629
      Returns the list of start date of related order(s)
630 631
    """
    return [self.getStartDate()]
632

633 634
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStartDateList')
635 636
  def getDeliveryStartDateList(self):
    """
637
      Returns the list of start date of related delivery(s)
638 639
    """
    return [self.getStartDate()]
640

641 642
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationStartDateList')
643 644
  def getSimulationStartDateList(self):
    """
645
      Returns the list of start date related simulation movements
646 647
    """
    return [self.getStartDate()]
648

649 650
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStopDateList')
651 652
  def getOrderStopDateList(self):
    """
653
      Returns the list of stop date of related order(s)
654 655
    """
    return [self.getStopDate()]
656

657 658
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStopDateList')
659 660
  def getDeliveryStopDateList(self):
    """
661
      Returns the list of stop date of related delivery(s)
662 663
    """
    return [self.getStopDate()]
664

665 666
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationStopDateList')
667 668
  def getSimulationStopDateList(self):
    """
669
      Returns the list of stop date related simulation movements
670 671
    """
    return [self.getStopDate()]
672

673 674
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceList')
675 676 677 678
  def getOrderSourceList(self):
    """
      Returns the source of related orders
    """
679 680
    return self.getSourceList()

681 682
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceList')
683 684 685 686
  def getDeliverySourceList(self):
    """
      Returns the source of related deliveries
    """
687 688
    return self.getSourceList()

689 690
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceList')
691 692 693 694
  def getSimulationSourceList(self):
    """
      Returns the source of related simulation movements
    """
695 696
    return self.getSourceList()

697 698
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationList')
699 700 701 702
  def getOrderDestinationList(self):
    """
      Returns the destination of related orders
    """
703 704
    return self.getDestinationList()

705 706
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationList')
707 708 709 710
  def getDeliveryDestinationList(self):
    """
      Returns the destination of related deliveries
    """
711 712
    return self.getDestinationList()

713 714
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationList')
715 716 717 718
  def getSimulationDestinationList(self):
    """
      Returns the destination of related simulation movements
    """
719 720
    return self.getDestinationList()

721 722
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceSectionList')
723 724 725 726
  def getOrderSourceSectionList(self):
    """
      Returns the source_section of related orders
    """
727 728
    return self.getSourceSectionList()

729 730
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceSectionList')
731 732 733 734
  def getDeliverySourceSectionList(self):
    """
      Returns the source_section of related deliveries
    """
735 736
    return self.getSourceSectionList()

737 738
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceSectionList')
739 740 741 742
  def getSimulationSourceSectionList(self):
    """
      Returns the source_section of related simulation movements
    """
743 744
    return self.getSourceSectionList()

745 746
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationSectionList')
747 748 749 750
  def getOrderDestinationSectionList(self):
    """
      Returns the destination_section of related orders
    """
751 752
    return self.getDestinationSectionList()

753 754
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationSectionList')
755 756 757 758
  def getDeliveryDestinationSectionList(self):
    """
      Returns the destination_section of related deliveries
    """
759 760
    return self.getDestinationSectionList()

761 762
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationSectionList')
763 764 765 766
  def getSimulationDestinationSectionList(self):
    """
      Returns the destination_section of related simulation movements
    """
767 768
    return self.getDestinationSectionList()

769
  # Debit and credit methods
770 771
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceDebit')
772 773 774 775 776 777 778
  def getSourceDebit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
779
    except TypeError:
780
      quantity = 0.0
781 782 783
    if (quantity < 0 and not self.isCancellationAmount()):
      return - quantity
    elif quantity > 0 and self.isCancellationAmount():
784
      return - quantity
785
    return 0.0
786

787 788
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceCredit')
789 790 791 792 793 794 795
  def getSourceCredit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
796
    except TypeError:
797
      quantity = 0.0
798 799
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
800
      return 0.0
801
    return quantity
802

803 804
  security.declareProtected( Permissions.AccessContentsInformation,
                    'getDestinationDebit', 'getDestinationCredit')
805 806 807 808 809 810 811 812 813
  getDestinationDebit = getSourceCredit
  getDestinationCredit = getSourceDebit

  security.declareProtected(Permissions.ModifyPortalContent, 'setSourceDebit')
  def setSourceDebit(self, source_debit):
    """
      Set the quantity
    """
    if source_debit in (None, ''):
814
      return
815 816
    try:
      source_debit = float(source_debit)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
817
    except TypeError:
818
      source_debit = 0.0
819
    self.setCancellationAmount(source_debit < 0)
820 821 822 823 824 825 826 827
    self.setQuantity(- source_debit)

  security.declareProtected(Permissions.ModifyPortalContent, 'setSourceCredit')
  def setSourceCredit(self, source_credit):
    """
      Set the quantity
    """
    if source_credit in (None, ''):
828
      return
829 830
    try:
      source_credit = float(source_credit)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
831
    except TypeError:
832
      source_credit = 0.0
833
    self.setCancellationAmount(source_credit < 0)
834 835
    self.setQuantity(source_credit)

836 837 838 839
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationDebit', 'setDestinationCredit' )
  setDestinationDebit = setSourceCredit
  setDestinationCredit = setSourceDebit
840

841
  security.declarePrivate('_edit')
842
  def _edit(self, edit_order=(), **kw):
843
    """Overloaded _edit to support setting debit and credit at the same time,
844 845
    which is required for the GUI.
    Also sets the variation category list at the end, because 
846
    _setVariationCategoryList needs the resource to be set.
847 848 849
    """
    quantity = 0
    if kw.has_key('source_debit') and kw.has_key('source_credit'):
850 851 852
      source_credit = kw.pop('source_credit') or 0
      source_debit = kw.pop('source_debit') or 0
      quantity += (source_credit - source_debit)
853
      kw['quantity'] = quantity
854
      kw['cancellation_amount'] = (source_credit < 0 or source_debit < 0)
855
    if kw.has_key('destination_debit') and kw.has_key('destination_credit'):
856 857 858
      destination_credit = kw.pop('destination_credit') or 0
      destination_debit = kw.pop('destination_debit') or 0
      quantity += (destination_debit - destination_credit)
859
      kw['quantity'] = quantity
860
      kw['cancellation_amount'] = (destination_credit < 0 or destination_debit < 0)
861
    if not edit_order:
862
      edit_order = ('variation_category_list', )
863
    return XMLObject._edit(self, edit_order=edit_order, **kw)
864

865
  # Debit and credit methods for asset
866 867
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetDebit' )
868 869 870 871 872
  def getSourceAssetDebit(self):
    """
      Return the debit part of the source total asset price.

      This is the same as getSourceDebit where quantity is replaced
873 874
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
875 876 877 878 879 880
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
881 882
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
883
      return 0.0
884
    return quantity
885

886 887
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetCredit' )
888 889
  def getSourceAssetCredit(self):
    """
890 891 892
      Return the credit part of the source total asset price.

      This is the same as getSourceCredit where quantity is replaced
893 894
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
895 896 897 898 899 900
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
901
    if (quantity < 0 and not self.isCancellationAmount()):
902
      return - quantity
903 904 905
    elif quantity > 0 and self.isCancellationAmount():
      return - quantity
    return 0.0
906 907 908 909 910 911
  
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationAssetDebit' )
  def getDestinationAssetDebit(self):
    """
      Return the debit part of the destination total asset price.
912

913
      This is the same as getDestinationDebit where quantity is replaced
914 915
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
916 917 918 919 920 921
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
922 923
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
924
      return 0.0
925
    return quantity
926

927 928 929 930 931 932 933
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationAssetCredit' )
  def getDestinationAssetCredit(self):
    """
      Return the credit part of the destination total asset price.

      This is the same as getDestinationCredit where quantity is replaced
934 935
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
936 937 938 939 940 941
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
942 943 944 945 946
    if (quantity < 0 and not self.isCancellationAmount()):
      return - quantity
    elif quantity > 0 and self.isCancellationAmount():
      return - quantity
    return 0.0
947 948 949
  
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetDebit' )
950 951
  def setSourceAssetDebit(self, source_debit):
    """
952
      Set the source total asset price
953 954
    """
    if source_debit in (None, ''):
955
      self.setSourceTotalAssetPrice(None)
956
      return
957 958 959 960
    try:
      source_debit = float(source_debit)
    except TypeError:
      source_debit = 0.0
961
    self.setCancellationAmount(source_debit < 0)
962
    self.setSourceTotalAssetPrice(source_debit)
963

964 965 966 967
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetCredit' )
  def setSourceAssetCredit(self, source_credit):
    """
968
      Set the source total asset price
969 970
    """
    if source_credit in (None, ''):
971
      self.setSourceTotalAssetPrice(None)
972
      return
973 974 975 976
    try:
      source_credit = float(source_credit)
    except TypeError:
      source_credit = 0.0
977
    self.setCancellationAmount(source_credit < 0)
978
    self.setSourceTotalAssetPrice( - source_credit)
979 980 981 982 983

  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationAssetDebit' )
  def setDestinationAssetDebit(self, destination_debit):
    """
984
      Set the destination total asset price
985 986
    """
    if destination_debit in (None, ''):
987
      self.setDestinationTotalAssetPrice(None)
988
      return
989 990 991 992
    try:
      destination_debit = float(destination_debit)
    except TypeError:
      destination_debit = 0.0
993
    self.setCancellationAmount(destination_debit < 0)
994 995 996 997 998 999
    self.setDestinationTotalAssetPrice(destination_debit)

  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationAssetCredit' )
  def setDestinationAssetCredit(self, destination_credit):
    """
1000
      Set the destination total asset price
1001 1002
    """
    if destination_credit in (None, ''):
1003
      self.setDestinationTotalAssetPrice(None)
1004
      return
1005 1006 1007 1008
    try:
      destination_credit = float(destination_credit)
    except TypeError:
      destination_credit = 0.0
1009
    self.setCancellationAmount(destination_credit < 0)
1010
    self.setDestinationTotalAssetPrice( - destination_credit)
1011

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1012
  # Item Access (tracking)
1013 1014
  security.declareProtected(Permissions.AccessContentsInformation,
      'getTrackedItemUidList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1015
  def getTrackedItemUidList(self):
1016
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1017
      Return a list of uid for related items
1018
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1019 1020 1021
    ### XXX We should filter by portal type here
    return self.getAggregateUidList()

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
  # Helper methods to display total quantities as produced / consumed
  security.declareProtected(Permissions.AccessContentsInformation,
      'getProductionTotalQuantity')
  def getProductionTotalQuantity(self):
    """
      Return the produced quantity
    """
    quantity = self.getTotalQuantity()
    return self.getProductionQuantity(quantity=quantity)

  security.declareProtected(Permissions.AccessContentsInformation,
      'getConsumptionTotalQuantity')
  def getConsumptionTotalQuantity(self):
    """
      Return the produced quantity
    """
    quantity = self.getTotalQuantity()
    return self.getConsumptionQuantity(quantity=quantity)

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
  security.declareProtected(Permissions.AccessContentsInformation,
      'getSubVariationText')
  def getSubVariationText(self,**kw):
    """
    Provide a string representation of XXX
    """
    base_category_list = self.getPortalSubVariationBaseCategoryList()
    portal_type_list = self.getPortalSubVariationTypeList()
    return_list = []
    for base_category in base_category_list:
      variation_list = self.getAcquiredCategoryMembershipList(base_category,
          portal_type=portal_type_list,base=1)
      return_list.extend(variation_list)
    return "\n".join(return_list)

1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getParentExplanationValue')
  def getParentExplanationValue(self):
    """
      This method should be removed as soon as movement groups
      will be rewritten. It is a temp hack
    """
    return self.getParentValue().getExplanationValue()


Jean-Paul Smets's avatar
Jean-Paul Smets committed
1066 1067 1068 1069 1070
  # SKU vs. CU
#   security.declareProtected(Permissions.AccessContentsInformation, 'getSourceStandardInventoriatedQuantity')
#   def getSourceStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1071
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1072 1073
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1074
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1075 1076
#       For accounting, returns the quantity converted in a default unit
#     """
1077 1078
#     return self.getStandardInventoriatedQuantity()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1079 1080 1081 1082
#   security.declareProtected(Permissions.AccessContentsInformation, 'getDestinationStandardInventoriatedQuantity')
#   def getDestinationStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1083
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1084 1085
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1086
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1087 1088
#       For accounting, returns the quantity converted in a default unit
#     """
1089
#     return self.getStandardInventoriatedQuantity()
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106

  security.declareProtected( Permissions.AccessContentsInformation,
                             'asMovementList')
  def asMovementList(self):
    """
    Placeholder method called when indexing a movement.

    It can be overloaded to generate multiple movements 
    from a single one.
    It is used for cataloging a movement multiple time in 
    the movement/stock tables.

    Ex: a movement have multiple destinations.
    asMovementList returns a list a movement context with different 
    single destination.
    """
    return (self, )
1107