Package CIM14 :: Package IEC61968 :: Package PaymentMetering :: Module VendorShift' :: Class VendorShift
[hide private]
[frames] | no frames]

Class VendorShift

                                  object --+            
                                           |            
                            Element'.Element --+        
                                               |        
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+    
                                                   |    
                                        Shift'.Shift --+
                                                       |
                                                      VendorShift

The operating shift for a vendor during which he may transact against the merchant's account. It aggregates transactions and receipts during the shift and periodically debits a merchant account. The totals in VendorShift should always = sum of totals aggregated in all cashier shifts that were open under the particular vendor shift.

Instance Methods [hide private]
 
__init__(self, merchantDebitAmount=0.0, posted=False, MerchantAccount=None, Transactions=None, Receipts=None, Vendor=None, *args, **kw_args)
Initialises a new 'VendorShift' instance.
 
addReceipts(self, *Receipts)
 
addTransactions(self, *Transactions)
 
getMerchantAccount(self)
Merchant account this vendor shift periodically debits (based on aggregated transactions).
 
getReceipts(self)
 
getTransactions(self)
 
getVendor(self)
Vendor that opens and owns this vendor shift.
 
removeReceipts(self, *Receipts)
 
removeTransactions(self, *Transactions)
 
setMerchantAccount(self, value)
 
setReceipts(self, value)
 
setTransactions(self, value)
 
setVendor(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 = {'merchantDebitAmount': <type 'float'>, 'posted'...
  _attrs = ['merchantDebitAmount', 'posted']
  _defaults = {'merchantDebitAmount': 0.0, 'posted': False}
  _many_refs = ['Transactions', 'Receipts']
  _refs = ['MerchantAccount', 'Transactions', 'Receipts', 'Vendor']

Inherited from Shift'.Shift: activityInterval

Inherited from Element'.Element (private): _enums

Properties [hide private]
  MerchantAccount
Merchant account this vendor shift periodically debits (based on aggregated transactions).
  Receipts
  Transactions
  Vendor
Vendor that opens and owns this vendor shift.

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, merchantDebitAmount=0.0, posted=False, MerchantAccount=None, Transactions=None, Receipts=None, Vendor=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'VendorShift' instance.

Parameters:
  • merchantDebitAmount - The amount that is to be debited from the merchant account for this vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).
  • posted - = true if merchantDebitAmount has been debited from MerchantAccount; typically happens at the end of VendorShift when it closes.
  • MerchantAccount - Merchant account this vendor shift periodically debits (based on aggregated transactions).
  • Transactions
  • Receipts
  • Vendor - Vendor that opens and owns this vendor shift.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'merchantDebitAmount': <type 'float'>, 'posted': <type 'bool'>}

Property Details [hide private]

MerchantAccount

Merchant account this vendor shift periodically debits (based on aggregated transactions).

Get Method:
getMerchantAccount(self) - Merchant account this vendor shift periodically debits (based on aggregated transactions).
Set Method:
setMerchantAccount(self, value)

Receipts

Get Method:
getReceipts(self)
Set Method:
setReceipts(self, value)

Transactions

Get Method:
getTransactions(self)
Set Method:
setTransactions(self, value)

Vendor

Vendor that opens and owns this vendor shift.

Get Method:
getVendor(self) - Vendor that opens and owns this vendor shift.
Set Method:
setVendor(self, value)