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

Class Transaction

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

The record of details of payment for service or token sale.The record of details of payment for service or token sale.

Instance Methods [hide private]
 
__init__(self, donorReference='', kind='other', receiverReference='', serviceUnitsError=0.0, diverseReference='', serviceUnitsEnergy=0.0, reversedId='', PricingStructure=None, line=None, UserAttributes=None, AuxiliaryAccount=None, VendorShift=None, Receipt=None, Meter=None, CustomerAccount=None, CashierShift=None, *args, **kw_args)
Initialises a new 'Transaction' instance.
 
addUserAttributes(self, *UserAttributes)
 
getAuxiliaryAccount(self)
Auxiliary account for this payment transaction.
 
getCashierShift(self)
Cashier shift during which this transaction was recorded.
 
getCustomerAccount(self)
Customer account for this payment transaction.
 
getMeter(self)
Meter for this vending transaction.
 
getPricingStructure(self)
Pricing structure applicable for this transaction.
 
getReceipt(self)
The receipted payment for which this transaction has been recorded.
 
getUserAttributes(self)
All snapshots of meter parameters recorded at the time of this transaction.
 
getVendorShift(self)
Vendor shift during which this transaction was recorded.
 
removeUserAttributes(self, *UserAttributes)
 
setAuxiliaryAccount(self, value)
 
setCashierShift(self, value)
 
setCustomerAccount(self, value)
 
setMeter(self, value)
 
setPricingStructure(self, value)
 
setReceipt(self, value)
 
setUserAttributes(self, value)
 
setVendorShift(self, value)

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

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

Class Variables [hide private]
  _attr_types = {'diverseReference': <type 'str'>, 'donorReferen...
  _attrs = ['donorReference', 'kind', 'receiverReference', 'serv...
  _defaults = {'diverseReference': '', 'donorReference': '', 'ki...
  _enums = {'kind': 'TransactionKind'}
  _many_refs = ['UserAttributes']
  _refs = ['PricingStructure', 'line', 'UserAttributes', 'Auxili...
  line = None
Properties [hide private]
  AuxiliaryAccount
Auxiliary account for this payment transaction.
  CashierShift
Cashier shift during which this transaction was recorded.
  CustomerAccount
Customer account for this payment transaction.
  Meter
Meter for this vending transaction.
  PricingStructure
Pricing structure applicable for this transaction.
  Receipt
The receipted payment for which this transaction has been recorded.
  UserAttributes
All snapshots of meter parameters recorded at the time of this transaction.
  VendorShift
Vendor shift during which this transaction was recorded.

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, donorReference='', kind='other', receiverReference='', serviceUnitsError=0.0, diverseReference='', serviceUnitsEnergy=0.0, reversedId='', PricingStructure=None, line=None, UserAttributes=None, AuxiliaryAccount=None, VendorShift=None, Receipt=None, Meter=None, CustomerAccount=None, CashierShift=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Transaction' instance.

Parameters:
  • donorReference - Reference to the entity that is the source of 'amount' (for example: customer for token purchase; or supplier for free issue token).
  • kind - Kind of transaction. Values are: "other", "serviceChargePayment", "accountPayment", "tokenSalePayment", "tokenCancellation", "taxChargePayment", "tokenExchange", "tokenGrant", "diversePayment", "auxiliaryChargePayment", "meterConfigurationToken", "tokenFreeIssue", "transactionReversal"
  • receiverReference - Reference to the entity that is the recipient of 'amount' (for example, supplier for service charge payment; or tax receiver for VAT).
  • serviceUnitsError - Number of service units not reflected in 'serviceUnitsEnergy' due to process rounding or truncating errors.
  • diverseReference - Formal reference for use with diverse payment (traffic fine for example).
  • serviceUnitsEnergy - Actual amount of service units that is being paid for.
  • reversedId - (if 'kind' is transactionReversal) Reference to the original transaction that is being reversed by this transaction.
  • PricingStructure - Pricing structure applicable for this transaction.
  • line - Transaction amount, rounding, date and note for this transaction line.
  • UserAttributes - All snapshots of meter parameters recorded at the time of this transaction. Use 'name' and 'value.value' attributes to specify name and value of a parameter from meter.
  • AuxiliaryAccount - Auxiliary account for this payment transaction.
  • VendorShift - Vendor shift during which this transaction was recorded.
  • Receipt - The receipted payment for which this transaction has been recorded.
  • Meter - Meter for this vending transaction.
  • CustomerAccount - Customer account for this payment transaction.
  • CashierShift - Cashier shift during which this transaction was recorded.
Overrides: object.__init__

getUserAttributes(self)

 

All snapshots of meter parameters recorded at the time of this transaction. Use 'name' and 'value.value' attributes to specify name and value of a parameter from meter.


Class Variable Details [hide private]

_attr_types

Value:
{'diverseReference': <type 'str'>,
 'donorReference': <type 'str'>,
 'kind': <type 'str'>,
 'receiverReference': <type 'str'>,
 'reversedId': <type 'str'>,
 'serviceUnitsEnergy': <type 'float'>,
 'serviceUnitsError': <type 'float'>}

_attrs

Value:
['donorReference',
 'kind',
 'receiverReference',
 'serviceUnitsError',
 'diverseReference',
 'serviceUnitsEnergy',
 'reversedId']

_defaults

Value:
{'diverseReference': '',
 'donorReference': '',
 'kind': 'other',
 'receiverReference': '',
 'reversedId': '',
 'serviceUnitsEnergy': 0.0,
 'serviceUnitsError': 0.0}

_refs

Value:
['PricingStructure',
 'line',
 'UserAttributes',
 'AuxiliaryAccount',
 'VendorShift',
 'Receipt',
 'Meter',
 'CustomerAccount',
...

Property Details [hide private]

AuxiliaryAccount

Auxiliary account for this payment transaction.

Get Method:
getAuxiliaryAccount(self) - Auxiliary account for this payment transaction.
Set Method:
setAuxiliaryAccount(self, value)

CashierShift

Cashier shift during which this transaction was recorded.

Get Method:
getCashierShift(self) - Cashier shift during which this transaction was recorded.
Set Method:
setCashierShift(self, value)

CustomerAccount

Customer account for this payment transaction.

Get Method:
getCustomerAccount(self) - Customer account for this payment transaction.
Set Method:
setCustomerAccount(self, value)

Meter

Meter for this vending transaction.

Get Method:
getMeter(self) - Meter for this vending transaction.
Set Method:
setMeter(self, value)

PricingStructure

Pricing structure applicable for this transaction.

Get Method:
getPricingStructure(self) - Pricing structure applicable for this transaction.
Set Method:
setPricingStructure(self, value)

Receipt

The receipted payment for which this transaction has been recorded.

Get Method:
getReceipt(self) - The receipted payment for which this transaction has been recorded.
Set Method:
setReceipt(self, value)

UserAttributes

All snapshots of meter parameters recorded at the time of this transaction. Use 'name' and 'value.value' attributes to specify name and value of a parameter from meter.

Get Method:
getUserAttributes(self) - All snapshots of meter parameters recorded at the time of this transaction.
Set Method:
setUserAttributes(self, value)

VendorShift

Vendor shift during which this transaction was recorded.

Get Method:
getVendorShift(self) - Vendor shift during which this transaction was recorded.
Set Method:
setVendorShift(self, value)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Jul 2 18:27:43 2011 http://epydoc.sourceforge.net