Movement.py 37.6 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
from warnings import warn
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31 32
from AccessControl import ClassSecurityInfo

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

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

from Products.ERP5Type.XMLObject import XMLObject

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

41
from zLOG import LOG, WARNING, DEBUG
42

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

    Movement instances are used in different situations:

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

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

    For example, the following objects are Orders:

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

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

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

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

    This is not the case for Deliveries:

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

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

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

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

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


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

    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.

101
    A delivery document (actually a delivery line) then points to one or more of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    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

120
    - movements are never joined (because it would break causality and
Jean-Paul Smets's avatar
Jean-Paul Smets committed
121 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
      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'
176
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
177 178 179 180 181 182
  isPortalContent = 1
  isRADContent = 1
  isMovement = 1

  # Declarative security
  security = ClassSecurityInfo()
183
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

  # Declarative interfaces
  __implements__ = ( Interface.Variated, )

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
                    , PropertySheet.Amount
                    , PropertySheet.Task
                    , PropertySheet.Arrow
                    , PropertySheet.Movement
                    , PropertySheet.Price
                    )

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

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

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  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')
244 245 246 247 248
    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)
249 250 251 252 253 254 255 256
    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
257
  security.declareProtected(Permissions.AccessContentsInformation, 'getPrice')
258
  def getPrice(self, default=None, evaluate=1, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
259
    """
260 261 262
      Get the Price in the context.

      If price is not stored locally, lookup a price and store it.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
263
    """
264 265 266 267 268 269 270
    # 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
271
    if isinstance(default, Base):
272 273 274 275 276 277 278 279
      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

280 281 282 283
    if len(kw):
      warn('Passing keyword arguments to Movement.getPrice has no effect',
           DeprecationWarning)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
284 285
    local_price = self._baseGetPrice()
    if local_price is None:
286
      # We must find a price for this movement
287
      local_price = self._getPrice(context=self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
288 289
    return local_price

290 291
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTotalPrice')
292
  def getTotalPrice(self, default=0.0, context=None, REQUEST=None, fast=None,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
293 294 295 296
                    **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
297
    """
298 299 300 301 302 303 304 305 306
    # 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
307 308
    
    tmp_context = self.asContext(context=context, REQUEST=REQUEST, **kw)
309
    return self._getTotalPrice(default=default, context=tmp_context, fast=fast, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
310

311 312
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTotalQuantity')
313
  def getTotalQuantity(self, default=0.0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
314 315 316
    """
      Returns the quantity if no cell or the total quantity if cells
    """
317
    return self.getQuantity(default=default)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
318

319
  # Industrial price API
320 321
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getIndustrialPrice')
322 323 324 325 326 327 328 329 330
  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

331
  # Asset price calculation
332 333
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceInventoriatedTotalAssetPrice')
334
  def getSourceInventoriatedTotalAssetPrice(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
335
    """
336 337
      Returns a price which can be used to calculate stock value (asset)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
338 339
      Asset price is used for calculation of inventory asset value
      and for accounting
340 341 342 343 344 345 346 347 348

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

      For outgoing quantities, it is the responsability of database
      to calculate asset prices based on calculation rules (FIFO,
      FILO, AVERAGE, etc.).
Jean-Paul Smets's avatar
Jean-Paul Smets committed
349
    """
350 351 352 353
    # This is what we use for accounting
    result = self.getSourceTotalAssetPrice()
    if result is not None:
      return result
354
    quantity = self.getQuantity()
355 356 357
    if quantity :
      source_asset_price = self.getSourceAssetPrice()
      if source_asset_price :
358
        return source_asset_price * - quantity
359
    return None
360 361 362 363 364 365 366 367 368
  
  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 :
369
      if result > 0:
370
        return result
371
    return 0.0
372 373 374 375 376 377 378 379 380 381 382

  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 :
      if result < 0:
        return -result
383
    return 0.0
384

385 386
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationInventoriatedTotalAssetPrice')
387
  def getDestinationInventoriatedTotalAssetPrice(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
388
    """
389 390
      Returns a price which can be used to calculate stock value (asset)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
391 392 393
      Asset price is used for calculation of inventory asset value
      and for accounting
    """
394 395 396 397
    # This is what we use for accounting
    result = self.getDestinationTotalAssetPrice()
    if result is not None:
      return result
398
    quantity = self.getQuantity()
399 400 401 402
    if quantity :
      destination_asset_price = self.getDestinationAssetPrice()
      if destination_asset_price :
        return destination_asset_price * quantity
403
    return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
404

405 406 407 408 409 410 411 412
  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 :
413
      if result > 0:
414
        return result
415
    return 0.0
416 417 418 419 420 421 422 423 424 425 426

  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 :
      if result < 0:
        return -result
427
    return 0.0
428

429 430
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetPrice')
431 432 433 434
  def getSourceAssetPrice(self):
    """
      Returns the price converted to the currency of the source section

435
      This will be implemeted by calling currency conversion on currency resources
436
    """
437
    return self.getPrice() # XXX Not implemented yet TODO
438

439 440
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationAssetPrice')
441 442 443 444
  def getDestinationAssetPrice(self):
    """
      Returns the price converted to the currency of the destination section
    """
445
    return self.getPrice() # XXX Not implemented yet TODO
446

Jean-Paul Smets's avatar
Jean-Paul Smets committed
447
  # Causality computation
448 449
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isConvergent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
450 451 452 453
  def isConvergent(self):
    """
      Returns 0 if the target is not met
    """
454
    return int(not self.isDivergent())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
455

456 457
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isDivergent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
458 459
  def isDivergent(self):
    """
460
      XXX documentation out of sync with actual use
Jean-Paul Smets's avatar
Jean-Paul Smets committed
461 462 463 464 465 466
      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
467 468 469
    for simulation_movement in self.getDeliveryRelatedValueList():
      if simulation_movement.isDivergent():
        return 1
470
    return 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
471

472 473 474 475 476 477 478 479 480 481
  def getDivergenceList(self):
    """
    Return a list of messages that contains the divergences 
    """
    divergence_list = [] 
    for simulation_movement in self.getDeliveryRelatedValueList():
      divergence_list.extend(simulation_movement.getDivergenceList())

    return divergence_list

482 483 484 485 486 487 488 489 490 491 492 493
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isFrozen')
  def isFrozen(self):
    """
    Returns the frozen status of this movemnt.
    a movement in started, stopped, delivered is automatically frozen.
    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.
    """
    # XXX Hardcoded
    # Maybe, we should use getPortalCurrentInventoryStateList
    # and another portal method for cancelled (and deleted)
494
#     LOG("Movement, isFrozen", DEBUG, "Hardcoded state list")
495 496 497 498 499 500
    if self.getSimulationState() in ('stopped', 'delivered', 'cancelled'):
      return 1
    if self._baseIsFrozen() == 0:
      self._baseSetFrozen(None)
    return self._baseGetFrozen() or 0

501 502
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanation')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
503
  def getExplanation(self):
504
    """
505
      Returns the relative_url of the explanation of this movement.
506
    """
507 508 509
    explanation = self.getExplanationValue()
    if explanation is not None:
      return explanation.getRelativeUrl()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
510

511 512
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationUid')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
513
  def getExplanationUid(self):
514
    """
515
      Returns the uid of the explanation of this movement.
516
    """
517 518 519
    explanation = self.getExplanationValue()
    if explanation is not None:
      return explanation.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
520

521 522
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationValue')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
523
  def getExplanationValue(self):
524
    """
525
      Returns the object explanation of this movement.
526
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
527
    return self.getDeliveryValue()
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
 
  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

551
  security.declareProtected( Permissions.AccessContentsInformation,
552
                             'getRootCausalityValueList')
553 554 555 556 557 558 559 560
  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()
    
561 562

  # Simulation
563 564
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isSimulated')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
565
  def isSimulated(self):
566 567
    return (len(self.getDeliveryRelatedValueList()) > 0) or\
           (len(self.getOrderRelatedValueList()) > 0)
568

569
  # New Causality API
570 571
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderQuantity')
572 573 574 575 576
  def getOrderQuantity(self):
    """
      Returns the quantity of related order(s)
    """
    return self.getQuantity()
577

578 579
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryQuantity')
580 581 582 583
  def getDeliveryQuantity(self):
    """
      Returns the quantity of related delivery(s)
    """
584 585
    return self.getQuantity()

586 587
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationQuantity')
588 589 590 591
  def getSimulationQuantity(self):
    """
      Returns the sum of quantities in related simulation movements
    """
592 593
    return self.getQuantity()

594 595
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStartDateList')
596 597
  def getOrderStartDateList(self):
    """
598
      Returns the list of start date of related order(s)
599 600
    """
    return [self.getStartDate()]
601

602 603
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStartDateList')
604 605
  def getDeliveryStartDateList(self):
    """
606
      Returns the list of start date of related delivery(s)
607 608
    """
    return [self.getStartDate()]
609

610 611
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationStartDateList')
612 613
  def getSimulationStartDateList(self):
    """
614
      Returns the list of start date related simulation movements
615 616
    """
    return [self.getStartDate()]
617

618 619
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStopDateList')
620 621
  def getOrderStopDateList(self):
    """
622
      Returns the list of stop date of related order(s)
623 624
    """
    return [self.getStopDate()]
625

626 627
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStopDateList')
628 629
  def getDeliveryStopDateList(self):
    """
630
      Returns the list of stop date of related delivery(s)
631 632
    """
    return [self.getStopDate()]
633

634 635
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationStopDateList')
636 637
  def getSimulationStopDateList(self):
    """
638
      Returns the list of stop date related simulation movements
639 640
    """
    return [self.getStopDate()]
641

642 643
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceList')
644 645 646 647
  def getOrderSourceList(self):
    """
      Returns the source of related orders
    """
648 649
    return self.getSourceList()

650 651
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceList')
652 653 654 655
  def getDeliverySourceList(self):
    """
      Returns the source of related deliveries
    """
656 657
    return self.getSourceList()

658 659
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceList')
660 661 662 663
  def getSimulationSourceList(self):
    """
      Returns the source of related simulation movements
    """
664 665
    return self.getSourceList()

666 667
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationList')
668 669 670 671
  def getOrderDestinationList(self):
    """
      Returns the destination of related orders
    """
672 673
    return self.getDestinationList()

674 675
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationList')
676 677 678 679
  def getDeliveryDestinationList(self):
    """
      Returns the destination of related deliveries
    """
680 681
    return self.getDestinationList()

682 683
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationList')
684 685 686 687
  def getSimulationDestinationList(self):
    """
      Returns the destination of related simulation movements
    """
688 689
    return self.getDestinationList()

690 691
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderSourceSectionList')
692 693 694 695
  def getOrderSourceSectionList(self):
    """
      Returns the source_section of related orders
    """
696 697
    return self.getSourceSectionList()

698 699
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliverySourceSectionList')
700 701 702 703
  def getDeliverySourceSectionList(self):
    """
      Returns the source_section of related deliveries
    """
704 705
    return self.getSourceSectionList()

706 707
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationSourceSectionList')
708 709 710 711
  def getSimulationSourceSectionList(self):
    """
      Returns the source_section of related simulation movements
    """
712 713
    return self.getSourceSectionList()

714 715
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderDestinationSectionList')
716 717 718 719
  def getOrderDestinationSectionList(self):
    """
      Returns the destination_section of related orders
    """
720 721
    return self.getDestinationSectionList()

722 723
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryDestinationSectionList')
724 725 726 727
  def getDeliveryDestinationSectionList(self):
    """
      Returns the destination_section of related deliveries
    """
728 729
    return self.getDestinationSectionList()

730 731
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationDestinationSectionList')
732 733 734 735
  def getSimulationDestinationSectionList(self):
    """
      Returns the destination_section of related simulation movements
    """
736 737
    return self.getDestinationSectionList()

738
  # Debit and credit methods
739 740
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceDebit')
741 742 743 744 745 746 747
  def getSourceDebit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
748
    except TypeError:
749
      quantity = 0.0
750 751 752
    if (quantity < 0 and not self.isCancellationAmount()):
      return - quantity
    elif quantity > 0 and self.isCancellationAmount():
753 754 755 756
      return - quantity
    else:
      return 0.0

757 758
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceCredit')
759 760 761 762 763 764 765
  def getSourceCredit(self):
    """
      Return the quantity
    """
    quantity = self.getQuantity()
    try:
      quantity = float(quantity)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
766
    except TypeError:
767
      quantity = 0.0
768 769
    if quantity < 0 and not self.isCancellationAmount() \
      or quantity > 0 and self.isCancellationAmount():
770 771 772 773
      return 0.0
    else:
      return quantity

774 775
  security.declareProtected( Permissions.AccessContentsInformation,
                    'getDestinationDebit', 'getDestinationCredit')
776 777 778 779 780 781 782 783 784 785 786 787
  getDestinationDebit = getSourceCredit
  getDestinationCredit = getSourceDebit

  security.declareProtected(Permissions.ModifyPortalContent, 'setSourceDebit')
  def setSourceDebit(self, source_debit):
    """
      Set the quantity
    """
    if source_debit in (None, ''):
      return 0.0
    try:
      source_debit = float(source_debit)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
788
    except TypeError:
789 790 791 792 793 794 795 796 797 798 799 800
      source_debit = 0.0
    self.setQuantity(- source_debit)

  security.declareProtected(Permissions.ModifyPortalContent, 'setSourceCredit')
  def setSourceCredit(self, source_credit):
    """
      Set the quantity
    """
    if source_credit in (None, ''):
      return 0.0
    try:
      source_credit = float(source_credit)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
801
    except TypeError:
802 803 804
      source_credit = 0.0
    self.setQuantity(source_credit)

805 806 807 808
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationDebit', 'setDestinationCredit' )
  setDestinationDebit = setSourceCredit
  setDestinationCredit = setSourceDebit
809

810 811 812
  security.declarePrivate('_edit')
  def _edit(self, **kw):
    """Overloaded _edit to support setting debit and credit at the same time,
813 814
    which is required for the GUI. Also sets the resource first, because
    _setVariationCategoryList needs the resource to be set.
815 816 817
    """
    quantity = 0
    if kw.has_key('source_debit') and kw.has_key('source_credit'):
818 819
      quantity += ((kw.pop('source_credit') or 0) -
                      (kw.pop('source_debit') or 0))
820 821 822 823 824
      kw['quantity'] = quantity
    if kw.has_key('destination_debit') and kw.has_key('destination_credit'):
      quantity += (kw.pop('destination_debit') or 0 -
                   kw.pop('destination_credit') or 0)
      kw['quantity'] = quantity
825 826 827 828 829
    if 'resource' in kw:
      self._setResource(kw.pop('resource'))
    if 'resource_value' in kw:
      self._setResourceValue(kw.pop('resource_value'))
    return XMLObject._edit(self, **kw)
830

831
  # Debit and credit methods for asset
832 833
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetDebit' )
834 835 836 837 838
  def getSourceAssetDebit(self):
    """
      Return the debit part of the source total asset price.

      This is the same as getSourceDebit where quantity is replaced
839 840
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
841 842 843 844 845 846 847 848
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
    if quantity < 0:
      return 0.0
849 850
    else:
      return quantity
851

852 853
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSourceAssetCredit' )
854 855
  def getSourceAssetCredit(self):
    """
856 857 858
      Return the credit part of the source total asset price.

      This is the same as getSourceCredit where quantity is replaced
859 860
      by source_total_asset_price.
      This method returns 0 if the total asset price is not set.
861 862 863 864 865 866 867
    """
    quantity = self.getSourceTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
    if quantity < 0:
868
      return - quantity
869
    else:
870
      return 0.0
871 872 873 874 875 876
  
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDestinationAssetDebit' )
  def getDestinationAssetDebit(self):
    """
      Return the debit part of the destination total asset price.
877

878
      This is the same as getDestinationDebit where quantity is replaced
879 880
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
881 882 883 884 885 886 887 888
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
    if quantity < 0:
      return 0.0
889 890
    else:
      return quantity
891

892 893 894 895 896 897 898
  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
899 900
      by destination_total_asset_price.
      This method returns 0 if the total asset price is not set.
901 902 903 904 905 906 907
    """
    quantity = self.getDestinationTotalAssetPrice()
    try:
      quantity = float(quantity)
    except TypeError:
      quantity = 0.0
    if quantity < 0:
908
      return -quantity
909
    else:
910
      return 0.0
911 912 913
  
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetDebit' )
914 915
  def setSourceAssetDebit(self, source_debit):
    """
916
      Set the source total asset price
917 918
    """
    if source_debit in (None, ''):
919
      self.setSourceTotalAssetPrice(None)
920
      return
921 922 923 924
    try:
      source_debit = float(source_debit)
    except TypeError:
      source_debit = 0.0
925
    self.setSourceTotalAssetPrice(source_debit)
926

927 928 929 930
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setSourceAssetCredit' )
  def setSourceAssetCredit(self, source_credit):
    """
931
      Set the source total asset price
932 933
    """
    if source_credit in (None, ''):
934
      self.setSourceTotalAssetPrice(None)
935
      return
936 937 938 939
    try:
      source_credit = float(source_credit)
    except TypeError:
      source_credit = 0.0
940
    self.setSourceTotalAssetPrice( - source_credit)
941 942 943 944 945

  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationAssetDebit' )
  def setDestinationAssetDebit(self, destination_debit):
    """
946
      Set the destination total asset price
947 948
    """
    if destination_debit in (None, ''):
949
      self.setDestinationTotalAssetPrice(None)
950
      return
951 952 953 954 955 956 957 958 959 960
    try:
      destination_debit = float(destination_debit)
    except TypeError:
      destination_debit = 0.0
    self.setDestinationTotalAssetPrice(destination_debit)

  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDestinationAssetCredit' )
  def setDestinationAssetCredit(self, destination_credit):
    """
961
      Set the destination total asset price
962 963
    """
    if destination_credit in (None, ''):
964
      self.setDestinationTotalAssetPrice(None)
965
      return
966 967 968 969
    try:
      destination_credit = float(destination_credit)
    except TypeError:
      destination_credit = 0.0
970
    self.setDestinationTotalAssetPrice( - destination_credit)
971

Jean-Paul Smets's avatar
Jean-Paul Smets committed
972
  # Item Access (tracking)
973 974
  security.declareProtected(Permissions.AccessContentsInformation,
      'getTrackedItemUidList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
975
  def getTrackedItemUidList(self):
976
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
977
      Return a list of uid for related items
978
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
979 980 981
    ### XXX We should filter by portal type here
    return self.getAggregateUidList()

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
  # 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)

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
  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)

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
  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
1026 1027 1028 1029 1030
  # SKU vs. CU
#   security.declareProtected(Permissions.AccessContentsInformation, 'getSourceStandardInventoriatedQuantity')
#   def getSourceStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1031
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1032 1033
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1034
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1035 1036
#       For accounting, returns the quantity converted in a default unit
#     """
1037 1038
#     return self.getStandardInventoriatedQuantity()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1039 1040 1041 1042
#   security.declareProtected(Permissions.AccessContentsInformation, 'getDestinationStandardInventoriatedQuantity')
#   def getDestinationStandardInventoriatedQuantity(self):
#     """
#       The inventoriated quantity converted in a default unit
1043
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1044 1045
#       For assortments, returns the inventoriated quantity in terms of number of items
#       in the assortemnt.
1046
#
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1047 1048
#       For accounting, returns the quantity converted in a default unit
#     """
1049
#     return self.getStandardInventoriatedQuantity()
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

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