OrderLine.py 6.11 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 29 30 31 32
#
# 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
33
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35 36
from Products.ERP5.Document.DeliveryLine import DeliveryLine
from Products.ERP5.Document.Movement import Movement

37 38
from zLOG import LOG

Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40
class OrderLine(DeliveryLine):
    """
41
      A order line defines quantity and price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45 46 47 48
    """

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

    # Declarative security
    security = ClassSecurityInfo()
49
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51 52 53 54 55 56

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
                      , PropertySheet.Task
57
                      , PropertySheet.DublinCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58 59 60 61
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.Price
                      , PropertySheet.VariationRange
62
                      , PropertySheet.ItemAggregation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63 64 65 66 67
                      )

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

68 69 70 71 72 73
    security.declareProtected(Permissions.AccessContentsInformation,
                              'hasLineContent')
    def hasLineContent(self):
      """Return true if the object contains lines.
         We cache results in a volatile variable.
      """
74 75
      transactional_variable = getTransactionalVariable(self)
      call_method_key = ('Products.ERP5.Document.OrderLine.hasLineContent', self.getPhysicalPath())
76
      try:
77
        result = transactional_variable[call_method_key]
78
      except KeyError:
79 80 81 82 83 84
        result = False
        meta_type = self.meta_type
        for i in self.objectValues():
          if i.meta_type==meta_type:
            result = True
            break
85
        transactional_variable[call_method_key] = result
86 87
      return result

88
    def _getTotalPrice(self, default=0.0, context=None, fast=0):
89 90
      """Returns the total price for this order line.

91 92 93
      if hasLineContent: return sum of lines total price
      if hasCellContent: return sum of cells total price
      else: return quantity * price
94
      if fast is argument true, then a SQL method will be used.
95 96
      """
      if self.hasLineContent():
97
        meta_type = self.meta_type
98
        return sum(l.getTotalPrice(context=context)
99
                   for l in self.contentValues() if l.meta_type==meta_type)
100 101 102 103
      return DeliveryLine._getTotalPrice(self,
                                         default=default,
                                         context=context,
                                         fast=fast)
104 105 106

    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTotalQuantity')
107 108 109
    def getTotalQuantity(self, fast=0):
      """Returns the total quantity of this order line.

110 111 112
      if hasLineContent: return sum of lines total quantity
      if hasCellContent: return sum of cells total quantity
      else: return quantity
113
      if fast argument is true, then a SQL method will be used.
114 115 116
      """
      base_id = 'movement'
      if self.hasLineContent():
117
        meta_type = self.meta_type
118
        return sum(l.getTotalQuantity() for l in
119
            self.contentValues() if l.meta_type==meta_type)
120 121 122 123 124 125 126 127
      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()

128 129
    def applyToOrderLineRelatedMovement(self, portal_type='Simulation Movement', 
                                        method_id = 'expand'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130 131 132 133 134
      """
        Warning: does not work if it was not catalogued immediately
      """
      # Find related in simulation
      for my_simulation_movement in self.getOrderRelatedValueList(
135
                                   portal_type = 'Simulation Movement'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
136 137 138 139
        # 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(
140
                                   portal_type = 'Simulation Movement'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
141 142 143 144
          # And apply
          getattr(my_simulation_movement, method_id)()

    # Simulation Consistency Check
145
    def getSimulationQuantity(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
146 147 148 149 150
      """
          Computes the target quantities in the simulation
      """
      result = self.OrderLine_zGetRelatedQuantity(uid=self.getUid())
      if len(result) > 0:
151
        return result[0].quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152
      return None
153