SupplyLine.py 9.8 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002, 2005 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
5
#                    Romain Courteaud <romain@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

Jean-Paul Smets's avatar
Jean-Paul Smets committed
30
import ExtensionClass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32 33
from Globals import InitializeClass, PersistentMapping
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
34
from Products.ERP5Type.XMLMatrix import XMLMatrix
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from Products.ERP5.Document.DeliveryLine import DeliveryLine
36
from Products.ERP5.Document.Movement import Movement
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from Products.ERP5.Document.Path import Path
38
from Products.ERP5Type.Utils import convertToUpperCase
Sebastien Robin's avatar
Sebastien Robin committed
39

40
from zLOG import LOG
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42 43 44 45 46 47 48 49 50 51 52

class SupplyLine(DeliveryLine, Path):
    """
      A DeliveryLine object allows to implement lines in
      Deliveries (packing list, order, invoice, etc.)

      It may include a price (for insurance, for customs, for invoices,
      for orders)
    """

    meta_type = 'ERP5 Supply Line'
    portal_type = 'Supply Line'
53
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54 55
    isPortalContent = 1
    isRADContent = 1
56
    isPredicate = 1
57
    isAccountable = 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58 59 60

    # Declarative security
    security = ClassSecurityInfo()
61
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62 63 64 65 66 67 68 69 70 71 72 73 74

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.Price
75
                      , PropertySheet.SupplyLine
Jean-Paul Smets's avatar
Jean-Paul Smets committed
76 77 78
                      , PropertySheet.VariationRange
                      , PropertySheet.Path
                      , PropertySheet.FlowCapacity
79
                      , PropertySheet.Predicate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
80 81
                      )

82
    #############################################
Jean-Paul Smets's avatar
Jean-Paul Smets committed
83
    # Pricing methods
84 85 86
    #############################################
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getPrice')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
87 88 89 90 91 92 93
    def getPrice(self):
      # If price not defined, look up price
      if getattr(self, 'price', None) is None:
        self.price = 0.0
      # Return the price
      return self.price

94 95
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getTotalPrice')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96 97 98 99
    def getTotalPrice(self):
      """
        Returns the totals price for this line
      """
100 101 102
      quantity = self.getQuantity() or 0.0
      price = self.getPrice() or 0.0
      return quantity * price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
103 104 105 106 107 108 109 110 111 112 113 114 115

    def _getPrice(self, context):
       return 0.0

    def _getDefaultPrice(self, context):
       return 0.0

    def _getTotalPrice(self, context):
      return 0.0

    def _getDefaultTotalPrice(self, context):
      return 0.0

116 117
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'isAccountable')
118 119 120 121 122 123
    def isAccountable(self):
      """
        Returns 1 if this needs to be accounted
      """
      return 0

124 125
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getDefaultPrice')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
126 127 128
    def getDefaultPrice(self, context=None, REQUEST=None, **kw):
      """
      """
129 130
      return self._getDefaultPrice(self.asContext(context=context, 
                                                  REQUEST=REQUEST, **kw))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131

132 133
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getDefaultTotalPrice')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
134 135 136
    def getDefaultTotalPrice(self, context=None, REQUEST=None, **kw):
      """
      """
137 138
      return self._getDefaultTotalPrice(self.asContext(context=context, 
                                                       REQUEST=REQUEST, **kw))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
139

140 141 142 143 144 145 146 147 148 149
    #############################################
    # Predicate method
    #############################################
    asPredicate = Path.asPredicate

    #############################################
    # XMLMatrix methods
    # XXX to be removed if possible
    #############################################
    security.declareProtected(Permissions.ModifyPortalContent, 'hasCellContent')
Sebastien Robin's avatar
Sebastien Robin committed
150 151 152 153
    def hasCellContent(self, base_id='path'):
      """
          This method can be overriden
      """
154
      return XMLMatrix.hasCellContent(self, base_id=base_id)
