Update README.rst
[PyCIM.git] / CIM14 / IEC61968 / PaymentMetering / Card.py
blob947bff2c563793e2b56c2a10800b6c12b8b8f6f4
1 # Copyright (C) 2010-2011 Richard Lincoln
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:
10 # The above copyright notice and this permission notice shall be included in
11 # all copies or substantial portions of the Software.
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.
21 from CIM14.Element import Element
23 class Card(Element):
24 """Documentation of the tender when it is a type of card (credit, debit, etc).
25 """
27 def __init__(self, pan='', expiryDate='', cvNumber='', accountHolderName='', Tender=None, *args, **kw_args):
28 """Initialises a new 'Card' instance.
30 @param pan: The primary account number.
31 @param expiryDate: The date when this card expires.
32 @param cvNumber: The card verification number.
33 @param accountHolderName: Name of account holder.
34 @param Tender: Payment tender this card is being used for.
35 """
36 #: The primary account number.
37 self.pan = pan
39 #: The date when this card expires.
40 self.expiryDate = expiryDate
42 #: The card verification number.
43 self.cvNumber = cvNumber
45 #: Name of account holder.
46 self.accountHolderName = accountHolderName
48 self._Tender = None
49 self.Tender = Tender
51 super(Card, self).__init__(*args, **kw_args)
53 _attrs = ["pan", "expiryDate", "cvNumber", "accountHolderName"]
54 _attr_types = {"pan": str, "expiryDate": str, "cvNumber": str, "accountHolderName": str}
55 _defaults = {"pan": '', "expiryDate": '', "cvNumber": '', "accountHolderName": ''}
56 _enums = {}
57 _refs = ["Tender"]
58 _many_refs = []
60 def getTender(self):
61 """Payment tender this card is being used for.
62 """
63 return self._Tender
65 def setTender(self, value):
66 if self._Tender is not None:
67 self._Tender._Card = None
69 self._Tender = value
70 if self._Tender is not None:
71 self._Tender.Card = None
72 self._Tender._Card = self
74 Tender = property(getTender, setTender)