Movement.py 39.7 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, 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

from Products.ERP5Type.XMLObject import XMLObject
39
from Products.ERP5.mixin.composition import CompositionMixin
40
from Products.ERP5.Document.Amount import Amount
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41

42
from zLOG import LOG, WARNING
43

44
class Movement(XMLObject, Amount, CompositionMixin):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
  """
    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

  # Declarative security
  security = ClassSecurityInfo()
181
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
182 183

  # Declarative interfaces
184 185
  zope.interface.implements( interfaces.IVariated,
                             interfaces.IMovement )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
186 187 188 189

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
190
                    , PropertySheet.CategoryCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
191 192 193 194 195 196 197
                    , PropertySheet.Amount
                    , PropertySheet.Task
                    , PropertySheet.Arrow
                    , PropertySheet.Movement
                    , PropertySheet.Price
                    )

198 199 200 201
  security.declareProtected(Permissions.AccessContentsInformation, 'isMovement')
  def isMovement(self):
    return 1

Jean-Paul Smets's avatar
Jean-Paul Smets committed
202 203 204 205
  # Pricing methods
  # _getPrice is defined in the order / delivery
  # Pricing mehod
  def _getPrice(self, context):
206 207
    context = self.asContext(context=context,
                             quantity=self.getConvertedQuantity())
208 209
    operand_dict = self.getPriceCalculationOperandDict(context=context)
    if operand_dict is not None:
210 211 212 213 214 215 216 217
      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
218

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

228 229 230
  def _getBaseUnitPrice(self, context):
    # Override Amount._getBaseUnitPrice to use Movement's
    # getPriceCalculationOperandDict instead of Resource's.
231
    operand_dict = context.getPriceCalculationOperandDict(context=context)
232 233 234 235
    if operand_dict is not None:
      base_unit_price = operand_dict.get('base_unit_price', None)
      return base_unit_price

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
  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')
256 257 258 259 260
    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)
261 262 263 264 265 266 267 268
    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
269
  security.declareProtected(Permissions.AccessContentsInformation, 'getPrice')
270
  def getPrice(self, default=None, context=None, evaluate=1, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
271
    """
272 273 274
      Get the Price in the context.

      If price is not stored locally, lookup a price and store it.
275 276 277

      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
278
    """
279 280 281 282 283 284 285
    # 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
286
    if isinstance(default, Base):
287 288 289 290 291 292 293 294
      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

295 296 297 298
    if len(kw):
      warn('Passing keyword arguments to Movement.getPrice has no effect',
           DeprecationWarning)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
299 300
    local_price = self._baseGetPrice()
    if local_price is None:
301
      # We must find a price for this movement
302
      local_price = self._getPrice(context=self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
303 304
    return local_price

305 306
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTotalPrice')
307
  def getTotalPrice(self, default=0.0, context=None, REQUEST=None, fast=None,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
308 309 310 311
                    **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
312
    """
313 314 315 316 317 318 319 320 321
    # 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
322 323
    
    tmp_context = self.asContext(context=context, REQUEST=REQUEST, **kw)
324
    result = self._getTotalPrice(default=default, context=tmp_context, fast=fast, **kw)
325
    method = self._getTypeBasedMethod('convertTotalPrice')
