io.electrum.prepaidutility.model

Class Meter

java.lang.Object

io.electrum.prepaidutility.model.Meter

public class Meter
extends Object

Data associated with a prepaid utility meter

Constructor Summary

Constructors

Constructor and Description
Meter()

Method Summary

Methods

Modifier and Type	Method and Description
Meter	algorithmCode(String algorithmCode)
boolean	equals(Object o)
String	getAlgorithmCode() Code used to identify token encryption algorithm used by the meter.
KeyChangeData	getKeyChangeData() Represents new meter data in the case that these these have been updated.
String	getKeyRevisionNum() Key revision number of the meter.
String	getMeterId() Unique identifier for the meter (e.g.
String	getServiceType() Type of service dispensed by this meter (e.g.
String	getSupplyGroupCode() Code used to identify a group of suppliers.
String	getTariffIndex() Code representing the tariff associated with this meter.
String	getTokenTechCode() The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
String	getTrack2Data() Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters.
int	hashCode()
Meter	keyChangeData(KeyChangeData keyChangeData)
Meter	keyRevisionNum(String keyRevisionNum)
Meter	meterId(String meterId)
Meter	serviceType(String serviceType)
void	setAlgorithmCode(String algorithmCode)
void	setKeyChangeData(KeyChangeData keyChangeData)
void	setKeyRevisionNum(String keyRevisionNum)
void	setMeterId(String meterId)
void	setServiceType(String serviceType)
void	setSupplyGroupCode(String supplyGroupCode)
void	setTariffIndex(String tariffIndex)
void	setTokenTechCode(String tokenTechCode)
void	setTrack2Data(String track2Data)
Meter	supplyGroupCode(String supplyGroupCode)
Meter	tariffIndex(String tariffIndex)
Meter	tokenTechCode(String tokenTechCode)
String	toString()
Meter	track2Data(String track2Data)

Methods inherited from class java.lang.Object

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

Constructor Detail

Meter

public Meter()

Method Detail

meterId

public Meter meterId(String meterId)

getMeterId

@NotNull
@Pattern(regexp="[a-zA-Z0-9]{0,20}")
public String getMeterId()

Unique identifier for the meter (e.g. serial number).

Returns:

meterId

setMeterId

public void setMeterId(String meterId)

track2Data

public Meter track2Data(String track2Data)

getTrack2Data

@Pattern(regexp="[a-zA-Z0-9=]{34}")
public String getTrack2Data()

Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.

Returns:

track2Data

setTrack2Data

public void setTrack2Data(String track2Data)

serviceType

public Meter serviceType(String serviceType)

getServiceType

@Pattern(regexp="[a-zA-Z0-9]{0,12}")
public String getServiceType()

Type of service dispensed by this meter (e.g. electricity, water or gas).

Returns:

serviceType

setServiceType

public void setServiceType(String serviceType)

supplyGroupCode

public Meter supplyGroupCode(String supplyGroupCode)

getSupplyGroupCode

@Pattern(regexp="[0-9]{6}")
public String getSupplyGroupCode()

Code used to identify a group of suppliers.

Returns:

supplyGroupCode

setSupplyGroupCode

public void setSupplyGroupCode(String supplyGroupCode)

keyRevisionNum

public Meter keyRevisionNum(String keyRevisionNum)

getKeyRevisionNum

@Pattern(regexp="[0-9]{1}")
public String getKeyRevisionNum()

Key revision number of the meter.

Returns:

keyRevisionNum

setKeyRevisionNum

public void setKeyRevisionNum(String keyRevisionNum)

tariffIndex

public Meter tariffIndex(String tariffIndex)

getTariffIndex

@Pattern(regexp="[0-9]{2}")
public String getTariffIndex()

Code representing the tariff associated with this meter.

Returns:

tariffIndex

setTariffIndex

public void setTariffIndex(String tariffIndex)

tokenTechCode

public Meter tokenTechCode(String tokenTechCode)

getTokenTechCode

@Pattern(regexp="[0-9]{2}")
public String getTokenTechCode()

The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).

Returns:

tokenTechCode

setTokenTechCode

public void setTokenTechCode(String tokenTechCode)

algorithmCode

public Meter algorithmCode(String algorithmCode)

getAlgorithmCode

@Pattern(regexp="[0-9]{2}")
public String getAlgorithmCode()

Code used to identify token encryption algorithm used by the meter.

Returns:

algorithmCode

setAlgorithmCode

public void setAlgorithmCode(String algorithmCode)

keyChangeData

public Meter keyChangeData(KeyChangeData keyChangeData)

getKeyChangeData

public KeyChangeData getKeyChangeData()

Represents new meter data in the case that these these have been updated.

Returns:

keyChangeData

setKeyChangeData

public void setKeyChangeData(KeyChangeData keyChangeData)

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