Package CIM14 :: Package IEC61968 :: Package Customers :: Module CustomerAgreement' :: Class CustomerAgreement

Class CustomerAgreement

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

Agreement between the Customer and the ServiceSupplier to pay for service at a specific ServiceLocation. It records certain billing information about the type of service provided at the ServiceLocation and is used during charge creation to determine the type of service.

Instance Methods

[hide private]

__init__(self, loadMgmt='', budgetBill='', billingCycle='', DemandResponseProgram=None, ServiceSupplier=None, PricingStructures=None, ServiceLocations=None, ServiceCategory=None, MeterReadings=None, CustomerAccount=None, AuxiliaryAgreements=None, EndDeviceControls=None, Customer=None, ServiceDeliveryPoints=None, Equipments=None, *args, **kw_args)
Initialises a new 'CustomerAgreement' instance.

addAuxiliaryAgreements(self, *AuxiliaryAgreements)

addEndDeviceControls(self, *EndDeviceControls)

addEquipments(self, *Equipments)

addMeterReadings(self, *MeterReadings)

addPricingStructures(self, *PricingStructures)

addServiceDeliveryPoints(self, *ServiceDeliveryPoints)

addServiceLocations(self, *ServiceLocations)

getAuxiliaryAgreements(self)
All (non-service related) auxiliary agreements that refer to this customer agreement.

getCustomer(self)
Customer for this agreement.

getCustomerAccount(self)
Customer account owning this agreement.

getDemandResponseProgram(self)
Demand response program for this customer agreement.

getEndDeviceControls(self)
Could be deprecated in the future.

getEquipments(self)

getMeterReadings(self)
(could be deprecated in the future) All meter readings for this customer agreement.

getPricingStructures(self)
All pricing structures applicable to this customer agreement.

getServiceCategory(self)

getServiceDeliveryPoints(self)
All service delivery points regulated by this customer agreement.

getServiceLocations(self)
All service locations regulated by this customer agreement.

getServiceSupplier(self)
Service supplier for this customer agreement.

removeAuxiliaryAgreements(self, *AuxiliaryAgreements)

removeEndDeviceControls(self, *EndDeviceControls)

removeEquipments(self, *Equipments)

removeMeterReadings(self, *MeterReadings)

removePricingStructures(self, *PricingStructures)

removeServiceDeliveryPoints(self, *ServiceDeliveryPoints)

removeServiceLocations(self, *ServiceLocations)

setAuxiliaryAgreements(self, value)

setCustomer(self, value)

setCustomerAccount(self, value)

setDemandResponseProgram(self, value)

setEndDeviceControls(self, value)

setEquipments(self, value)

setMeterReadings(self, value)

setPricingStructures(self, value)

setServiceCategory(self, value)

setServiceDeliveryPoints(self, value)

setServiceLocations(self, value)