326 327 328
    if method is None:
      return result
    return method(result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
329

330 331
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTotalQuantity')
332
  def getTotalQuantity(self, default=0.0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
333 334 335
    """
      Returns the quantity if no cell or the total quantity if cells
    """
336
    return self.getQuantity(default=default)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
337

338
  # Industrial price API
339 340
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getIndustrialPrice')
341 342 343 344 345 346 347 348 349
  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

350
  # Asset price calculation
351 352
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceInventoriatedTotalAssetPrice')
353
  def getSourceInventoriatedTotalAssetPrice(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
354
    """
355 356
      Returns a price which can be used to calculate stock value (asset)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
357 358
      Asset price is used for calculation of inventory asset value
      and for accounting
359 360 361 362 363 364 365 366

      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,
367
      LIFO, AVERAGE, etc.).
Jean-Paul Smets's avatar
Jean-Paul Smets committed
368
    """
369 370 371 372
    # This is what we use for accounting
    result = self.getSourceTotalAssetPrice()
    if result is not None:
      return result
373
    quantity = self.getQuantity()
374 375 376
    if quantity :
      source_asset_price = self.getSourceAssetPrice()
      if source_asset_price :
377
        return source_asset_price * - quantity
378
    return None
379 380 381 382 383 384 385 386 387
  
  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 :
Nicolas Dumazet's avatar
Nicolas Dumazet committed
388
      if (result > 0) ^ bool(self.isCancellationAmount()):
389
        return result
390
    return 0.0
391 392 393 394 395 396 397 398 399

  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 :
Nicolas Dumazet's avatar
Nicolas Dumazet committed
400
      if (result < 0) ^ bool(self.isCancellationAmount()):
401
        return -result
402
    return 0.0
403

404 405
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationInventoriatedTotalAssetPrice')
406
  def getDestinationInventoriatedTotalAssetPrice(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
407
    """
408 409
      Returns a price which can be used to calculate stock value (asset)

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

424 425 426 427 428 429 430 431
  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 :
432
      if (result > 0) ^ bool(self.isCancellationAmount()):
433
        return result
434
    return 0.0
435 436 437 438 439 440 441 442 443

  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 :
444
      if (result < 0) ^ bool(self.isCancellationAmount()):
445
        return -result
446
    return 0.0
447

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

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

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

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

475 476
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isDivergent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
477 478
  def isDivergent(self):
    """
479
      XXX documentation out of sync with actual use
Jean-Paul Smets's avatar
Jean-Paul Smets committed
480 481 482 483 484 485
      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
486 487 488
    for simulation_movement in self.getDeliveryRelatedValueList():
      if simulation_movement.isDivergent():
        return 1
489
    return 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
490

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

    return divergence_list

501 502 503 504
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isFrozen')
  def isFrozen(self):
    """
505
    Returns the frozen status of this movement.
506
    a movement in stopped, delivered or cancelled states is automatically frozen.
507 508
    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.
509 510

    BPM evaluation allows to set frozen state list per Business Path.
511
    """
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
    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
      # BPM dynamic configuration
      if self.getSimulationState() in business_path.getFrozenStateList():
        return True

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

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

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

551 552
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationValue')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
553
  def getExplanationValue(self):
554
    """
555
      Returns the object explanation of this movement.
556
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
557
    return self.getDeliveryValue()
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
 
  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

581
  security.declareProtected( Permissions.AccessContentsInformation,
582
                             'getRootCausalityValueList')
583 584 585 586 587 588 589 590
  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()
    
591 592

  # Simulation
593 594
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isSimulated')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
595
  def isSimulated(self):
596
    # 'order' category is deprecated. it is kept for compatibility.
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
  def getOrderQuantity(self):
    """
      Returns the quantity of related order(s)
    """
607
    # XXX deprecated
608
    return self.getQuantity()
609

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

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

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

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

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

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

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

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

676 677
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceList')
678 679 680 681
  def getOrderSourceList(self):
    """
      Returns the source of related orders
    """
682
    # XXX deprecated
683 684
    return self.getSourceList()

685 686
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceList')
687 688 689 690
  def getDeliverySourceList(self):
    """
      Returns the source of related deliveries
    """
691 692
    return self.getSourceList()

693 694
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceList')
695 696 697 698
  def getSimulationSourceList(self):
    """
      Returns the source of related simulation movements
    """
699 700
    return self.getSourceList()

701 702
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationList')
703 704 705 706
  def getOrderDestinationList(self):
    """
      Returns the destination of related orders
    """
707
    # XXX deprecated
708 709
    return self.getDestinationList()

710 711
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationList')
712 713 714 715
  def getDeliveryDestinationList(self):
    """
      Returns the destination of related deliveries
    """
716 717
    return self.getDestinationList()

718 719
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationList')
720 721 722 723
  def getSimulationDestinationList(self):
    """
      Returns the destination of related simulation movements
    """
724 725
    return self.getDestinationList()

726 727
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceSectionList')
728 729 730 731
  def getOrderSourceSectionList(self):
    """
      Returns the source_section of related orders
    """
732
    # XXX deprecated
733 734
    return self.getSourceSectionList()

735 736
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceSectionList')
737 738 739 740
  def getDeliverySourceSectionList(self):
    """
      Returns the source_section of related deliveries
    """
741 742
    return self.getSourceSectionList()

743 744
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceSectionList')
745 746 747 748
  def getSimulationSourceSectionList(self):
    """
      Returns the source_section of related simulation movements
    """
749 750
    return self.getSourceSectionList()

751 752
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationSectionList')
753 754 755 756
  def getOrderDestinationSectionList(self):
    """
      Returns the destination_section of related orders
    """
757
    # XXX deprecated
758 759
    return self.getDestinationSectionList()

760 761
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationSectionList')
762 763 764 765
  def getDeliveryDestinationSectionList(self):
    """
      Returns the destination_section of related deliveries
    """
766 767
    return self.getDestinationSectionList()

768 769
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationSectionList')
770 771 772 773
  def getSimulationDestinationSectionList(self):
    """
      Returns the destination_section of related simulation movements
    """
774 775
    return self.getDestinationSectionList()

776
  # Debit and credit methods
777 778
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceDebit')
779 780 781 782 783 784 785
  def getSourceDebit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
786
    except TypeError:
787
      quantity = 0.0
Nicolas Dumazet's avatar
Nicolas Dumazet committed
788
    if (quantity < 0) ^ bool(self.isCancellationAmount()):
789
      return - quantity
790
    return 0.0
791

792 793
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceCredit')
794 795 796 797 798 799 800
  def getSourceCredit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
801
    except TypeError:
802
      quantity = 0.0
Nicolas Dumazet's avatar
Nicolas Dumazet committed
803
    if (quantity < 0) ^ bool(self.isCancellationAmount()):
804
      return 0.0
805
    return quantity
806

807 808
  security.declareProtected( Permissions.AccessContentsInformation,
                    'getDestinationDebit', 'getDestinationCredit')
809 810 811 812 813 814 815 816 817
  getDestinationDebit = getSourceCredit
  getDestinationCredit = getSourceDebit

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

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

840 841 842 843
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationDebit', 'setDestinationCredit' )
  setDestinationDebit = setSourceCredit
  setDestinationCredit = setSourceDebit
844

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

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

      This is the same as getSourceDebit where quantity is replaced
877 878
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
879 880 881 882 883 884
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
Nicolas Dumazet's avatar
Nicolas Dumazet committed
885
    if (quantity < 0) ^ bool(self.isCancellationAmount()):
886
      return 0.0
887
    return quantity
888

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

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

914
      This is the same as getDestinationDebit where quantity is replaced
915 916
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
917 918 919 920 921 922
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
Nicolas Dumazet's avatar
Nicolas Dumazet committed
923
    if (quantity < 0) ^ bool(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
Nicolas Dumazet's avatar
Nicolas Dumazet committed
942
    if (quantity < 0) ^ bool(self.isCancellationAmount()):
943 944
      return - quantity
    return 0.0
945 946 947
  
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetDebit' )
948 949
  def setSourceAssetDebit(self, source_debit):
    """
950
      Set the source total asset price
951 952
    """
    if source_debit in (None, ''):
953
      self.setSourceTotalAssetPrice(None)
954
      return
955 956 957 958
    try:
      source_debit = float(source_debit)
    except TypeError:
      source_debit = 0.0
959
    self.setCancellationAmount(source_debit < 0)
960
    self.setSourceTotalAssetPrice(source_debit)
961

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

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

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

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

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
  # 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)

1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
  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)

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
  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
1064 1065 1066 1067 1068
  # SKU vs. CU
#   security.declareProtected(Permissions.AccessContentsInformation, 'getSourceStandardInventoriatedQuantity')
#   def getSourceStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1069
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1070 1071
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1072
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073 1074
#       For accounting, returns the quantity converted in a default unit
#     """
1075 1076
#     return self.getStandardInventoriatedQuantity()

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

  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, )
1105