Package org.cyclos.entities.banking

Class RecurringPayment

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.banking.Transaction

org.cyclos.entities.banking.InternalTransaction

org.cyclos.entities.banking.BasePayment

org.cyclos.entities.banking.RecurringPayment

All Implemented Interfaces:

Cloneable, HasCurrency, HasCurrencyAmount, Trans, TransactionWithInstallments<RecurringPaymentOccurrence>, HasNetwork, ProcessableForProxying, EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>, HasShowToReceiver, HasTransactionNumber, HasTransactionStatus<RecurringPaymentStatus>, IEntity, HasAmount

@Entity
public class RecurringPayment
extends BasePayment
implements HasTransactionStatus<RecurringPaymentStatus>, HasShowToReceiver, TransactionWithInstallments<RecurringPaymentOccurrence>

A recurring payment is processed periodically for a given number of times, or indefinitely (until canceled)

Nested Class Summary

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

SimpleEntity.EntityLoadNotifier

Field Summary

Fields inherited from class org.cyclos.entities.banking.InternalTransaction

installments

Fields inherited from class org.cyclos.entities.banking.Transaction

authorizationStatus, authorizationType, creationType, expirationDate, nextAuthorizationLevel, receivedBy, showToReceiver, status, transaction

Constructor Summary

Constructors

Constructor	Description
RecurringPayment()

Method Summary

Modifier and Type	Method	Description
List<RecurringPaymentOccurrence>	getInstallments()
Integer	getInstallmentsCount()
int	getLastOccurrenceNumber()
Location	getLocation()
TransactionNature	getNature()
RecurringPaymentOccurrence	getNextOccurrence()
Date	getNextOccurrenceDate()
TimeInterval	getOccurrenceInterval()
List<RecurringPaymentOccurrence>	getOccurrences()
Integer	getOccurrencesCount()
RecurringPaymentStatus	getStatus()
boolean	isShowToReceiver()
void	setOccurrenceInterval(TimeInterval occurrenceInterval)
void	setOccurrences(List<RecurringPaymentOccurrence> occurrences)
void	setOccurrencesCount(Integer occurrencesCount)
void	setShowToReceiver(boolean showToReceiver)
void	setStatus(RecurringPaymentStatus status)

Methods inherited from class org.cyclos.entities.banking.BasePayment

getAuthorizations, getAuthorizationStatus, getAuthorizationType, getCreationType, getFeedback, getFeedbackExpirationNotified, getFeedbackExpirationReminderNotified, getFeedbackReminderNotified, getNextAuthorizationLevel, getOidcClient, getPaymentRequest, getPaymentType, getProcessDate, getReceivedBy, getReceiver, isAuthorized, isPendingAuthorization, isReceived, setAuthorizations, setAuthorizationStatus, setAuthorizationType, setCreationType, setFeedback, setFeedbackExpirationNotified, setFeedbackExpirationReminderNotified, setFeedbackReminderNotified, setNextAuthorizationLevel, setOidcClient, setPaymentRequest, setPaymentType, setReceivedBy, setType

Methods inherited from class org.cyclos.entities.banking.InternalTransaction

getToOwner, getVoucherTransaction, setVoucherTransaction

Methods inherited from class org.cyclos.entities.banking.Transaction

getAccessClient, getAmount, getBy, getChannel, getCurrency, getCustomFieldClass, getCustomFieldValueClass, getCustomValues, getDate, getDescription, getFrom, getFromBasicUser, getFromName, getNetwork, getPerformer, getPrincipalType, getRelatedName, getTo, getToBasicUser, getToName, getToUser, getTransactionNumber, getType, isPendingNotification, setAccessClient, setAmount, setBy, setChannel, setCustomValues, setDate, setDescription, setFrom, setFromName, setPendingNotification, setPrincipalType, setTo, setToName, setTransactionNumber

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

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.utils.HasAmount

setAmount

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

getCurrency, round, withCurrency

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

getCurrencyAmount

Methods inherited from interface org.cyclos.model.banking.transactions.HasTransactionNumber

getTransactionNumber

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

getAccessClient, getActualAmount, getAmount, getChannel, getCustomValues, getCustomValuesForExport, getDate, getFrom, getFromName, getFromOwner, getFromOwnerOrType, getFromType, getFromUser, getRelatedAccount, getRelatedOwner, getTo, getToName, getToOwner, getToOwnerOrType, getToType, getToUser, getTransactionNumberOrId, getType, isDebit, isFromSystem, isFromUser, isToSystem, isToUser

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

getFirstScheduledInstallment, getLastProcessedInstallment, getProcessedInstallments, getScheduling, getScheduling

Constructor Detail

RecurringPayment

public RecurringPayment()

Method Detail

getInstallments

public List<RecurringPaymentOccurrence> getInstallments()

Specified by:

getInstallments in interface TransactionWithInstallments<RecurringPaymentOccurrence>

getInstallmentsCount

public Integer getInstallmentsCount()

Specified by:

getInstallmentsCount in interface TransactionWithInstallments<RecurringPaymentOccurrence>

getLastOccurrenceNumber

public int getLastOccurrenceNumber()

getLocation

public Location getLocation()

Specified by:

getLocation in class Transaction

getNature

public TransactionNature getNature()

Specified by:

getNature in class Transaction

getNextOccurrence

public RecurringPaymentOccurrence getNextOccurrence()

getNextOccurrenceDate

public Date getNextOccurrenceDate()

getOccurrenceInterval

public TimeInterval getOccurrenceInterval()

getOccurrences

public List<RecurringPaymentOccurrence> getOccurrences()

getOccurrencesCount

public Integer getOccurrencesCount()

getStatus

public RecurringPaymentStatus getStatus()

Specified by:

getStatus in interface HasTransactionStatus<RecurringPaymentStatus>

isShowToReceiver

public boolean isShowToReceiver()

Specified by:

isShowToReceiver in interface HasShowToReceiver

setOccurrenceInterval

public void setOccurrenceInterval(TimeInterval occurrenceInterval)

setOccurrences

public void setOccurrences(List<RecurringPaymentOccurrence> occurrences)

setOccurrencesCount

public void setOccurrencesCount(Integer occurrencesCount)

setShowToReceiver

public void setShowToReceiver(boolean showToReceiver)

Specified by:

setShowToReceiver in interface HasShowToReceiver

setStatus

public void setStatus(RecurringPaymentStatus status)

Specified by:

setStatus in interface HasTransactionStatus<RecurringPaymentStatus>