Package CIM14 :: Package IEC61968 :: Package PaymentMetering :: Module MerchantAccount' :: Class MerchantAccount

Class MerchantAccount

                                  object --+            
                                           |            
                            Element'.Element --+        
                                               |        
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+    
                                                   |    
                           Common.Document'.Document --+
                                                       |
                                                      MerchantAccount

The operating account controlled by MerchantAgreement, against which Vendor may vend tokens or receipt payments. Transactions via VendorShift debit the account and bank deposits via BankStatement credit the account.

Instance Methods

[hide private]

__init__(self, provisionalBalance=0.0, currentBalance=0.0, VendorShifts=None, MerchantAgreement=None, Vendors=None, Transactors=None, *args, **kw_args)
Initialises a new 'MerchantAccount' instance.

addTransactors(self, *Transactors)

addVendorShifts(self, *VendorShifts)

addVendors(self, *Vendors)

getMerchantAgreement(self)
Merchant agreement that instantiated this merchant account.

getTransactors(self)
All transactors this merchant account is registered with.

getVendorShifts(self)
All vendor shifts that operate on this merchant account.

getVendors(self)
All vendors selling tokens or receipt payments against this merchant account.

removeTransactors(self, *Transactors)

removeVendorShifts(self, *VendorShifts)

removeVendors(self, *Vendors)

setMerchantAgreement(self, value)

setTransactors(self, value)

setVendorShifts(self, value)

setVendors(self, value)

Inherited from Common.Document'.Document: addActivityRecords, addMeasurements, getActivityRecords, getMeasurements, removeActivityRecords, removeMeasurements, setActivityRecords, setMeasurements

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 = {'currentBalance': <type 'float'>, 'provisionalB...

_attrs = ['provisionalBalance', 'currentBalance']

_defaults = {'currentBalance': 0.0, 'provisionalBalance': 0.0}

_many_refs = ['VendorShifts', 'Vendors', 'Transactors']

_refs = ['VendorShifts', 'MerchantAgreement', 'Vendors', 'Tran...

Inherited from Common.Document'.Document: docStatus, electronicAddress, status

Inherited from Element'.Element (private): _enums

Properties

[hide private]

MerchantAgreement
Merchant agreement that instantiated this merchant account.

Transactors
All transactors this merchant account is registered with.

VendorShifts
All vendor shifts that operate on this merchant account.

Vendors
All vendors selling tokens or receipt payments against this merchant account.

Inherited from Common.Document'.Document: ActivityRecords, Measurements

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

Inherited from object: __class__

Method Details

[hide private]

init(self, provisionalBalance=0.0, currentBalance=0.0, VendorShifts=None, MerchantAgreement=None, Vendors=None, Transactors=None, *args, **kw_args)
(Constructor)

Initialises a new 'MerchantAccount' instance.

Parameters:

provisionalBalance - The balance of this account after taking into account any pending debits from VendorShift.merchantDebitAmount and pending credits from BankStatement.merchantCreditAmount or credits (see also BankStatement attributes and VendorShift attributes).
currentBalance - The current operating balance of this account.
VendorShifts - All vendor shifts that operate on this merchant account.
MerchantAgreement - Merchant agreement that instantiated this merchant account.
Vendors - All vendors selling tokens or receipt payments against this merchant account.
Transactors - All transactors this merchant account is registered with.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'currentBalance': <type 'float'>,
 'provisionalBalance': <type 'float'>}

_refs

Value:

['VendorShifts', 'MerchantAgreement', 'Vendors', 'Transactors']

Property Details

[hide private]

MerchantAgreement

Merchant agreement that instantiated this merchant account.

Get Method:: getMerchantAgreement(self) - Merchant agreement that instantiated this merchant account.
Set Method:: setMerchantAgreement(self, value)

Transactors

All transactors this merchant account is registered with.

Get Method:: getTransactors(self) - All transactors this merchant account is registered with.
Set Method:: setTransactors(self, value)

VendorShifts

All vendor shifts that operate on this merchant account.

Get Method:: getVendorShifts(self) - All vendor shifts that operate on this merchant account.
Set Method:: setVendorShifts(self, value)

Vendors

All vendors selling tokens or receipt payments against this merchant account.

Get Method:: getVendors(self) - All vendors selling tokens or receipt payments against this merchant account.
Set Method:: setVendors(self, value)

Class MerchantAccount

__init__(self, provisionalBalance=0.0, currentBalance=0.0, VendorShifts=None, MerchantAgreement=None, Vendors=None, Transactors=None, *args, **kw_args) (Constructor)

_attr_types

_refs

MerchantAgreement

Transactors

VendorShifts

Vendors

init(self, provisionalBalance=0.0, currentBalance=0.0, VendorShifts=None, MerchantAgreement=None, Vendors=None, Transactors=None, *args, **kw_args)
(Constructor)