InventoryLine.py 11.9 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, Interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34 35 36 37 38 39 40
from Products.ERP5Type.XMLMatrix import XMLMatrix
from Products.ERP5.Document.DeliveryLine import DeliveryLine
from Products.ERP5.Document.Movement import Movement

from zLOG import LOG

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

    meta_type = 'ERP5 Inventory Line'
    portal_type = 'Inventory Line'
46
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
    isPortalContent = 1
    isRADContent = 1

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

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
                      , PropertySheet.Inventory
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.VariationRange
                      , PropertySheet.ItemAggregation
                      )

70 71
    def _edit(self, REQUEST=None, force_update = 0, **kw):
      DeliveryLine._edit(self, REQUEST=REQUEST, force_update = force_update, **kw)
72 73
      # Calculate inventory
      item_list = self.getAggregateValueList()
74 75 76
      if item_list is not None:
        inventory = len(item_list)
      if inventory != 0:
77
        self.setInventory(inventory)
78

79

Jean-Paul Smets's avatar
Jean-Paul Smets committed
80 81 82 83 84 85 86 87 88
    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
89 90 91 92 93 94 95 96 97 98 99
        # 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
100 101 102 103 104 105 106 107 108 109 110

    security.declareProtected(Permissions.AccessContentsInformation, 'getQuantity')
    def getQuantity(self):
      """
        Computes a quantity which allows to reach inventory
      """
      if not self.hasCellContent():
        # First check if quantity already exists
        quantity = self._baseGetQuantity()
        if quantity not in (0.0, 0, None):
          return quantity
111 112 113
        # Make sure inventory is defined somewhere (here or parent)
        if getattr(aq_base(self), 'inventory', None) is None:
          return 0.0 # No inventory defined, so no quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
114
        # Find total of movements in the past - XXX
115 116 117 118
        resource_value = self.getResourceValue()
        if resource_value is not None:
          # Inventories can only be done in "real" locations / sectinos, not categories thereof
          #  -> therefore we use node and section
119
          current_inventory = resource_value.getInventory( \
120
                                  to_date          = self.getStartDate()
121 122
                                , variation_text   = self.getVariationText()
                                , node             = self.getDestination()
123
                                , section = self.getDestinationSection() #section_category
124 125
                                , simulation_state = self.getPortalCurrentInventoryStateList()
                                )
126
          inventory = self.getInventory()
127 128
          if current_inventory in (None, ''):
            current_inventory = 0.0
