au.org.consumerdatastandards.holder.model.energy

Class EnergyServicePointDetail

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyServicePointDetail

public class EnergyServicePointDetail
extends Object

EnergyServicePointDetail

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyServicePointDetail.JurisdictionCodeEnum Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point.
static class	EnergyServicePointDetail.ServicePointClassificationEnum The classification of the service point as defined in MSATS procedures
static class	EnergyServicePointDetail.ServicePointStatusEnum Code used to indicate the status of the service point.

Constructor Summary

Constructors

Constructor and Description
EnergyServicePointDetail()

Method Summary

Modifier and Type	Method and Description
EnergyServicePointDetail	addRelatedParticipantsItem(EnergyServicePointDetailRelatedParticipants relatedParticipantsItem)
EnergyServicePointDetail	consumerProfile(EnergyServicePointConsumerProfile consumerProfile)
EnergyServicePointDetail	distributionLossFactor(EnergyServicePointDetailDistributionLossFactor distributionLossFactor)
boolean	equals(Object o)
@Valid EnergyServicePointConsumerProfile	getConsumerProfile() Get consumerProfile
@NotNull @Valid EnergyServicePointDetailDistributionLossFactor	getDistributionLossFactor() Get distributionLossFactor
Boolean	getIsGenerator() This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit(this may include generator auxiliary loads).
@NotNull EnergyServicePointDetail.JurisdictionCodeEnum	getJurisdictionCode() Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point.
@NotNull java.time.OffsetDateTime	getLastUpdateDateTime() The date and time that the information for this service point was modified
@NotNull @Valid CommonPhysicalAddress	getLocation() Get location
@Valid EnergyServicePointDetailMeters	getMeters() The meters associated with the service point.
@NotNull String	getNationalMeteringId() The independent ID of the service point, known in the industry as the NMI
@NotNull @Valid List<EnergyServicePointDetailRelatedParticipants>	getRelatedParticipants() Get relatedParticipants
@NotNull EnergyServicePointDetail.ServicePointClassificationEnum	getServicePointClassification() The classification of the service point as defined in MSATS procedures
@NotNull String	getServicePointId() The tokenised ID of the service point for use in the CDR APIs.
@NotNull EnergyServicePointDetail.ServicePointStatusEnum	getServicePointStatus() Code used to indicate the status of the service point.
java.time.LocalDate	getValidFromDate() The latest start date from which the constituent data sets of this service point became valid
int	hashCode()
EnergyServicePointDetail	isGenerator(Boolean isGenerator)
EnergyServicePointDetail	jurisdictionCode(EnergyServicePointDetail.JurisdictionCodeEnum jurisdictionCode)
EnergyServicePointDetail	lastUpdateDateTime(java.time.OffsetDateTime lastUpdateDateTime)
EnergyServicePointDetail	location(CommonPhysicalAddress location)
EnergyServicePointDetail	meters(EnergyServicePointDetailMeters meters)
EnergyServicePointDetail	nationalMeteringId(String nationalMeteringId)
EnergyServicePointDetail	relatedParticipants(List<EnergyServicePointDetailRelatedParticipants> relatedParticipants)
EnergyServicePointDetail	servicePointClassification(EnergyServicePointDetail.ServicePointClassificationEnum servicePointClassification)
EnergyServicePointDetail	servicePointId(String servicePointId)
EnergyServicePointDetail	servicePointStatus(EnergyServicePointDetail.ServicePointStatusEnum servicePointStatus)
void	setConsumerProfile(EnergyServicePointConsumerProfile consumerProfile)
void	setDistributionLossFactor(EnergyServicePointDetailDistributionLossFactor distributionLossFactor)
void	setIsGenerator(Boolean isGenerator)
void	setJurisdictionCode(EnergyServicePointDetail.JurisdictionCodeEnum jurisdictionCode)
void	setLastUpdateDateTime(java.time.OffsetDateTime lastUpdateDateTime)
void	setLocation(CommonPhysicalAddress location)
void	setMeters(EnergyServicePointDetailMeters meters)
void	setNationalMeteringId(String nationalMeteringId)
void	setRelatedParticipants(List<EnergyServicePointDetailRelatedParticipants> relatedParticipants)
void	setServicePointClassification(EnergyServicePointDetail.ServicePointClassificationEnum servicePointClassification)
void	setServicePointId(String servicePointId)
void	setServicePointStatus(EnergyServicePointDetail.ServicePointStatusEnum servicePointStatus)
void	setValidFromDate(java.time.LocalDate validFromDate)
String	toString()
EnergyServicePointDetail	validFromDate(java.time.LocalDate validFromDate)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnergyServicePointDetail

public EnergyServicePointDetail()

Method Detail

servicePointId

public EnergyServicePointDetail servicePointId(String servicePointId)

getServicePointId

@NotNull
public @NotNull String getServicePointId()

The tokenised ID of the service point for use in the CDR APIs. Created according to the CDR rules for ID permanence

Returns:

servicePointId

setServicePointId

public void setServicePointId(String servicePointId)

nationalMeteringId

public EnergyServicePointDetail nationalMeteringId(String nationalMeteringId)

getNationalMeteringId

@NotNull
public @NotNull String getNationalMeteringId()

The independent ID of the service point, known in the industry as the NMI

Returns:

nationalMeteringId

setNationalMeteringId

public void setNationalMeteringId(String nationalMeteringId)

servicePointClassification

