Trees       Indices       Help   
PyCIM
Package CIM14 :: Package IEC61968 :: Package PaymentMetering :: Module Tender' :: Class Tender
[hide private]
[frames] | no frames]

Class Tender

                                  object --+        
                                           |        
                            Element'.Element --+    
                                               |    
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+
                                                   |
                                                  Tender

Tender is what is 'offered' by the customer towards making a payment and is often more than the required payment (hence the need for 'change'). The payment is thus that part of the Tender that goes towards settlement of a particular transaction. Tender is modelled as an aggregation of Cheque and Card. Both these tender types can exist in a single tender bid thus 'accountHolderName' must exist separately in each of Cheque and Card as each could have a different account holder name.

Instance Methods [hide private]
 
__init__(self, kind='cash', amount=0.0, change=0.0, Cheque=None, Receipt=None, Card=None, *args, **kw_args)
Initialises a new 'Tender' instance.
 
getCard(self)
Card used to tender payment.
 
getCheque(self)
Cheque used to tender payment.
 
getReceipt(self)
Receipt that recorded this receiving of a payment in the form of tenders.
 
setCard(self, value)
 
setCheque(self, value)
 
setReceipt(self, value)

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'amount': <type 'float'>, 'change': <type 'floa...
  _attrs = ['kind', 'amount', 'change']
  _defaults = {'amount': 0.0, 'change': 0.0, 'kind': 'cash'}
  _enums = {'kind': 'TenderKind'}
  _refs = ['Cheque', 'Receipt', 'Card']

Inherited from Element'.Element (private): _many_refs

Properties [hide private]
  Card
Card used to tender payment.
  Cheque
Cheque used to tender payment.
  Receipt
Receipt that recorded this receiving of a payment in the form of tenders.

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details [hide private]

__init__(self, kind='cash', amount=0.0, change=0.0, Cheque=None, Receipt=None, Card=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Tender' instance.

Parameters:
  • kind - Kind of tender from customer. Values are: "cash", "unspecified", "card", "other", "cheque"
  • amount - Amount tendered by customer.
  • change - Difference between amount tendered by customer and the amount charged by point of sale.
  • Cheque - Cheque used to tender payment.
  • Receipt - Receipt that recorded this receiving of a payment in the form of tenders.
  • Card - Card used to tender payment.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'amount': <type 'float'>,
 'change': <type 'float'>,
 'kind': <type 'str'>}

Property Details [hide private]

Card

Card used to tender payment.

Get Method:
getCard(self) - Card used to tender payment.
Set Method:
setCard(self, value)

Cheque

Cheque used to tender payment.

Get Method:
getCheque(self) - Cheque used to tender payment.
Set Method:
setCheque(self, value)

Receipt

Receipt that recorded this receiving of a payment in the form of tenders.

Get Method:
getReceipt(self) - Receipt that recorded this receiving of a payment in the form of tenders.
Set Method:
setReceipt(self, value)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Nov 13 22:18:06 2010 http://epydoc.sourceforge.net