Package org.cyclos.entities.banking

Class Voucher

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.banking.Voucher

All Implemented Interfaces:

Cloneable, HasCurrency, HasCurrencyAmount, ProcessableForDataTranslation, IEntity, HasAmount

@Entity
public class Voucher
extends BaseEntity
implements HasCurrencyAmount

A voucher represents a physical code that can be redeemed by a user to get a payment in his account

Constructor Summary

Constructors

Constructor	Description
Voucher()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getAmount()
VoucherAmountReservation	getAmountDereservation()
VoucherConfiguration	getConfiguration()
Currency	getCurrency()
CurrencyAmount	getCurrencyAmount()
Date	getExpirationDate()
String	getExpirationDateComments()
Network	getNetwork()	Returns the network this entity belongs to
User	getOwner()
VoucherPack	getPack()
Payment	getRedeem()
BasicUser	getRedeemBy()
Date	getRedeemDate()
User	getRedeemer()
Payment	getRefund()
VoucherStatus	getStatus()
String	getToken()
VoucherType	getType()
boolean	hasCustomExpirationDate()
boolean	isExpirationNotified()
boolean	isPrinted()
void	setAmountDereservation(VoucherAmountReservation amountDereservation)
void	setExpirationDate(Date expirationDate)
void	setExpirationDateComments(String expirationDateComments)
void	setExpirationNotified(boolean expirationNotified)
void	setOwner(User owner)
void	setPack(VoucherPack pack)
void	setPrinted(boolean printed)
void	setRedeem(Payment redeem)
void	setRedeemBy(BasicUser redeemBy)
void	setRedeemer(User redeemer)
void	setRefund(Payment refund)
void	setStatus(VoucherStatus status)
void	setToken(String token)

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient, toShortString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.utils.HasAmount

setAmount

Methods inherited from interface org.cyclos.model.IEntity

matches

Constructor Detail

Voucher

public Voucher()

Method Detail

getAmount

public BigDecimal getAmount()

Specified by:

getAmount in interface HasAmount

getAmountDereservation

public VoucherAmountReservation getAmountDereservation()

getConfiguration

public VoucherConfiguration getConfiguration()

getCurrency

public Currency getCurrency()

Specified by:

getCurrency in interface HasCurrency

getCurrencyAmount

public CurrencyAmount getCurrencyAmount()

Specified by:

getCurrencyAmount in interface HasCurrencyAmount

getExpirationDate

public Date getExpirationDate()

getExpirationDateComments

public String getExpirationDateComments()

getNetwork

public Network getNetwork()

Description copied from class: NetworkedEntity

Returns the network this entity belongs to

Specified by:

getNetwork in class NetworkedEntity

getOwner

public User getOwner()

getPack

public VoucherPack getPack()

getRedeem

public Payment getRedeem()

getRedeemBy

public BasicUser getRedeemBy()

getRedeemDate

public Date getRedeemDate()

getRedeemer

public User getRedeemer()

getRefund

public Payment getRefund()

getStatus

public VoucherStatus getStatus()

getToken

public String getToken()

getType

public VoucherType getType()

hasCustomExpirationDate

public boolean hasCustomExpirationDate()

isExpirationNotified

public boolean isExpirationNotified()

isPrinted

public boolean isPrinted()

setAmountDereservation

public void setAmountDereservation(VoucherAmountReservation amountDereservation)

setExpirationDate

public void setExpirationDate(Date expirationDate)

setExpirationDateComments

public void setExpirationDateComments(String expirationDateComments)

setExpirationNotified

public void setExpirationNotified(boolean expirationNotified)

setOwner

public void setOwner(User owner)

setPack

public void setPack(VoucherPack pack)

setPrinted

public void setPrinted(boolean printed)

setRedeem

public void setRedeem(Payment redeem)

setRedeemBy

public void setRedeemBy(BasicUser redeemBy)

setRedeemer

public void setRedeemer(User redeemer)

setRefund

public void setRefund(Payment refund)

setStatus

public void setStatus(VoucherStatus status)

setToken

public void setToken(String token)