public EnergyServicePointDetail servicePointClassification(EnergyServicePointDetail.ServicePointClassificationEnum servicePointClassification)

getServicePointClassification

@NotNull
public @NotNull EnergyServicePointDetail.ServicePointClassificationEnum getServicePointClassification()

The classification of the service point as defined in MSATS procedures

Returns:

servicePointClassification

setServicePointClassification

public void setServicePointClassification(EnergyServicePointDetail.ServicePointClassificationEnum servicePointClassification)

servicePointStatus

public EnergyServicePointDetail servicePointStatus(EnergyServicePointDetail.ServicePointStatusEnum servicePointStatus)

getServicePointStatus

@NotNull
public @NotNull EnergyServicePointDetail.ServicePointStatusEnum getServicePointStatus()

Code used to indicate the status of the service point. Note the details for the enumeration values below:

• **ACTIVE** - An active, energised, service point
• **DE_ENERGISED** - The service point exists but is deenergised
• **EXTINCT** - The service point has been permanently decommissioned
• **GREENFIELD** - Applies to a service point that has never been energised
• **OFF_MARKET** - Applies when the service point is no longer settled in the NEM

Returns:

servicePointStatus

setServicePointStatus

public void setServicePointStatus(EnergyServicePointDetail.ServicePointStatusEnum servicePointStatus)

jurisdictionCode

public EnergyServicePointDetail jurisdictionCode(EnergyServicePointDetail.JurisdictionCodeEnum jurisdictionCode)

getJurisdictionCode

@NotNull
public @NotNull EnergyServicePointDetail.JurisdictionCodeEnum getJurisdictionCode()

Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:

• **ALL** - All Jurisdictions
• **ACT** - Australian Capital Territory
• **NEM** - National Electricity Market
• **NSW** - New South Wales
• **QLD** - Queensland
• **SA** - South Australia
• **TAS** - Tasmania
• **VIC** - Victoria

Returns:

jurisdictionCode

setJurisdictionCode

public void setJurisdictionCode(EnergyServicePointDetail.JurisdictionCodeEnum jurisdictionCode)

isGenerator

public EnergyServicePointDetail isGenerator(Boolean isGenerator)

getIsGenerator

public Boolean getIsGenerator()

This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit(this may include generator auxiliary loads). If absent defaults to false.
**Note:** Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer

Returns:

isGenerator

setIsGenerator

public void setIsGenerator(Boolean isGenerator)

validFromDate

public EnergyServicePointDetail validFromDate(java.time.LocalDate validFromDate)

getValidFromDate

public java.time.LocalDate getValidFromDate()

The latest start date from which the constituent data sets of this service point became valid

Returns:

validFromDate

setValidFromDate

public void setValidFromDate(java.time.LocalDate validFromDate)

lastUpdateDateTime

public EnergyServicePointDetail lastUpdateDateTime(java.time.OffsetDateTime lastUpdateDateTime)

getLastUpdateDateTime

@NotNull
public @NotNull java.time.OffsetDateTime getLastUpdateDateTime()

The date and time that the information for this service point was modified

Returns:

lastUpdateDateTime

setLastUpdateDateTime

public void setLastUpdateDateTime(java.time.OffsetDateTime lastUpdateDateTime)

consumerProfile

public EnergyServicePointDetail consumerProfile(EnergyServicePointConsumerProfile consumerProfile)

getConsumerProfile

@Valid
public @Valid EnergyServicePointConsumerProfile getConsumerProfile()

Get consumerProfile

Returns:

consumerProfile

setConsumerProfile

public void setConsumerProfile(EnergyServicePointConsumerProfile consumerProfile)

distributionLossFactor

public EnergyServicePointDetail distributionLossFactor(EnergyServicePointDetailDistributionLossFactor distributionLossFactor)

getDistributionLossFactor

@NotNull
 @Valid
public @NotNull @Valid EnergyServicePointDetailDistributionLossFactor getDistributionLossFactor()

Get distributionLossFactor

Returns:

distributionLossFactor

setDistributionLossFactor

public void setDistributionLossFactor(EnergyServicePointDetailDistributionLossFactor distributionLossFactor)

relatedParticipants

public EnergyServicePointDetail relatedParticipants(List<EnergyServicePointDetailRelatedParticipants> relatedParticipants)

addRelatedParticipantsItem

public EnergyServicePointDetail addRelatedParticipantsItem(EnergyServicePointDetailRelatedParticipants relatedParticipantsItem)

getRelatedParticipants

@NotNull
 @Valid
public @NotNull @Valid List<EnergyServicePointDetailRelatedParticipants> getRelatedParticipants()

Get relatedParticipants

Returns:

relatedParticipants

setRelatedParticipants

public void setRelatedParticipants(List<EnergyServicePointDetailRelatedParticipants> relatedParticipants)

location

public EnergyServicePointDetail location(CommonPhysicalAddress location)

getLocation

@NotNull
 @Valid
public @NotNull @Valid CommonPhysicalAddress getLocation()

Get location

Returns:

location

setLocation

public void setLocation(CommonPhysicalAddress location)

meters

public EnergyServicePointDetail meters(EnergyServicePointDetailMeters meters)

getMeters

@Valid
public @Valid EnergyServicePointDetailMeters getMeters()

The meters associated with the service point. This may be empty where there are no meters physically installed at the service point

Returns:

meters

setMeters

public void setMeters(EnergyServicePointDetailMeters meters)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object