CIM14/IEC61968/PaymentMetering/Receipt.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.IEC61970.Core.IdentifiedObject import IdentifiedObject
  18
  19 class Receipt(IdentifiedObject):
  20     """Record of total receipted payment from customer.
  21     """
  22
  23     def __init__(self, isBankable=False, CashierShift=None, Tenders=None, VendorShift=None, Transactions=None, line=None, *args, **kw_args):
  24         """Initialises a new 'Receipt' instance.
  25
  26         @param isBankable: True if this receipted payment is manually bankable, otherwise it is an electronic funds transfer.
  27         @param CashierShift: Cashier shift during which this receipt was recorded.
  28         @param Tenders: All payments received in the form of tenders recorded by this receipt.
  29         @param VendorShift: Vendor shift during which this receipt was recorded.
  30         @param Transactions: All transactions recorded for this receipted payment.
  31         @param line: Receipted amount with rounding, date and note.
  32         """
  33         #: True if this receipted payment is manually bankable, otherwise it is an electronic funds transfer.
  34         self.isBankable = isBankable
  35
  36         self._CashierShift = None
  37         self.CashierShift = CashierShift
  38
  39         self._Tenders = []
  40         self.Tenders = [] if Tenders is None else Tenders
  41
  42         self._VendorShift = None
  43         self.VendorShift = VendorShift
  44
  45         self._Transactions = []
  46         self.Transactions = [] if Transactions is None else Transactions
  47
  48         self.line = line
  49
  50         super(Receipt, self).__init__(*args, **kw_args)
  51
  52     _attrs = ["isBankable"]
  53     _attr_types = {"isBankable": bool}
  54     _defaults = {"isBankable": False}
  55     _enums = {}
  56     _refs = ["CashierShift", "Tenders", "VendorShift", "Transactions", "line"]
  57     _many_refs = ["Tenders", "Transactions"]
  58
  59     def getCashierShift(self):
  60         """Cashier shift during which this receipt was recorded.
  61         """
  62         return self._CashierShift
  63
  64     def setCashierShift(self, value):
  65         if self._CashierShift is not None:
  66             filtered = [x for x in self.CashierShift.Receipts if x != self]
  67             self._CashierShift._Receipts = filtered
  68
  69         self._CashierShift = value
  70         if self._CashierShift is not None:
  71             if self not in self._CashierShift._Receipts:
  72                 self._CashierShift._Receipts.append(self)
  73
  74     CashierShift = property(getCashierShift, setCashierShift)
  75
  76     def getTenders(self):
  77         """All payments received in the form of tenders recorded by this receipt.
  78         """
  79         return self._Tenders
  80
  81     def setTenders(self, value):
  82         for x in self._Tenders:
  83             x.Receipt = None
  84         for y in value:
  85             y._Receipt = self
  86         self._Tenders = value
  87
  88     Tenders = property(getTenders, setTenders)
  89
  90     def addTenders(self, *Tenders):
  91         for obj in Tenders:
  92             obj.Receipt = self
  93
  94     def removeTenders(self, *Tenders):
  95         for obj in Tenders:
  96             obj.Receipt = None
  97
  98     def getVendorShift(self):
  99         """Vendor shift during which this receipt was recorded.
 100         """
 101         return self._VendorShift
 102
 103     def setVendorShift(self, value):
 104         if self._VendorShift is not None:
 105             filtered = [x for x in self.VendorShift.Receipts if x != self]
 106             self._VendorShift._Receipts = filtered
 107
 108         self._VendorShift = value
 109         if self._VendorShift is not None:
 110             if self not in self._VendorShift._Receipts:
 111                 self._VendorShift._Receipts.append(self)
 112
 113     VendorShift = property(getVendorShift, setVendorShift)
 114
 115     def getTransactions(self):
 116         """All transactions recorded for this receipted payment.
 117         """
 118         return self._Transactions
 119
 120     def setTransactions(self, value):
 121         for x in self._Transactions:
 122             x.Receipt = None
 123         for y in value:
 124             y._Receipt = self
 125         self._Transactions = value
 126
 127     Transactions = property(getTransactions, setTransactions)
 128
 129     def addTransactions(self, *Transactions):
 130         for obj in Transactions:
 131             obj.Receipt = self
 132
 133     def removeTransactions(self, *Transactions):
 134         for obj in Transactions:
 135             obj.Receipt = None
 136
 137     # Receipted amount with rounding, date and note.
 138     line = None
 139