Package CIM15 :: 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 service supplier to pay for service at a specific service location. It records certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.Agreement between the customer and the service supplier to pay for service at a specific service location. It records certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.

Instance Methods

[hide private]

__init__(self, billingCycle='', loadMgmt='', budgetBill='', PricingStructures=None, CustomerAccount=None, StandardIndustryCode=None, AuxiliaryAgreements=None, MeterReadings=None, Equipments=None, ServiceSupplier=None, ServiceLocations=None, DemandResponseProgram=None, ServiceDeliveryPoints=None, Customer=None, EndDeviceControls=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.

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.

getStandardIndustryCode(self)

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)

setServiceDeliveryPoints(self, value)

setServiceLocations(self, value)

setServiceSupplier(self, value)

setStandardIndustryCode(self, value)

Inherited from Common.Document'.Document: addActivityRecords, addAssetRoles, addChangeItems, addChangeSets, addErpOrganisationRoles, addErpPersonRoles, addFromDocumentRoles, addMeasurements, addNetworkDataSets, addPowerSystemResourceRoles, addScheduleParameterInfos, addScheduledEvents, addToDocumentRoles, getActivityRecords, getAssetRoles, getChangeItems, getChangeSets, getErpOrganisationRoles, getErpPersonRoles, getFromDocumentRoles, getMeasurements, getNetworkDataSets, getPowerSystemResourceRoles, getScheduleParameterInfos, getScheduledEvents, getToDocumentRoles, removeActivityRecords, removeAssetRoles, removeChangeItems, removeChangeSets, removeErpOrganisationRoles, removeErpPersonRoles, removeFromDocumentRoles, removeMeasurements, removeNetworkDataSets, removePowerSystemResourceRoles, removeScheduleParameterInfos, removeScheduledEvents, removeToDocumentRoles, setActivityRecords, setAssetRoles, setChangeItems, setChangeSets, setErpOrganisationRoles, setErpPersonRoles, setFromDocumentRoles, setMeasurements, setNetworkDataSets, setPowerSystemResourceRoles, setScheduleParameterInfos, setScheduledEvents, setToDocumentRoles

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

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

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

_many_refs = ['PricingStructures', 'AuxiliaryAgreements', 'Met...

_refs = ['PricingStructures', 'CustomerAccount', 'StandardIndu...

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.

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.

StandardIndustryCode

Inherited from Common.Document'.Document: ActivityRecords, AssetRoles, ChangeItems, ChangeSets, ErpOrganisationRoles, ErpPersonRoles, FromDocumentRoles, Measurements, NetworkDataSets, PowerSystemResourceRoles, ScheduleParameterInfos, ScheduledEvents, ToDocumentRoles

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

Inherited from object: __class__

Method Details

[hide private]

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

Initialises a new 'CustomerAgreement' instance.

Parameters:

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

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',
 'AuxiliaryAgreements',
 'MeterReadings',
 'Equipments',
 'ServiceLocations',
 'ServiceDeliveryPoints',
 'EndDeviceControls']

_refs

Value:

['PricingStructures',
 'CustomerAccount',
 'StandardIndustryCode',
 'AuxiliaryAgreements',
 'MeterReadings',
 'Equipments',
 'ServiceSupplier',
 'ServiceLocations',
...

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)

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)

StandardIndustryCode

Get Method:: getStandardIndustryCode(self)
Set Method:: setStandardIndustryCode(self, value)