EnergyServicePoint (Data Holder 1.22.0 API)

java.lang.Object
- au.org.consumerdatastandards.holder.model.energy.EnergyServicePoint

public class EnergyServicePoint
extends Object

EnergyServicePoint

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

EnergyServicePoint()

Constructors
Constructor and Description
`EnergyServicePoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnergyServicePoint`	`consumerProfile(EnergyServicePointConsumerProfile consumerProfile)`
`boolean`	`equals(Object o)`
`@Valid EnergyServicePointConsumerProfile`	`getConsumerProfile()` Get consumerProfile
`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 EnergyServicePoint.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 String`	`getNationalMeteringId()` The independent ID of the service point, known in the industry as the NMI
`@NotNull EnergyServicePoint.ServicePointClassificationEnum`	`getServicePointClassification()` The classification of the service point as defined in MSATS procedures
`@NotNull String`	`getServicePointId()` Tokenised ID of the service point to be used for referring to the service point in the CDR API suite.
`@NotNull EnergyServicePoint.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()`
`EnergyServicePoint`	`isGenerator(Boolean isGenerator)`
`EnergyServicePoint`	`jurisdictionCode(EnergyServicePoint.JurisdictionCodeEnum jurisdictionCode)`
`EnergyServicePoint`	`lastUpdateDateTime(java.time.OffsetDateTime lastUpdateDateTime)`
`EnergyServicePoint`	`nationalMeteringId(String nationalMeteringId)`
`EnergyServicePoint`	`servicePointClassification(EnergyServicePoint.ServicePointClassificationEnum servicePointClassification)`
`EnergyServicePoint`	`servicePointId(String servicePointId)`
`EnergyServicePoint`	`servicePointStatus(EnergyServicePoint.ServicePointStatusEnum servicePointStatus)`
`void`	`setConsumerProfile(EnergyServicePointConsumerProfile consumerProfile)`
`void`	`setIsGenerator(Boolean isGenerator)`
`void`	`setJurisdictionCode(EnergyServicePoint.JurisdictionCodeEnum jurisdictionCode)`
`void`	`setLastUpdateDateTime(java.time.OffsetDateTime lastUpdateDateTime)`
`void`	`setNationalMeteringId(String nationalMeteringId)`
`void`	`setServicePointClassification(EnergyServicePoint.ServicePointClassificationEnum servicePointClassification)`
`void`	`setServicePointId(String servicePointId)`
`void`	`setServicePointStatus(EnergyServicePoint.ServicePointStatusEnum servicePointStatus)`
`void`	`setValidFromDate(java.time.LocalDate validFromDate)`
`String`	`toString()`
`EnergyServicePoint`	`validFromDate(java.time.LocalDate validFromDate)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnergyServicePoint
```
public EnergyServicePoint()
```
- Method Detail
  - servicePointId
```
public EnergyServicePoint servicePointId(String servicePointId)
```
  - getServicePointId
```
@NotNull
public @NotNull String getServicePointId()
```
    Tokenised ID of the service point to be used for referring to the service point in the CDR API suite. To be created in accordance with CDR ID permanence requirements
    
    Returns:
    
    servicePointId
  - setServicePointId
```
public void setServicePointId(String servicePointId)
```
  - nationalMeteringId
```
public EnergyServicePoint 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 EnergyServicePoint servicePointClassification(EnergyServicePoint.ServicePointClassificationEnum servicePointClassification)
```
  - getServicePointClassification
```
@NotNull
public @NotNull EnergyServicePoint.ServicePointClassificationEnum getServicePointClassification()
```
    The classification of the service point as defined in MSATS procedures
    
    Returns:
    
    servicePointClassification
  - setServicePointClassification
```
public void setServicePointClassification(EnergyServicePoint.ServicePointClassificationEnum servicePointClassification)
```
  - servicePointStatus
```
public EnergyServicePoint servicePointStatus(EnergyServicePoint.ServicePointStatusEnum servicePointStatus)
```
  - getServicePointStatus
```
@NotNull
public @NotNull EnergyServicePoint.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(EnergyServicePoint.ServicePointStatusEnum servicePointStatus)
```
  - jurisdictionCode
```
public EnergyServicePoint jurisdictionCode(EnergyServicePoint.JurisdictionCodeEnum jurisdictionCode)
```
  - getJurisdictionCode
```
@NotNull
public @NotNull EnergyServicePoint.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(EnergyServicePoint.JurisdictionCodeEnum jurisdictionCode)
```
  - isGenerator
```
public EnergyServicePoint 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 EnergyServicePoint 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 EnergyServicePoint 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 EnergyServicePoint consumerProfile(EnergyServicePointConsumerProfile consumerProfile)
```
  - getConsumerProfile
```
@Valid
public @Valid EnergyServicePointConsumerProfile getConsumerProfile()
```
    Get consumerProfile
    
    Returns:
    
    consumerProfile
  - setConsumerProfile
```
public void setConsumerProfile(EnergyServicePointConsumerProfile consumerProfile)
```
  - 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

Class EnergyServicePoint

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnergyServicePoint

Method Detail

servicePointId

getServicePointId

setServicePointId

nationalMeteringId

getNationalMeteringId

setNationalMeteringId

servicePointClassification

getServicePointClassification

setServicePointClassification

servicePointStatus

getServicePointStatus

setServicePointStatus

jurisdictionCode

getJurisdictionCode

setJurisdictionCode

isGenerator

getIsGenerator

setIsGenerator

validFromDate

getValidFromDate

setValidFromDate

lastUpdateDateTime

getLastUpdateDateTime

setLastUpdateDateTime

consumerProfile

getConsumerProfile

setConsumerProfile

equals

hashCode

toString