Movement.py 40.2 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 :
388 389 390
      if result > 0 and not self.isCancellationAmount():
        return result
      if result < 0 and self.isCancellationAmount():
391
        return result
392
    return 0.0
393 394 395 396 397 398 399 400 401

  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 :
402 403 404
      if result < 0 and not self.isCancellationAmount():
        return -result
      if result > 0 and self.isCancellationAmount():
405
        return -result
406
    return 0.0
407

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

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

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

  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 :
448
      if (result < 0) ^ bool(self.isCancellationAmount()):
449
        return -result
450
    return 0.0
451

452 453
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetPrice')
454 455 456 457
  def getSourceAssetPrice(self):
    """
      Returns the price converted to the currency of the source section

458
      This will be implemeted by calling currency conversion on currency resources
459
    """
460
    return self.getPrice() # XXX Not implemented yet TODO
461

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

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

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

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

    return divergence_list

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

    BPM evaluation allows to set frozen state list per Business Path.
515
    """
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
    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
531 532
    if self._baseIsFrozen() == 0:
      self._baseSetFrozen(None)
533
    return self._baseGetFrozen() or False
534

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

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

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

585
  security.declareProtected( Permissions.AccessContentsInformation,
586
                             'getRootCausalityValueList')
587 588 589 590 591 592 593 594
  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()
    
595 596

  # Simulation
597 598
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isSimulated')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
599
  def isSimulated(self):
600
    # 'order' category is deprecated. it is kept for compatibility.
601 602
    return (len(self.getDeliveryRelatedValueList()) > 0) or\
           (len(self.getOrderRelatedValueList()) > 0)
603

604
  # New Causality API
605 606
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderQuantity')
607 608 609 610
  def getOrderQuantity(self):
    """
      Returns the quantity of related order(s)
    """
611
    # XXX deprecated
612
    return self.getQuantity()
613

614 615
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryQuantity')
616 617 618 619
  def getDeliveryQuantity(self):
    """
      Returns the quantity of related delivery(s)
    """
620 621
    return self.getQuantity()

622 623
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationQuantity')
624 625 626 627
  def getSimulationQuantity(self):
    """
      Returns the sum of quantities in related simulation movements
    """
628 629
    return self.getQuantity()

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

639 640
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStartDateList')
641 642
  def getDeliveryStartDateList(self):
    """
643
      Returns the list of start date of related delivery(s)
644 645
    """
    return [self.getStartDate()]
646

647 648
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationStartDateList')
649 650
  def getSimulationStartDateList(self):
    """
651
      Returns the list of start date related simulation movements
652 653
    """
    return [self.getStartDate()]
654

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

664 665
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStopDateList')
666 667
  def getDeliveryStopDateList(self):
    """
668
      Returns the list of stop date of related delivery(s)
669 670
    """
    return [self.getStopDate()]
671

672 673
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationStopDateList')
674 675
  def getSimulationStopDateList(self):
    """
676
      Returns the list of stop date related simulation movements
677 678
    """
    return [self.getStopDate()]
679

680 681
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceList')
682 683 684 685
  def getOrderSourceList(self):
    """
      Returns the source of related orders
    """
686
    # XXX deprecated
687 688
    return self.getSourceList()

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

697 698
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceList')
699 700 701 702
  def getSimulationSourceList(self):
    """
      Returns the source of related simulation movements
    """
703 704
    return self.getSourceList()

705 706
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationList')
707 708 709 710
  def getOrderDestinationList(self):
    """
      Returns the destination of related orders
    """
711
    # XXX deprecated
712 713
    return self.getDestinationList()

714 715
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationList')
716 717 718 719
  def getDeliveryDestinationList(self):
    """
      Returns the destination of related deliveries
    """
720 721
    return self.getDestinationList()

722 723
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationList')
724 725 726 727
  def getSimulationDestinationList(self):
    """
      Returns the destination of related simulation movements
    """
728 729
    return self.getDestinationList()

730 731
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceSectionList')
732 733 734 735
  def getOrderSourceSectionList(self):
    """
      Returns the source_section of related orders
    """
736
    # XXX deprecated
737 738
    return self.getSourceSectionList()

739 740
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceSectionList')
741 742 743 744
  def getDeliverySourceSectionList(self):
    """
      Returns the source_section of related deliveries
    """
745 746
    return self.getSourceSectionList()

747 748
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceSectionList')
749 750 751 752
  def getSimulationSourceSectionList(self):
    """
      Returns the source_section of related simulation movements
    """
753 754
    return self.getSourceSectionList()

755 756
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationSectionList')
757 758 759 760
  def getOrderDestinationSectionList(self):
    """
      Returns the destination_section of related orders
    """
761
    # XXX deprecated
762 763
    return self.getDestinationSectionList()

764 765
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationSectionList')
766 767 768 769
  def getDeliveryDestinationSectionList(self):
    """
      Returns the destination_section of related deliveries
    """
770 771
    return self.getDestinationSectionList()

772 773
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationSectionList')
774 775 776 777
  def getSimulationDestinationSectionList(self):
    """
      Returns the destination_section of related simulation movements
    """
778 779
    return self.getDestinationSectionList()

780
  # Debit and credit methods
781 782
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceDebit')
783 784 785 786 787 788 789
  def getSourceDebit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
790
    except TypeError:
791
      quantity = 0.0
792 793 794
    if (quantity < 0 and not self.isCancellationAmount()):
      return - quantity
    elif quantity > 0 and self.isCancellationAmount():
795
      return - quantity
796
    return 0.0
797

798 799
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceCredit')
800 801 802 803 804 805 806
  def getSourceCredit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
807
    except TypeError:
808
      quantity = 0.0
809 810
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
811
      return 0.0
812
    return quantity
813

814 815
  security.declareProtected( Permissions.AccessContentsInformation,
                    'getDestinationDebit', 'getDestinationCredit')
816 817 818 819 820 821 822 823 824
  getDestinationDebit = getSourceCredit
  getDestinationCredit = getSourceDebit

  security.declareProtected(Permissions.ModifyPortalContent, 'setSourceDebit')
  def setSourceDebit(self, source_debit):
    """
      Set the quantity
    """
    if source_debit in (None, ''):
825
      return
826 827
    try:
      source_debit = float(source_debit)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
828
    except TypeError:
829
      source_debit = 0.0
830
    self.setCancellationAmount(source_debit < 0)
831 832 833 834 835 836 837 838
    self.setQuantity(- source_debit)

  security.declareProtected(Permissions.ModifyPortalContent, 'setSourceCredit')
  def setSourceCredit(self, source_credit):
    """
      Set the quantity
    """
    if source_credit in (None, ''):
839
      return
840 841
    try:
      source_credit = float(source_credit)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
842
    except TypeError:
843
      source_credit = 0.0
844
    self.setCancellationAmount(source_credit < 0)
845 846
    self.setQuantity(source_credit)

847 848 849 850
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationDebit', 'setDestinationCredit' )
  setDestinationDebit = setSourceCredit
  setDestinationCredit = setSourceDebit
851

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

876
  # Debit and credit methods for asset
877 878
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetDebit' )
879 880 881 882 883
  def getSourceAssetDebit(self):
    """
      Return the debit part of the source total asset price.

      This is the same as getSourceDebit where quantity is replaced
