InventoryLine.py 5.01 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3 4
# Copyright (c) 2002-2005 Nexedi SARL and Contributors. All Rights Reserved.
#                         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
#
# 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
30
from Acquisition import aq_base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31

32
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34 35 36 37 38 39
from Products.ERP5.Document.DeliveryLine import DeliveryLine
from Products.ERP5.Document.Movement import Movement

from zLOG import LOG

class InventoryLine(DeliveryLine):
    """
40
      An Inventory Line describe the inventory of a resource, by variations.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42 43 44
    """

    meta_type = 'ERP5 Inventory Line'
    portal_type = 'Inventory Line'
45
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47
    isPortalContent = 1
    isRADContent = 1
48
    isInventoryMovement = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49 50 51

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

    # Declarative interfaces
55
    __implements__ = ( interfaces.IVariated, )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
56 57 58 59 60 61

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
62
                      , PropertySheet.InventoryMovement
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63 64 65 66 67 68 69
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.VariationRange
                      , PropertySheet.ItemAggregation
                      )

70

Jean-Paul Smets's avatar
Jean-Paul Smets committed
71 72 73 74 75 76 77 78 79
    security.declareProtected(Permissions.AccessContentsInformation, 'getTotalInventory')
    def getTotalInventory(self):
      """
        Returns the inventory if no cell or the total inventory if cells
      """
      if not self.hasCellContent():
        return self.getInventory()
      else:
        # Use MySQL
80 81 82 83 84 85 86 87 88 89 90
        # There is no inventory column in mysql any more,
        # is it required to add it again. It is only
        # usefull for the user interface
        # aggregate = self.InventoryLine_zGetTotal()[0]
        # return aggregate.total_inventory or 0.0

        total_quantity = 0.0
        for cell in self.getCellValueList(base_id='movement'):
          if cell.getInventory() is not None:
            total_quantity += cell.getInventory()
        return total_quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91

92 93
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getQuantity')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
94 95 96 97 98 99 100
    def getQuantity(self):
      """
        Computes a quantity which allows to reach inventory
      """
      if not self.hasCellContent():
        # First check if quantity already exists
        quantity = self._baseGetQuantity()
101
        if quantity not in (0.0,0,None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
102
          return quantity
103
        # Make sure inventory is defined somewhere (here or parent)
104 105
        _marker = []
        inventory = getattr(aq_base(self), 'inventory', _marker)
106
        if inventory is not _marker and inventory is not None:
107 108
          return inventory
        return quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110 111
      else:
        return None

112
    # Inventory cataloging
113 114
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getConvertedInventory')
115 116 117 118 119 120 121 122
    def getConvertedInventory(self):
      """
        provides a default inventory value - None since
        no inventory was defined.
      """
      return self.getInventory() # XXX quantity unit is missing

    # Required for indexing
123 124
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInventoriatedQuantity')
125 126 127 128 129
    def getInventoriatedQuantity(self):
      """
        Take into account efficiency in converted target quantity
      """
      return Movement.getInventoriatedQuantity(self)
130 131 132 133 134

    def reindexObject(self, *args, **kw):
      """
      Make sure to reindex the inventory
      """
Aurel's avatar
Aurel committed
135
      self.getParentValue().recursiveReindexObject(*args, **kw)
136