BudgetCell.py 4.93 KB
Newer Older
Aurel's avatar
Aurel committed
1 2
##############################################################################
#
3
# Copyright (c) 2005, 2006 Nexedi SARL and Contributors. All Rights Reserved.
Aurel's avatar
Aurel committed
4
#                    Yoshinori Okuji <yo@nexedi.com>
5
#                    Romain Courteaud <romain@nexedi.com>
Aurel's avatar
Aurel 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
#
# 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

32
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
Aurel's avatar
Aurel committed
33 34 35
from Products.ERP5.Document.Predicate import Predicate
from Products.ERP5.Document.MetaNode import MetaNode

36
from Products.ERP5.Document.InventoryCell import InventoryCell
Aurel's avatar
Aurel committed
37 38 39

from zLOG import LOG

40
class BudgetCell(Predicate, MetaNode):
Aurel's avatar
Aurel committed
41
    """
42
    BudgetCell ...
Aurel's avatar
Aurel committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
    """

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.SimpleItem
                      , PropertySheet.Folder
                      , PropertySheet.Predicate
                      , PropertySheet.SortIndex
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Amount
                      , PropertySheet.Budget
58 59
                      , PropertySheet.MappedValue
                      , PropertySheet.VariationRange
Aurel's avatar
Aurel committed
60 61 62 63 64 65 66 67 68 69 70
                      )

    # CMF Type Definition
    meta_type='ERP5 Budget Cell'
    portal_type='Budget Cell'    
    add_permission = Permissions.AddPortalContent
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
71
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Aurel's avatar
Aurel committed
72

73
    security.declareProtected(Permissions.AccessContentsInformation, 'getTitle')
Aurel's avatar
Aurel committed
74
    def getTitle(self):
75 76 77 78
      """
      Return a calculated title.
      """
      script = self._getTypeBasedMethod('asTitle')
79 80 81
      if script is not None:
        return script()
      raise UnboundLocalError,\
82 83
              "Did not find title script for portal type: %r" %\
              self.getPortalType()
84

85
    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventory')
86 87 88 89 90 91 92 93 94
    def getCurrentInventory(self, **kw):
      """
      Returns current inventory
      """
      kw['node'] = self.getRelativeUrl()
      resource = self.getResourceValue()
      if resource is not None:
        kw['resource'] = resource.getRelativeUrl()
      return self.portal_simulation.getCurrentInventory(**kw)
Aurel's avatar
Aurel committed
95

96
    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentBalance')
Aurel's avatar
Aurel committed
97
    def getCurrentBalance(self):
98 99 100 101 102
      """
      Returns current balance
      """
      return self.getQuantity(0.0) + self.getCurrentInventory()

103
    security.declareProtected(Permissions.AccessContentsInformation, 'getConsumedBudget')
Aurel's avatar
Aurel committed
104
    def getConsumedBudget(self, src__=0):
105 106 107 108
      """
      Return consumed budget.
      """
      script = self._getTypeBasedMethod('getConsumedBudget')
109 110 111
      if script is not None:
        return script(src__=src__)
      raise UnboundLocalError,\
112 113 114
              "Did not find consumed budget script for portal type: %r" % \
              self.getPortalType()

115
    security.declareProtected(Permissions.AccessContentsInformation, 'getAvailableBudget')
116 117 118 119
    def getAvailableBudget(self):
      """
      Return available budget.
      """
120
      return self.getCurrentBalance() - self.getEngagedBudget()
121

122
    security.declareProtected(Permissions.AccessContentsInformation, 'getEngagedBudget')
123 124 125 126 127
    def getEngagedBudget(self, src__=0):
      """
      Return Engaged budget.
      """
      script = self._getTypeBasedMethod('getEngagedBudget')
128 129 130
      if script is not None:
        return script(src__=src__)
      raise UnboundLocalError,\
131 132 133
              "Did not find engaged budget script for portal type: %r" % \
              self.getPortalType()