PackingList.py 6.16 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 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.CMFCore.utils import getToolByName
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34

35
from Products.ERP5.Document.Delivery import Delivery
36
from zLOG import LOG
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

class PackingList(Delivery):
    """
      Delivery/PackingList is the main document
      which allows to control causality in the simulation

      PackingList have 2 different states:

      - solved: this happens when quantities and target
        quantities are the same

      - diverged: this happens when quantities and target
        quantities are different

      Resolution of diverged PackingList is achieved by workflow
      methods. Such workflow methods eventually change
      movements in the simulation. Typical solution include:

      - reduce quantity

      - split delivery

      - postpone delivery

      solutions are implemented as solvers
    """
    # CMF Type Definition
    meta_type = 'ERP5 Packing List'
    portal_type = 'Packing List'
66
    add_permission = Permissions.AddPortalContent
67
    isDelivery = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
68 69 70 71 72 73 74 75 76 77 78 79

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

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.Task
                      , PropertySheet.Arrow
80
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
81 82 83
                      , PropertySheet.Movement
                      )

Jean-Paul Smets's avatar
Jean-Paul Smets committed
84 85 86 87 88
    security.declareProtected(Permissions.View, 'isDivergent')
    def isDivergent(self):
      """
        Returns 1 if not simulated or inconsistent target and values
      """
89
      if self.getSimulationState() not in self.getPortalDraftOrderStateList():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
90 91 92 93
        if not self.isSimulated():
          return 1
      return Delivery.isDivergent(self)

94 95
    security.declareProtected(Permissions.ModifyPortalContent, 'updateAppliedRule')
    def updateAppliedRule(self):
96
      if self.getSimulationState() not in self.getPortalDraftOrderStateList():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
97
        # Nothing to do if we are already simulated
98 99
        self._createDeliveryRule()

100 101
    security.declareProtected(Permissions.ModifyPortalContent,\
                              '_createDeliveryRule')
102 103 104
    def _createDeliveryRule(self):
      # Return if draft or cancelled simulation_state
      if self.getSimulationState() in ('cancelled',):
105 106
        # The applied rule should be cleaned up 
        # ie. empty all movements which have no confirmed children
107 108 109
        return
      # Otherwise, expand
      # Look up if existing applied rule
110 111
      my_applied_rule_list = self.getCausalityRelatedValueList(\
                                            portal_type='Applied Rule')
112
      if len(my_applied_rule_list) == 0:
113 114 115 116
        if self.isSimulated(): 
          # No need to create a DeliveryRule 
          # if we are already in the simulation process
          return 
117 118 119
        # Create a new applied order rule (portal_rules.order_rule)
        portal_rules = getToolByName(self, 'portal_rules')
        portal_simulation = getToolByName(self, 'portal_simulation')
120 121
        my_applied_rule = portal_rules.default_delivery_rule.\
                                    constructNewAppliedRule(portal_simulation)
122 123
        # Set causality
        my_applied_rule.setCausalityValue(self)
124 125
        # We must make sure this rule is indexed
        # now in order not to create another one later
126
        my_applied_rule.immediateReindexObject()
127 128
        # XXX do not use flushActivity anymore ! 
#         my_applied_rule.flushActivity(invoke = 1) 
129 130 131 132
      elif len(my_applied_rule_list) == 1:
        # Re expand the rule if possible
        my_applied_rule = my_applied_rule_list[0]
      else:
133
        raise "SimulationError", 'Packing list %s has more than one applied\
134
                                rule.' % self.getRelativeUrl()
135 136 137 138 139

      # We are now certain we have a single applied rule
      # It is time to expand it
      self.activate().expand(my_applied_rule.getId())

140 141 142 143
    #######################################################
    # Container computation
    security.declareProtected(Permissions.View, 'isPacked')
    def isPacked(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144
      """
145 146 147
        Returns 0 if all quantity resource on packing list line
        are not in container.
        It works only if a Resource is not on 2 PackingListLine.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
148
      """
149 150 151 152 153 154 155 156 157 158 159
      explanation_uid = self.getUid()
      for movement in self.getMovementList():

        quantity = movement.getQuantity()
        # XXX FIXME: script name hardcoded
        packed_quantity = movement.Movement_getPackedQuantity()

        if quantity != packed_quantity:
          return 0

      return 1