Package org.cyclos.entities.banking

Class ScheduledPayment

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.ScheduledPayment

All Implemented Interfaces:

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

@Entity
public class ScheduledPayment
extends BasePayment
implements HasTransactionStatus<ScheduledPaymentStatus>, HasShowToReceiver, TransactionWithInstallments<ScheduledPaymentInstallment>

A scheduled payment represents a group of scheduled transfers

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
ScheduledPayment()

Method Summary

Modifier and Type	Method	Description
ScheduledPaymentAmountReservation	getAmountReservation()
ScheduledPaymentInstallment	getFirstInstallment()	Returns the first installment
ScheduledPaymentInstallment	getFirstScheduledInstallment()	Returns the first installment which is still open
int	getInstallmentCount()
List<ScheduledPaymentInstallment>	getInstallments()
Location	getLocation()
TransactionNature	getNature()
ScheduledPaymentStatus	getStatus()
boolean	isShowToReceiver()
boolean	isVisibleToReceiver()
void	setAmountReservation(ScheduledPaymentAmountReservation amountReservation)
void	setInstallments(List<ScheduledPaymentInstallment> occurrences)
void	setShowToReceiver(boolean showToReceiver)
void	setStatus(ScheduledPaymentStatus status)
void	setVisibleToReceiver(boolean visibleToReceiver)

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

getInstallmentsCount, getLastProcessedInstallment, getProcessedInstallments, getScheduling, getScheduling

Constructor Detail

ScheduledPayment

public ScheduledPayment()

Method Detail

getAmountReservation

public ScheduledPaymentAmountReservation getAmountReservation()

getFirstInstallment

public ScheduledPaymentInstallment getFirstInstallment()

Returns the first installment

getFirstScheduledInstallment

public ScheduledPaymentInstallment getFirstScheduledInstallment()

Returns the first installment which is still open

Specified by:

getFirstScheduledInstallment in interface TransactionWithInstallments<ScheduledPaymentInstallment>

getInstallmentCount

public int getInstallmentCount()

getInstallments

public List<ScheduledPaymentInstallment> getInstallments()

Specified by:

getInstallments in interface TransactionWithInstallments<ScheduledPaymentInstallment>

getLocation

public Location getLocation()

Specified by:

getLocation in class Transaction

getNature

public TransactionNature getNature()

Specified by:

getNature in class Transaction

getStatus

public ScheduledPaymentStatus getStatus()

Specified by:

getStatus in interface HasTransactionStatus<ScheduledPaymentStatus>

isShowToReceiver

public boolean isShowToReceiver()

Specified by:

isShowToReceiver in interface HasShowToReceiver

isVisibleToReceiver

public boolean isVisibleToReceiver()

setAmountReservation

public void setAmountReservation(ScheduledPaymentAmountReservation amountReservation)

setInstallments

public void setInstallments(List<ScheduledPaymentInstallment> occurrences)

setShowToReceiver

public void setShowToReceiver(boolean showToReceiver)

Specified by:

setShowToReceiver in interface HasShowToReceiver

setStatus

public void setStatus(ScheduledPaymentStatus status)

Specified by:

setStatus in interface HasTransactionStatus<ScheduledPaymentStatus>

setVisibleToReceiver

public void setVisibleToReceiver(boolean visibleToReceiver)