Package org.cyclos.entities.banking

Class Installment

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.banking.Installment

All Implemented Interfaces:

Cloneable, HasCurrency, HasCurrencyAmount, Trans, HasNetwork, ProcessableForProxying, HasTransactionNumber, IEntity, HasAmount

Direct Known Subclasses:

RecurringPaymentOccurrence, ScheduledPaymentInstallment

@Entity
public abstract class Installment
extends NetworkedEntity
implements Trans

An installment is an amount of money generated by a scheduled transaction, currently, ScheduledPayments and RecurringPayments.

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Field Summary

Fields

Modifier and Type	Field	Description
protected Date	dueDate
protected InternalTransaction	transaction	The transaction that generated this installment

Constructor Summary

Constructors

Constructor	Description
Installment()

Method Summary

Modifier and Type	Method	Description
AccessClient	getAccessClient()
BigDecimal	getAmount()
BasicUser	getBy()
Channel	getChannel()
Currency	getCurrency()
CurrencyAmount	getCurrencyAmount()
Set<TransactionCustomFieldValue>	getCustomValues()
Date	getDate()
Date	getDueDate()
Account	getFrom()
String	getFromName()
Network	getNetwork()	Returns the network this entity belongs to
int	getNumber()
InstallmentStatus	getStatus()
Account	getTo()
String	getToName()
Integer	getTotalInstallments()
InternalTransaction	getTransaction()
String	getTransactionNumber()
InstallmentTransfer	getTransfer()
Date	getTransferDate()
Long	getTransferId()
String	getTransferTransactionNumber()
TransferType	getType()
void	setAmount(BigDecimal amount)
void	setBy(BasicUser by)
void	setDueDate(Date dueDate)
void	setNumber(int number)
void	setStatus(InstallmentStatus status)
void	setTransaction(InternalTransaction transaction)
void	setTransfer(InstallmentTransfer transfer)

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, toShortString, toString, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.entities.banking.HasCurrency

round, withCurrency

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Methods inherited from interface org.cyclos.entities.banking.Trans

getActualAmount, getCustomValuesForExport, getFromOwner, getFromOwnerOrType, getFromType, getFromUser, getRelatedAccount, getRelatedOwner, getToOwner, getToOwnerOrType, getToType, getToUser, getTransactionNumberOrId, isDebit, isFromSystem, isFromUser, isToSystem, isToUser

Field Detail

transaction

protected InternalTransaction transaction

The transaction that generated this installment

dueDate

protected Date dueDate

Constructor Detail

Installment

public Installment()

Method Detail

getAccessClient

public AccessClient getAccessClient()

Specified by:

getAccessClient in interface Trans

getAmount

public BigDecimal getAmount()

Specified by:

getAmount in interface HasAmount

Specified by:

getAmount in interface Trans

getBy

public BasicUser getBy()

getChannel

public Channel getChannel()

Specified by:

getChannel in interface Trans

getCurrency

public Currency getCurrency()

Specified by:

getCurrency in interface HasCurrency

getCurrencyAmount

public CurrencyAmount getCurrencyAmount()

Specified by:

getCurrencyAmount in interface HasCurrencyAmount

getCustomValues

public Set<TransactionCustomFieldValue> getCustomValues()

Specified by:

getCustomValues in interface Trans

getDate

public Date getDate()

Specified by:

getDate in interface Trans

getDueDate

public Date getDueDate()

getFrom

public Account getFrom()

Specified by:

getFrom in interface Trans

getFromName

public String getFromName()

Specified by:

getFromName in interface Trans

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getNumber

public int getNumber()

getStatus

public InstallmentStatus getStatus()

getTo

public Account getTo()

Specified by:

getTo in interface Trans

getToName

public String getToName()

Specified by:

getToName in interface Trans

getTotalInstallments

public Integer getTotalInstallments()

getTransaction

public InternalTransaction getTransaction()

getTransactionNumber

public String getTransactionNumber()

Specified by:

getTransactionNumber in interface HasTransactionNumber

getTransfer

public InstallmentTransfer getTransfer()

getTransferDate

public Date getTransferDate()

getTransferId

public Long getTransferId()

getTransferTransactionNumber

public String getTransferTransactionNumber()

getType

public TransferType getType()

Specified by:

getType in interface Trans

setAmount

public void setAmount(BigDecimal amount)

Specified by:

setAmount in interface HasAmount

setBy

public void setBy(BasicUser by)

setDueDate

public void setDueDate(Date dueDate)

setNumber

public void setNumber(int number)

setStatus

public void setStatus(InstallmentStatus status)

setTransaction

public void setTransaction(InternalTransaction transaction)

setTransfer

public void setTransfer(InstallmentTransfer transfer)