129 130
          return self.getInventory() - current_inventory
        return self.getInventory()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131 132 133
      else:
        return None

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
# XXX Following method should be useless now
#     def _setItemIdList(self, value):
#       """
#         Computes total_quantity of all given items and stores this total_quantity
#         in the inventory attribute of the cell
#       """
#       if value is None:
#         return
#       previous_item_list = self.getAggregateValueList()
#       given_item_id_list = value
#       item_object_list = []
#       for item in given_item_id_list:
#         item_result_list = self.portal_catalog(id=item, portal_type="Piece Tissu")
#         if len(item_result_list) == 1:
#           try:
#             object = item_result_list[0].getObject()
#           except :
#             object = None
#         else:
#           object = None
#         if object is not None:
#           # if item was in previous_item_list keep it
#           if object in previous_item_list:
#             # we can add this item to the list of aggregated items
#             item_object_list.append(object)
#           # if new item verify if variated_resource of item == variated_resource of movement
#           elif (self.getResource() == object.getResource()) \
#            and (self.getVariationCategoryList() == object.getVariationCategoryList()):
#             # we can add this item to the list of aggregated items
#             item_object_list.append(object)
#       # update item_id_list and build relation
#       self.setAggregateValueList(item_object_list)
#       # update inventory if needed
#       if len(item_object_list) > 0:
#         quantity = 0
#         for object_item in item_object_list:
#           quantity += object_item.getQuantity()
#         self.setInventory(quantity)
# 
#     def _setProducedItemIdList(self, value):
#       """
#         Computes total_quantity of all given items and stores this total_quantity
#         in the quantity attribute of the cell
#       """
#       if value is None:
#         return
#       previous_item_list = self.getAggregateValueList()
#       given_item_id_list = value
#       item_object_list = []
#       for item in given_item_id_list:
#         item_result_list = self.portal_catalog(id=item, portal_type="Piece Tissu")
#         if len(item_result_list) == 1:
#           try:
#             object = item_result_list[0].getObject()
#           except:
#             object = None
#         else:
#           object = None
#         if object is not None:
#           # if item was in previous_item_list keep it
#           if object in previous_item_list:
#             # we can add this item to the list of aggregated items
#             item_object_list.append(object)
#           # if new item verify if variated_resource of item == variated_resource of movement
#           elif (self.getResource() == object.getResource()) \
#            and (self.getVariationCategoryList() == object.getVariationCategoryList()):
#             # now verify if item can be moved (not already done)
#             last_location_title = object.getLastLocationTitle()
#             if self.getDestinationTitle() != last_location_title or last_location_title == '':
#               # we can add this item to the list of aggregated items
#               item_object_list.append(object)
#       # update item_id_list and build relation
#       self.setAggregateValueList(item_object_list)
#       # update inventory if needed
#       if len(item_object_list) > 0:
#         quantity = 0
#         for object_item in item_object_list:
#           quantity += object_item.getQuantity()
#         self.setProductionQuantity(quantity)
# 
#     def _setConsumedItemIdList(self, value):
#       """
#         Computes total_quantity of all given items and stores this total_quantity
#         in the quantity attribute of the cell
#       """
#       if value is None:
#         return
#       previous_item_list = self.getAggregateValueList()
#       given_item_id_list = value
#       item_object_list = []
#       for item in given_item_id_list:
#         item_result_list = self.portal_catalog(id=item, portal_type="Piece Tissu")
#         if len(item_result_list) == 1:
#           try:
#             object = item_result_list[0].getObject()
#           except:
#             object = None
#         else:
#           object = None
#         if object is not None:
#           # if item was in previous_item_list keep it
#           if object in previous_item_list:
#             # we can add this item to the list of aggregated items
#             item_object_list.append(object)
#           # if new item verify if variated_resource of item == variated_resource of movement
#           elif (self.getResource() == object.getResource()) \
#            and (self.getVariationCategoryList() == object.getVariationCategoryList()):
#             # now verify if item can be moved (not already done)
#             last_location_title = object.getLastLocationTitle()
#             if self.getDestinationTitle() == last_location_title or last_location_title == '':
#               # we can add this item to the list of aggregated items
#               item_object_list.append(object)
#       # update item_id_list and build relation
#       self.setAggregateValueList(item_object_list)
#       # update inventory if needed
#       if len(item_object_list) > 0:
#         quantity = 0
#         for object_item in item_object_list:
#           quantity += object_item.getRemainingQuantity()
#           # we reset the location of the item
#           object_item.setLocation('')
#         self.setConsumptionQuantity(quantity)
# 
#     def getProducedItemIdList(self):
#       """
#         Returns list of items if production_quantity != 0.0
#       """
#       if self.getProductionQuantity() != 0.0:
#         return self.getItemIdList()
#       else:
#         return []
# 
#     def getConsumedItemIdList(self):
#       """
#         Returns list of items if consumption_quantity != 0.0
#       """
#       if self.getConsumptionQuantity() != 0.0:
#         return self.getItemIdList()
#       else:
#         return []
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

    # Inventory cataloging
    security.declareProtected(Permissions.AccessContentsInformation, 'getConvertedInventory')
    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
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedQuantity')
    def getInventoriatedQuantity(self):
      """
        Take into account efficiency in converted target quantity
      """
      return Movement.getInventoriatedQuantity(self)