AccountingTransactionLine.py 7.45 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    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 30
#
# 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

31
from Products.ERP5Type import Permissions, PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32
from Products.ERP5.Document.DeliveryLine import DeliveryLine
33
from Products.ERP5.Document.Amount import Amount
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34

35

Jean-Paul Smets's avatar
Jean-Paul Smets committed
36 37
class AccountingTransactionLine(DeliveryLine):
  """
38 39
  Accounting Transaction Lines allow to move some quantity of money from
  a source to a destination
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40 41 42 43
  """

  meta_type = 'ERP5 Accounting Transaction Line'
  portal_type = 'Accounting Transaction Line'
44
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
45 46 47 48 49
  isPortalContent = 1
  isRADContent = 1

  # Declarative security
  security = ClassSecurityInfo()
50
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51 52 53 54 55 56 57 58

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
                    , PropertySheet.CategoryCore
                    , PropertySheet.Amount
                    , PropertySheet.Task
                    , PropertySheet.Arrow
59
                    , PropertySheet.Price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60 61 62 63 64
                    )

  # Declarative interfaces
  __implements__ = ( )

65
  security.declarePrivate('_setSource')
66
  def _setSource(self, value, portal_type=None):
67 68 69 70
    """ 
      Set the source Account and implicitely the destination Account
    using the source's mirror account.
    """
71
    self._setCategoryMembership('source', value, base=0)
72 73 74
    if self.getPortalType() not in \
            self.getPortalBalanceTransactionLineTypeList() \
            and value not in (None, ''):
75
      source = self.getPortalObject().portal_categories.resolveCategory(value)
76
      destination = self.getDestination()
77 78 79
      if source is not None:
        mirror_list = source.getDestinationList()
      else:
80
        mirror_list = []
81 82 83 84 85
      if len(mirror_list) > 0 and destination not in mirror_list:
        self._setCategoryMembership('destination', mirror_list[0], base=0)
    else:
      # Force to set the destination to None.
      self._setCategoryMembership('destination', None, base=0)
86 87 88

  security.declareProtected(Permissions.ModifyPortalContent, 'setSource')
  def setSource(self, value):
89 90 91 92
    """
      Set the source Account and implicitely the destination Account
    using the source's mirror account, then reindex self.
    """
93 94
    self._setSource(value)
    self.reindexObject()
95
  
96
  security.declarePrivate('_setDestination')
97
  def _setDestination(self, value, portal_type=None):
98 99 100 101 102 103 104
    """
      Set the destination Account and implicitely the source Account
    using the source's mirror account.
    """
    if self.getPortalType() not in \
            self.getPortalBalanceTransactionLineTypeList()\
            and value not in (None, ''):
105
      self._setCategoryMembership('destination', value, base=0)
106 107
      destination = self.getPortalObject().\
                        portal_categories.resolveCategory(value)
108
      source = self.getSource()
109 110 111
      if destination is not None:
        mirror_list = destination.getDestinationList()
      else:
112
        mirror_list = []
113 114 115 116 117
      if len(mirror_list) > 0 and source not in mirror_list:
        self._setCategoryMembership('source', mirror_list[0], base=0)
    else:
      # Force to set the destination to None.
      self._setCategoryMembership('destination', None, base=0)
118 119 120

  security.declareProtected(Permissions.ModifyPortalContent, 'setDestination')
  def setDestination(self, value):
121 122 123 124
    """ 
      Set the destination Account and implicitely the source Account
    using the source's mirror account, then reindex self.
    """
125 126 127 128 129
    self._setDestination(value)
    self.reindexObject()

  security.declarePrivate('_edit')
  def _edit(self, REQUEST = None, force_update = 0, **kw):
130 131 132
    """ 
      Edit the object and set source/destination using magic methods.
    """
133 134
    if kw.has_key('source'):
      self._setSource(kw['source'])
Jérome Perrin's avatar
Jérome Perrin committed
135
    elif kw.has_key('destination') :
136
      self._setDestination(kw['destination'])
137
    DeliveryLine._edit(self, REQUEST=REQUEST, force_update=force_update, **kw)
138

139 140
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoriatedQuantity')
141 142
  def getInventoriatedQuantity(self):
    """
143 144
      Redefine this method here, because AccountingTransactionLine does
      not have target values.
145 146
    """
    return Amount.getInventoriatedQuantity(self)
147 148


149 150
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoriatedStartDate')
151 152 153 154 155 156
  def getInventoriatedStartDate(self):
    """
      Get the start date.
    """
    return self.getStartDate()

157 158
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoriatedStopDate')
159 160 161 162
  def getInventoriatedStopDate(self):
    """
      Get the stop date.
    """
163
    return self.getStopDate()
164
 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
165 166
  # Pricing in standard currency
  security.declareProtected(Permissions.AccessContentsInformation, 'getPrice')
167
  def getPrice(self, context=None):
168
    """
169 170 171 172
      On accounting transaction lines, the price is always set to 1.
      We use the `quantity` property for the default quantity, and the
      converted value for source in getSourceInventoriatedTotalAssetPrice
      and getDestinationInventoriatedTotalAssetPrice for destination.
173
    """
174
    return 1.0 
175

176 177
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getSourceAssetPrice')
178 179
  def getSourceAssetPrice(self):
    """
180 181 182 183 184
      The price is set to 1.0 because we do not want to implement
      automatic currency conversion in accounting. Users must define the
      conversion manually in accounting.  This is required by accounting
      law. One can not account USD (in a EUR based company) without
      defining the equivalent in EUR.
185 186 187
    """
    return 1.0

188 189
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDestinationAssetPrice')
190 191
  def getDestinationAssetPrice(self):
    """
192 193 194 195 196
      The price is set to 1.0 because we do not want to implement
      automatic currency conversion in accounting. Users must define the
      conversion manually in accounting.  This is required by accounting
      law. One can not account USD (in a EUR based company) without
      defining the equivalent in EUR.
197
    """
Jérome Perrin's avatar
Jérome Perrin committed
198
    return 1.0