Sebastien Robin's avatar
Sebastien Robin committed
155

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getCellValueList' )
    def getCellValueList(self, base_id='path'):
      """
          This method can be overriden
      """
      return XMLMatrix.getCellValueList(self, base_id=base_id)

    security.declareProtected(Permissions.View, 'getCell')
    def getCell(self, *kw , **kwd):
      """
          This method can be overriden
      """
      if 'base_id' not in kwd:
        kwd['base_id'] = 'path'
      return XMLMatrix.getCell(self, *kw, **kwd)

    security.declareProtected(Permissions.ModifyPortalContent, 'newCell')
    def newCell(self, *kw, **kwd):
      """
          This method creates a new cell
      """
      if 'base_id' not in kwd:
        kwd['base_id'] = 'path'
      return XMLMatrix.newCell(self, *kw, **kwd)
181

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
    ############################################################
    # Quantity predicate API
    ############################################################
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getQuantityPredicateIdList')
    def getQuantityPredicateIdList(self, price_parameter):
      """
        Return predicate id related to a price parameter.
      """
      predicate_id_start_with = "quantity_range_"
      if price_parameter != "base_price":
        predicate_id_start_with = "%s_%s" % \
            (price_parameter, predicate_id_start_with)
      # XXX Hardcoded portal type name
      predicate_list = self.contentIds(filter={'portal_type': 'Predicate'})
      # XXX filtering can be done with contentIds ?
      result = [x for x in predicate_list \
              if x.startswith(predicate_id_start_with)]
      return result
201

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getQuantityPredicateValueList')
    def getQuantityPredicateValueList(self, price_parameter):
      """
        Return predicate related to a price parameter.
      """
      result = [getattr(self, x) for x in \
              self.getQuantityPredicateIdList(price_parameter)]
      return result

    security.declareProtected(Permissions.View, 'getQuantityStepList')
    def getQuantityStepList(self, price_parameter="base_price"):
      """
        Return predicate step related to a price_parameter
      """
      if price_parameter == "base_price":
        method_name = "_baseGetQuantityStepList"
      else:
        method_name = 'get%sList' % \
                     convertToUpperCase("%s_quantity_step" % price_parameter)
      return getattr(self, method_name)()

    security.declareProtected(Permissions.ModifyPortalContent, 
225
                              'updateQuantityPredicate')
226 227 228 229 230
    def updateQuantityPredicate(self, price_parameter):
      """
        Update the quantity predicate
      """
      value = self.getQuantityStepList(price_parameter)
231
      value.sort()
232
      # XXX Hardcoded portal type name
233
      for pid in self.getQuantityPredicateIdList(price_parameter):
234
        self.deleteContent(pid)
235 236 237
      if len(value) > 0:
        #value = value
        value = [None] + value + [None]
238 239 240
        # With this script, we can change customize the title of the 
        # predicate
        script = getattr(self, 'SupplyLine_getTitle', None)
241 242 243 244 245
        predicate_id_start_with = "quantity_range"
        if price_parameter != "base_price":
          predicate_id_start_with = "%s_%s" % \
              (price_parameter, predicate_id_start_with)
        for i in range(0, len(value)-1):
246 247
          min = value[i]
          max = value[i+1]
248
          # XXX Hardcoded portal type name
249
          p = self.newContent(id='%s_%s' % (predicate_id_start_with, str(i)), 
250
                              portal_type = 'Predicate')
251 252 253
          p.setCriterionPropertyList(('quantity', ))
          p.setCriterion('quantity', min=min, max=max)
          if script is not None:
254
            title = script(min=min, max=max)
255 256 257 258 259 260 261
            p.setTitle(title)
          else:
            if min is None:
              p.setTitle(' quantity < %s' % repr(max))
            elif max is None:
              p.setTitle('%s <= quantity' % repr(min))
            else:
262
              p.setTitle('%s <= quantity < %s' % (repr(min), repr(max)))