CIM14/IEC61968/PaymentMetering/CashierShift.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 # IN THE SOFTWARE.
  20
  21 from CIM14.IEC61968.PaymentMetering.Shift import Shift
  22
  23 class CashierShift(Shift):
  24     """The operating shift for a cashier, during which he may transact against the CashierShift, subject to VendorShift being open.
  25     """
  26
  27     def __init__(self, cashFloat=0.0, Receipts=None, Transactions=None, Cashier=None, PointOfSale=None, *args, **kw_args):
  28         """Initialises a new 'CashierShift' instance.
  29
  30         @param cashFloat: The amount of cash that the cashier brings with him to start his shift and that he will take away at the end of his shift; i.e. the cash float does not get banked.
  31         @param Receipts: All Receipts recorded for this Shift.
  32         @param Transactions:
  33         @param Cashier: Cashier operating this shift.
  34         @param PointOfSale: Point of sale that is in operation during this shift.
  35         """
  36         #: The amount of cash that the cashier brings with him to start his shift and that he will take away at the end of his shift; i.e. the cash float does not get banked.
  37         self.cashFloat = cashFloat
  38
  39         self._Receipts = []
  40         self.Receipts = [] if Receipts is None else Receipts
  41
  42         self._Transactions = []
  43         self.Transactions = [] if Transactions is None else Transactions
  44
  45         self._Cashier = None
  46         self.Cashier = Cashier
  47
  48         self._PointOfSale = None
  49         self.PointOfSale = PointOfSale
  50
  51         super(CashierShift, self).__init__(*args, **kw_args)
  52
  53     _attrs = ["cashFloat"]
  54     _attr_types = {"cashFloat": float}
  55     _defaults = {"cashFloat": 0.0}
  56     _enums = {}
  57     _refs = ["Receipts", "Transactions", "Cashier", "PointOfSale"]
  58     _many_refs = ["Receipts", "Transactions"]
  59
  60     def getReceipts(self):
  61         """All Receipts recorded for this Shift.
  62         """
  63         return self._Receipts
  64
  65     def setReceipts(self, value):
  66         for x in self._Receipts:
  67             x.CashierShift = None
  68         for y in value:
  69             y._CashierShift = self
  70         self._Receipts = value
  71
  72     Receipts = property(getReceipts, setReceipts)
  73
  74     def addReceipts(self, *Receipts):
  75         for obj in Receipts:
  76             obj.CashierShift = self
  77
  78     def removeReceipts(self, *Receipts):
  79         for obj in Receipts:
  80             obj.CashierShift = None
  81
  82     def getTransactions(self):
  83
  84         return self._Transactions
  85
  86     def setTransactions(self, value):
  87         for x in self._Transactions:
  88             x.CashierShift = None
  89         for y in value:
  90             y._CashierShift = self
  91         self._Transactions = value
  92
  93     Transactions = property(getTransactions, setTransactions)
  94
  95     def addTransactions(self, *Transactions):
  96         for obj in Transactions:
  97             obj.CashierShift = self
  98
  99     def removeTransactions(self, *Transactions):
 100         for obj in Transactions:
 101             obj.CashierShift = None
 102
 103     def getCashier(self):
 104         """Cashier operating this shift.
 105         """
 106         return self._Cashier
 107
 108     def setCashier(self, value):
 109         if self._Cashier is not None:
 110             filtered = [x for x in self.Cashier.CashierShifts if x != self]
 111             self._Cashier._CashierShifts = filtered
 112
 113         self._Cashier = value
 114         if self._Cashier is not None:
 115             if self not in self._Cashier._CashierShifts:
 116                 self._Cashier._CashierShifts.append(self)
 117
 118     Cashier = property(getCashier, setCashier)
 119
 120     def getPointOfSale(self):
 121         """Point of sale that is in operation during this shift.
 122         """
 123         return self._PointOfSale
 124
 125     def setPointOfSale(self, value):
 126         if self._PointOfSale is not None:
 127             filtered = [x for x in self.PointOfSale.CashierShifts if x != self]
 128             self._PointOfSale._CashierShifts = filtered
 129
 130         self._PointOfSale = value
 131         if self._PointOfSale is not None:
 132             if self not in self._PointOfSale._CashierShifts:
 133                 self._PointOfSale._CashierShifts.append(self)
 134
 135     PointOfSale = property(getPointOfSale, setPointOfSale)
 136