io.electrum.prepaidutility.model

Class Token

java.lang.Object

io.electrum.prepaidutility.model.Token

public class Token
extends Object

Represents a prepaid utility token

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Token.TokenTypeEnum Type of token, namely standard (STD), basic service support tariff (BSST), refund (REFUND), key change (KC).

Constructor Summary

Constructors

Constructor and Description
Token()

Method Summary

Methods

Modifier and Type	Method and Description
Token	addTariffCalcItem(TariffBlock tariffCalcItem)
Token	amount(TaxableAmount amount)
boolean	equals(Object o)
TaxableAmount	getAmount() Monetary value of the token.
String	getReceiptNum() Receipt number issued for the transaction.
List<TariffBlock>	getTariffCalc() List of tariff blocks determining how the overall tariff is calculated.
String	getToken() Numeric sequence to be entered into the meter to redeem the token's value.
Token.TokenTypeEnum	getTokenType() Type of token, namely standard (STD), basic service support tariff (BSST), refund (REFUND), key change (KC).
BigDecimal	getUnits() Number of units redeemable by this token.
int	hashCode()
Token	receiptNum(String receiptNum)
void	setAmount(TaxableAmount amount)
void	setReceiptNum(String receiptNum)
void	setTariffCalc(List<TariffBlock> tariffCalc)
void	setToken(String token)
void	setTokenType(Token.TokenTypeEnum tokenType)
void	setUnits(BigDecimal units)
Token	tariffCalc(List<TariffBlock> tariffCalc)
Token	token(String token)
Token	tokenType(Token.TokenTypeEnum tokenType)
String	toString()
Token	units(BigDecimal units)

Methods inherited from class java.lang.Object

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

Constructor Detail

Token

public Token()

Method Detail

tokenType

public Token tokenType(Token.TokenTypeEnum tokenType)

getTokenType

@NotNull
public Token.TokenTypeEnum getTokenType()

Type of token, namely standard (STD), basic service support tariff (BSST), refund (REFUND), key change (KC).

Returns:

tokenType

setTokenType

public void setTokenType(Token.TokenTypeEnum tokenType)

units

public Token units(BigDecimal units)

getUnits

@NotNull
public BigDecimal getUnits()

Number of units redeemable by this token.

Returns:

units

setUnits

public void setUnits(BigDecimal units)

amount

public Token amount(TaxableAmount amount)

getAmount

@NotNull
public TaxableAmount getAmount()

Monetary value of the token.

Returns:

amount

setAmount

public void setAmount(TaxableAmount amount)

receiptNum

public Token receiptNum(String receiptNum)

getReceiptNum

public String getReceiptNum()

Receipt number issued for the transaction.

Returns:

receiptNum

setReceiptNum

public void setReceiptNum(String receiptNum)

token

public Token token(String token)

getToken

@NotNull
public String getToken()

Numeric sequence to be entered into the meter to redeem the token's value.

Returns:

token

setToken

public void setToken(String token)

tariffCalc

public Token tariffCalc(List<TariffBlock> tariffCalc)

addTariffCalcItem

public Token addTariffCalcItem(TariffBlock tariffCalcItem)

getTariffCalc

public List<TariffBlock> getTariffCalc()

List of tariff blocks determining how the overall tariff is calculated.

Returns:

tariffCalc

setTariffCalc

public void setTariffCalc(List<TariffBlock> tariffCalc)

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