BudgetCell.py 5.52 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
33
from Products.ERP5Type.Core.Predicate import Predicate
Aurel's avatar
Aurel committed
34
from Products.ERP5.Document.MetaNode import MetaNode
35
from Products.ERP5.Document.Movement import Movement
Aurel's avatar
Aurel committed
36

37
class BudgetCell(Predicate, MetaNode, Movement):
38
    """ Budget Cell defines a cell of budget.
39
    XXX This is not a Movement, but we need getDestinationCredit
Aurel's avatar
Aurel committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
    """

    # 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
55 56
                      , PropertySheet.MappedValue
                      , PropertySheet.VariationRange
Aurel's avatar
Aurel committed
57 58 59 60 61 62 63 64 65
                      )

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

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

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

80
    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventory')
81 82 83 84 85
    def getCurrentInventory(self, at_date=None, **kw):
      """ Returns current inventory.

      at_date parameter can be used to take into account budget transactions
      before that date.
86
      """
Jérome Perrin's avatar
Jérome Perrin committed
87
      kw['node_uid'] = self.getUid()
88 89
      resource = self.getResourceValue()
      if resource is not None:
Jérome Perrin's avatar
Jérome Perrin committed
90
        kw['resource_uid'] = resource.getUid()
91 92
      if at_date:
        kw['at_date'] = at_date
93 94
      sign = self.getParentValue().BudgetLine_getConsumptionSign()
      return sign * self.portal_simulation.getCurrentInventory(**kw)
Aurel's avatar
Aurel committed
95

96
    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentBalance')
97
    def getCurrentBalance(self, at_date=None):
98 99 100
      """
      Returns current balance
      """
101 102
      sign = self.getParentValue().BudgetLine_getConsumptionSign()
      return sign * self.getQuantity(0.0) + self.getCurrentInventory(at_date=at_date)
103

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

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

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

135 136 137 138 139
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getExplanationValue')
    def getExplanationValue(self, default=None):
      """Explanation has no meaning for a budget cell"""
      return default