setServiceSupplier(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 = {'billingCycle': <type 'str'>, 'budgetBill': <ty...

_attrs = ['loadMgmt', 'budgetBill', 'billingCycle']

_defaults = {'billingCycle': '', 'budgetBill': '', 'loadMgmt':...

_many_refs = ['PricingStructures', 'ServiceLocations', 'MeterR...

_refs = ['DemandResponseProgram', 'ServiceSupplier', 'PricingS...

Inherited from Common.Agreement'.Agreement: validityInterval

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

Inherited from Element'.Element (private): _enums

Properties

[hide private]

AuxiliaryAgreements
All (non-service related) auxiliary agreements that refer to this customer agreement.

Customer
Customer for this agreement.

CustomerAccount
Customer account owning this agreement.

DemandResponseProgram
Demand response program for this customer agreement.

EndDeviceControls
Could be deprecated in the future.

Equipments

MeterReadings
(could be deprecated in the future) All meter readings for this customer agreement.

PricingStructures
All pricing structures applicable to this customer agreement.

ServiceCategory

ServiceDeliveryPoints
All service delivery points regulated by this customer agreement.

ServiceLocations
All service locations regulated by this customer agreement.

ServiceSupplier
Service supplier for this customer agreement.

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

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

Inherited from object: __class__

Method Details

[hide private]

init(self, loadMgmt=`''`, budgetBill=`''`, billingCycle=`''`, DemandResponseProgram=None, ServiceSupplier=None, PricingStructures=None, ServiceLocations=None, ServiceCategory=None, MeterReadings=None, CustomerAccount=None, AuxiliaryAgreements=None, EndDeviceControls=None, Customer=None, ServiceDeliveryPoints=None, Equipments=None, *args, **kw_args)
(Constructor)

Initialises a new 'CustomerAgreement' instance.

Parameters:

loadMgmt - Load management code.
budgetBill - Budget bill code.
billingCycle - Cycle day on which the associated customer account will normally be billed, used to determine when to produce the billing.
DemandResponseProgram - Demand response program for this customer agreement.
ServiceSupplier - Service supplier for this customer agreement.
PricingStructures - All pricing structures applicable to this customer agreement.
ServiceLocations - All service locations regulated by this customer agreement.
ServiceCategory
MeterReadings - (could be deprecated in the future) All meter readings for this customer agreement.
CustomerAccount - Customer account owning this agreement.
AuxiliaryAgreements - All (non-service related) auxiliary agreements that refer to this customer agreement.
EndDeviceControls - Could be deprecated in the future.
Customer - Customer for this agreement.
ServiceDeliveryPoints - All service delivery points regulated by this customer agreement.
Equipments

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'billingCycle': <type 'str'>,
 'budgetBill': <type 'str'>,
 'loadMgmt': <type 'str'>}

_defaults

Value:

{'billingCycle': '', 'budgetBill': '', 'loadMgmt': ''}

_many_refs

Value:

['PricingStructures',
 'ServiceLocations',
 'MeterReadings',
 'AuxiliaryAgreements',
 'EndDeviceControls',
 'ServiceDeliveryPoints',
 'Equipments']

_refs

Value:

['DemandResponseProgram',
 'ServiceSupplier',
 'PricingStructures',
 'ServiceLocations',
 'ServiceCategory',
 'MeterReadings',
 'CustomerAccount',
 'AuxiliaryAgreements',
...

Property Details

[hide private]

AuxiliaryAgreements

All (non-service related) auxiliary agreements that refer to this customer agreement.

Get Method:: getAuxiliaryAgreements(self) - All (non-service related) auxiliary agreements that refer to this customer agreement.
Set Method:: setAuxiliaryAgreements(self, value)

Customer

Customer for this agreement.

Get Method:: getCustomer(self) - Customer for this agreement.
Set Method:: setCustomer(self, value)

CustomerAccount

Customer account owning this agreement.

Get Method:: getCustomerAccount(self) - Customer account owning this agreement.
Set Method:: setCustomerAccount(self, value)

DemandResponseProgram

Demand response program for this customer agreement.

Get Method:: getDemandResponseProgram(self) - Demand response program for this customer agreement.
Set Method:: setDemandResponseProgram(self, value)

EndDeviceControls

Could be deprecated in the future.

Get Method:: getEndDeviceControls(self) - Could be deprecated in the future.
Set Method:: setEndDeviceControls(self, value)

Equipments

Get Method:: getEquipments(self)
Set Method:: setEquipments(self, value)

MeterReadings

(could be deprecated in the future) All meter readings for this customer agreement.

Get Method:: getMeterReadings(self) - (could be deprecated in the future) All meter readings for this customer agreement.
Set Method:: setMeterReadings(self, value)

PricingStructures

All pricing structures applicable to this customer agreement.

Get Method:: getPricingStructures(self) - All pricing structures applicable to this customer agreement.
Set Method:: setPricingStructures(self, value)

ServiceCategory

Get Method:: getServiceCategory(self)
Set Method:: setServiceCategory(self, value)

ServiceDeliveryPoints

All service delivery points regulated by this customer agreement.

Get Method:: getServiceDeliveryPoints(self) - All service delivery points regulated by this customer agreement.
Set Method:: setServiceDeliveryPoints(self, value)

ServiceLocations

All service locations regulated by this customer agreement.

Get Method:: getServiceLocations(self) - All service locations regulated by this customer agreement.
Set Method:: setServiceLocations(self, value)

ServiceSupplier

Service supplier for this customer agreement.

Get Method:: getServiceSupplier(self) - Service supplier for this customer agreement.
Set Method:: setServiceSupplier(self, value)