AccountingTransactionLine.py 5.32 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
60
                    , PropertySheet.AccountingTransactionLine
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61 62 63 64 65
                    )

  # Declarative interfaces
  __implements__ = ( )

66 67
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoriatedQuantity')
68 69
  def getInventoriatedQuantity(self):
    """
70 71
      Redefine this method here, because AccountingTransactionLine does
      not have target values.
72 73
    """
    return Amount.getInventoriatedQuantity(self)
74 75


76 77
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoriatedStartDate')
78 79 80 81 82 83
  def getInventoriatedStartDate(self):
    """
      Get the start date.
    """
    return self.getStartDate()

84 85
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getInventoriatedStopDate')
86 87 88 89
  def getInventoriatedStopDate(self):
    """
      Get the stop date.
    """
90
    return self.getStopDate()
91
 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
92 93
  # Pricing in standard currency
  security.declareProtected(Permissions.AccessContentsInformation, 'getPrice')
94
  def getPrice(self, context=None):
95
    """
96 97 98 99
      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.
100
    """
101
    return 1.0 
102

103 104
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getSourceAssetPrice')
105 106
  def getSourceAssetPrice(self):
    """
107 108 109 110 111
      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.
112 113 114
    """
    return 1.0

115 116
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getDestinationAssetPrice')
117 118
  def getDestinationAssetPrice(self):
    """
119 120 121 122 123
      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.
124
    """
Jérome Perrin's avatar
Jérome Perrin committed
125
    return 1.0
126 127 128 129 130 131 132 133 134 135 136 137

  security.declareProtected(Permissions.AccessContentsInformation,
                            'setGroupingReference')
  def setGroupingReference(self, value):
    # Sets the grouping reference.
    # This method is redefined here to override security definition.
    # In the case of an accounting transaction line, we want to be able to 
    # set a grouping reference on a line after the point where we remove the
    # Modify portal content permission, as long as this method cannot be called
    # directly from the URL, that's why this method is without docstring.
    self._baseSetGroupingReference(value)
    self.reindexObject()