PackingList.py 4.4 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 AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface

33
from Products.ERP5.Document.Delivery import Delivery
34
from zLOG import LOG
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35 36 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

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'
64
    add_permission = Permissions.AddPortalContent
65
    isDelivery = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
66 67 68

    # Declarative security
    security = ClassSecurityInfo()
69
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70 71 72 73 74 75 76 77

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

82 83
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'isDivergent')
Sebastien Robin's avatar
Sebastien Robin committed
84
    def isDivergent(self,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
85 86 87
      """
        Returns 1 if not simulated or inconsistent target and values
      """
88
      if self.getSimulationState() not in self.getPortalDraftOrderStateList():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
89 90
        if not self.isSimulated():
          return 1
Jérome Perrin's avatar
Jérome Perrin committed
91
      return Delivery.isDivergent(self, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
92

93 94
    #######################################################
    # Container computation
95 96
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'isPacked')
97
    def isPacked(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98
      """
99 100 101
        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
102
      """
103 104 105 106 107 108 109 110 111 112
      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
113 114 115

    ##########################################################################
    # Applied Rule stuff
Jérome Perrin's avatar
Jérome Perrin committed
116
    def updateAppliedRule(self, rule_id="default_delivery_rule", **kw):
117 118 119 120
      """
        XXX FIXME: Kept for compatibility
        updateAppliedRule must be call with the rule_id in workflow script
      """
Jérome Perrin's avatar
Jérome Perrin committed
121
      Delivery.updateAppliedRule(self, rule_id, **kw)