OrderLine.py

##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Globals import InitializeClass, PersistentMapping
from AccessControl import ClassSecurityInfo

from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
from Products.ERP5.Document.DeliveryLine import DeliveryLine
from Products.ERP5.Document.Movement import Movement

from zLOG import LOG

class OrderLine(DeliveryLine):
    """
      A order line defines quantity and price
    """

    meta_type = 'ERP5 Order Line'
    portal_type = 'Order Line'

    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.AccessContentsInformation)

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
                      , PropertySheet.Task
                      , PropertySheet.DublinCore
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.Price
                      , PropertySheet.VariationRange
                      , PropertySheet.ItemAggregation
                      )

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    security.declareProtected(Permissions.AccessContentsInformation,
                              'hasLineContent')
    def hasLineContent(self):
      """Return true if the object contains lines.
         We cache results in a volatile variable.
      """
      transactional_variable = getTransactionalVariable(self)
      call_method_key = ('Products.ERP5.Document.OrderLine.hasLineContent', self.getPhysicalPath())
      try:
        result = transactional_variable[call_method_key]
      except KeyError:
        result = len(self.contentValues(meta_type=self.meta_type)) > 0
        transactional_variable[call_method_key] = result
      return result

    def _getTotalPrice(self, context, fast=1):
      """
      if hasLineContent: return sum of lines total price
      if hasCellContent: return sum of cells total price
      else: return quantity * price
      """
      base_id = 'movement'
      if self.hasLineContent():
        return sum(l.getTotalPrice() for l in
            self.contentValues(meta_type=self.meta_type))
      elif self.hasCellContent(base_id=base_id):
        if fast : # Use MySQL
          aggregate = self.DeliveryLine_zGetTotal()[0]
          return aggregate.total_price or 0.0
        return sum([ ( (cell.getQuantity() or 0) *
                       (cell.getPrice(context=context) or 0))
                        for cell in self.getCellValueList()])
      else:
        quantity = self.getQuantity() or 0.0
        price = self.getPrice(context=context) or 0.0
        return quantity * price

    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTotalQuantity')
    def getTotalQuantity(self, fast=1):
      """
      if hasLineContent: return sum of lines total quantity
      if hasCellContent: return sum of cells total quantity
      else: return quantity
      """
      base_id = 'movement'
      if self.hasLineContent():
        return sum(l.getTotalQuantity() for l in
            self.contentValues(meta_type=self.meta_type))
      elif self.hasCellContent(base_id=base_id):
        if fast : # Use MySQL
          aggregate = self.DeliveryLine_zGetTotal()[0]
          return aggregate.total_quantity or 0.0
        return sum([cell.getQuantity() for cell in self.getCellValueList()])
      else:
        return self.getQuantity()

    def applyToOrderLineRelatedMovement(self, portal_type='Simulation Movement', 
                                        method_id = 'expand'):
      """
        Warning: does not work if it was not catalogued immediately
      """
      # Find related in simulation
      for my_simulation_movement in self.getOrderRelatedValueList(
                                   portal_type = 'Simulation Movement'):
        # And apply
        getattr(my_simulation_movement, method_id)()
      for c in self.contentValues(filter={'portal_type': 'Delivery Cell'}):
        for my_simulation_movement in c.getOrderRelatedValueList(
                                   portal_type = 'Simulation Movement'):
          # And apply
          getattr(my_simulation_movement, method_id)()

    # Simulation Consistency Check
    def getSimulationQuantity(self):
      """
          Computes the target quantities in the simulation
      """
      result = self.OrderLine_zGetRelatedQuantity(uid=self.getUid())
      if len(result) > 0:
        return result[0].quantity
      return None