io.electrum.prepaidutility.model

Class PurchaseResponse

java.lang.Object

io.electrum.vas.model.Transaction

io.electrum.prepaidutility.model.PurchaseResponse

public class PurchaseResponse
extends io.electrum.vas.model.Transaction

Represents the response to a token purchase request

Field Summary

Fields inherited from class io.electrum.vas.model.Transaction

basketRef, client, destAccType, id, originator, receiver, settlementEntity, slipData, srcAccType, thirdPartyIdentifiers, time, tranType

Constructor Summary

Constructors

Constructor and Description
PurchaseResponse()

Method Summary

Methods

Modifier and Type	Method and Description
PurchaseResponse	addDebtRecoveryChargesItem(DebtRecoveryCharge debtRecoveryChargesItem)
PurchaseResponse	addServiceChargesItem(ServiceCharge serviceChargesItem)
PurchaseResponse	addTokensItem(Token tokensItem)
PurchaseResponse	customer(io.electrum.vas.model.Customer customer) Details of the person or organization to whom the meter belongs.
PurchaseResponse	debtRecoveryCharges(List<DebtRecoveryCharge> debtRecoveryCharges) List of charges that have been levied in order to reclaim outstanding debts associated with the meter.
io.electrum.vas.model.Customer	getCustomer()
List<DebtRecoveryCharge>	getDebtRecoveryCharges()
Meter	getMeter()
io.electrum.vas.model.LedgerAmount	getPurchaseTotal()
List<ServiceCharge>	getServiceCharges()
io.electrum.vas.model.LedgerAmount	getTaxTotal()
List<Token>	getTokens()
Utility	getUtility()
String	getUtilityType()
PurchaseResponse	meter(Meter meter) Details of the meter.
PurchaseResponse	purchaseTotal(io.electrum.vas.model.LedgerAmount saleTotal) The total amount charged for tokens on this purchase.
PurchaseResponse	serviceCharges(List<ServiceCharge> serviceCharges) List of service charges levied against this meter.
void	setCustomer(io.electrum.vas.model.Customer customer)
void	setDebtRecoveryCharges(List<DebtRecoveryCharge> debtRecoveryCharges)
void	setMeter(Meter meter)
void	setPurchaseTotal(io.electrum.vas.model.LedgerAmount purchaseTotal)
void	setServiceCharges(List<ServiceCharge> serviceCharges)
void	setTaxTotal(io.electrum.vas.model.LedgerAmount taxTotal)
void	setTokens(List<Token> tokens)
void	setUtility(Utility utility)
void	setUtilityType(String utilityType)
PurchaseResponse	taxTotal(io.electrum.vas.model.LedgerAmount taxTotal) The total tax charged for this purchase.
PurchaseResponse	tokens(List<Token> tokens) List of tokens issued for the purchase.
String	toString()
PurchaseResponse	utility(Utility utility) Details of the utility which manages this meter's account.
PurchaseResponse	utilityType(String utilityType) Type of utility purchase being requested (e.g.

Methods inherited from class io.electrum.vas.model.Transaction

basketRef, client, destAccType, equals, getBasketRef, getClient, getDestAccType, getId, getOriginator, getReceiver, getSettlementEntity, getSlipData, getSrcAccType, getThirdPartyIdentifiers, getTime, getTranType, hashCode, id, originator, receiver, setBasketRef, setClient, setDestAccType, setId, setOriginator, setReceiver, setSettlementEntity, setSlipData, setSrcAccType, setThirdPartyIdentifiers, setTime, settlementEntity, setTranType, slipData, srcAccType, thirdPartyIdentifiers, time, tranType

Methods inherited from class java.lang.Object

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

Constructor Detail

PurchaseResponse

public PurchaseResponse()

Method Detail

purchaseTotal

public PurchaseResponse purchaseTotal(io.electrum.vas.model.LedgerAmount saleTotal)

The total amount charged for tokens on this purchase. This amount is exclusive of tax and also excludes any debt recoveries or service charges deducted from the purchase amount.

getPurchaseTotal

public io.electrum.vas.model.LedgerAmount getPurchaseTotal()

setPurchaseTotal

public void setPurchaseTotal(io.electrum.vas.model.LedgerAmount purchaseTotal)

taxTotal

public PurchaseResponse taxTotal(io.electrum.vas.model.LedgerAmount taxTotal)

The total tax charged for this purchase. This amount may include taxes levied on the tokens purchased, as well as any taxes on debt recovery or service charges.

getTaxTotal

public io.electrum.vas.model.LedgerAmount getTaxTotal()

setTaxTotal

public void setTaxTotal(io.electrum.vas.model.LedgerAmount taxTotal)

meter

public PurchaseResponse meter(Meter meter)

Details of the meter.

getMeter

@NotNull
public Meter getMeter()

setMeter

public void setMeter(Meter meter)

customer

public PurchaseResponse customer(io.electrum.vas.model.Customer customer)

Details of the person or organization to whom the meter belongs.

getCustomer

@NotNull
public io.electrum.vas.model.Customer getCustomer()

setCustomer

public void setCustomer(io.electrum.vas.model.Customer customer)

utility

public PurchaseResponse utility(Utility utility)

Details of the utility which manages this meter's account.

getUtility

@NotNull
public Utility getUtility()

setUtility

public void setUtility(Utility utility)

utilityType

public PurchaseResponse utilityType(String utilityType)

Type of utility purchase being requested (e.g. electricity, water, gas).

getUtilityType

public String getUtilityType()

setUtilityType

public void setUtilityType(String utilityType)

tokens

public PurchaseResponse tokens(List<Token> tokens)

List of tokens issued for the purchase.

addTokensItem

public PurchaseResponse addTokensItem(Token tokensItem)

getTokens

public List<Token> getTokens()

setTokens

public void setTokens(List<Token> tokens)

debtRecoveryCharges

public PurchaseResponse debtRecoveryCharges(List<DebtRecoveryCharge> debtRecoveryCharges)

List of charges that have been levied in order to reclaim outstanding debts associated with the meter.

addDebtRecoveryChargesItem

public PurchaseResponse addDebtRecoveryChargesItem(DebtRecoveryCharge debtRecoveryChargesItem)

getDebtRecoveryCharges

public List<DebtRecoveryCharge> getDebtRecoveryCharges()

setDebtRecoveryCharges

public void setDebtRecoveryCharges(List<DebtRecoveryCharge> debtRecoveryCharges)

serviceCharges

public PurchaseResponse serviceCharges(List<ServiceCharge> serviceCharges)

List of service charges levied against this meter.

addServiceChargesItem

public PurchaseResponse addServiceChargesItem(ServiceCharge serviceChargesItem)

getServiceCharges

public List<ServiceCharge> getServiceCharges()

setServiceCharges

public void setServiceCharges(List<ServiceCharge> serviceCharges)

toString

public String toString()

Overrides:

toString in class io.electrum.vas.model.Transaction