884 885
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
886 887 888 889 890 891
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
892 893
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
894
      return 0.0
895
    return quantity
896

897 898
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetCredit' )
899 900
  def getSourceAssetCredit(self):
    """
901 902 903
      Return the credit part of the source total asset price.

      This is the same as getSourceCredit where quantity is replaced
904 905
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
906 907 908 909 910 911
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
912
    if (quantity < 0 and not self.isCancellationAmount()):
913
      return - quantity
914 915 916
    elif quantity > 0 and self.isCancellationAmount():
      return - quantity
    return 0.0
917 918 919 920 921 922
  
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationAssetDebit' )
  def getDestinationAssetDebit(self):
    """
      Return the debit part of the destination total asset price.
923

924
      This is the same as getDestinationDebit where quantity is replaced
925 926
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
927 928 929 930 931 932
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
933 934
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
935
      return 0.0
936
    return quantity
937

938 939 940 941 942 943 944
  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
945 946
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
947 948 949 950 951 952
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
953 954 955 956 957
    if (quantity < 0 and not self.isCancellationAmount()):
      return - quantity
    elif quantity > 0 and self.isCancellationAmount():
      return - quantity
    return 0.0
958 959 960
  
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetDebit' )
961 962
  def setSourceAssetDebit(self, source_debit):
    """
963
      Set the source total asset price
964 965
    """
    if source_debit in (None, ''):
966
      self.setSourceTotalAssetPrice(None)
967
      return
968 969 970 971
    try:
      source_debit = float(source_debit)
    except TypeError:
      source_debit = 0.0
972
    self.setCancellationAmount(source_debit < 0)
973
    self.setSourceTotalAssetPrice(source_debit)
974

975 976 977 978
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetCredit' )
  def setSourceAssetCredit(self, source_credit):
    """
979
      Set the source total asset price
980 981
    """
    if source_credit in (None, ''):
982
      self.setSourceTotalAssetPrice(None)
983
      return
984 985 986 987
    try:
      source_credit = float(source_credit)
    except TypeError:
      source_credit = 0.0
988
    self.setCancellationAmount(source_credit < 0)
989
    self.setSourceTotalAssetPrice( - source_credit)
990 991 992 993 994

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

  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationAssetCredit' )
  def setDestinationAssetCredit(self, destination_credit):
    """
1011
      Set the destination total asset price
1012 1013
    """
    if destination_credit in (None, ''):
1014
      self.setDestinationTotalAssetPrice(None)
1015
      return
1016 1017 1018 1019
    try:
      destination_credit = float(destination_credit)
    except TypeError:
      destination_credit = 0.0
1020
    self.setCancellationAmount(destination_credit < 0)
1021
    self.setDestinationTotalAssetPrice( - destination_credit)
1022

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1023
  # Item Access (tracking)
1024 1025
  security.declareProtected(Permissions.AccessContentsInformation,
      'getTrackedItemUidList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1026
  def getTrackedItemUidList(self):
1027
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1028
      Return a list of uid for related items
1029
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1030 1031 1032
    ### XXX We should filter by portal type here
    return self.getAggregateUidList()

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
  # 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)

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
  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)

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
  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
1077 1078 1079 1080 1081
  # SKU vs. CU
#   security.declareProtected(Permissions.AccessContentsInformation, 'getSourceStandardInventoriatedQuantity')
#   def getSourceStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1082
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1083 1084
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1085
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1086 1087
#       For accounting, returns the quantity converted in a default unit
#     """
1088 1089
#     return self.getStandardInventoriatedQuantity()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1090 1091 1092 1093
#   security.declareProtected(Permissions.AccessContentsInformation, 'getDestinationStandardInventoriatedQuantity')
#   def getDestinationStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1094
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1095 1096
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1097
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1098 1099
#       For accounting, returns the quantity converted in a default unit
#     """
1100
#     return self.getStandardInventoriatedQuantity()
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117

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