Package org.cyclos.impl.banking

Interface ScheduledPaymentServiceLocal

All Superinterfaces:

ScheduledPaymentService, Service

public interface ScheduledPaymentServiceLocal
extends ScheduledPaymentService

Local interface for ScheduledPaymentService

Method Summary

Modifier and Type	Method	Description
ScheduledPayment	acceptPaymentRequest(PaymentRequest paymentRequest)	Generates the scheduled payment for accepting a payment request, which must be open and scheduled
BigDecimal	calculateDueAmount(ScheduledPayment payment)	Returns the remaining amount to be payed.
int	cancelAll(UserAccount account)	Cancels all scheduled payments to or from the given account
ScheduledPaymentData	getData(ScheduledPayment scheduledPayment)	Returns data about a scheduled payment
void	markAsFailed(ScheduledPaymentInstallment installment)	Marks the given installment as failed, generating the notifications to the involved parties
void	notifyPaymentPerformed(ScheduledPayment scheduledPayment)	Send all notifications derived from to a scheduled payment creation E.g notifies the receiving user if the scheduled payment is visible, and not generated from a payment request (as it is already notified)
ScheduledPaymentPreviewVO	previewAcceptPaymentRequest(PaymentRequest paymentRequest)	Previews accepting the given payment request, which must be open and scheduled
InstallmentTransfer	processInstallment(ScheduledPaymentInstallment installment)	Process the given installment if it's status is not terminal, returning the root generated transfer This method doesn't validate the installment amount because it was already done when the scheduled payment was created.
void	settleInstallment(ScheduledPaymentInstallment installment)	Marks the given installment status as InstallmentStatus.SETTLED if the status is either not terminal

Methods inherited from interface org.cyclos.services.banking.ScheduledPaymentService

block, calculateInstallments, calculateInstallmentsReceive, cancel, getData, perform, preview, previewReceive, processInstallment, receive, settleInstallment, settleRemaining, unblock

Method Detail

acceptPaymentRequest

ScheduledPayment acceptPaymentRequest(PaymentRequest paymentRequest)

Generates the scheduled payment for accepting a payment request, which must be open and scheduled

calculateDueAmount

BigDecimal calculateDueAmount(ScheduledPayment payment)

Returns the remaining amount to be payed.

cancelAll

int cancelAll(UserAccount account)

Cancels all scheduled payments to or from the given account

getData

ScheduledPaymentData getData(ScheduledPayment scheduledPayment)

Returns data about a scheduled payment

markAsFailed

void markAsFailed(ScheduledPaymentInstallment installment)

Marks the given installment as failed, generating the notifications to the involved parties

notifyPaymentPerformed

void notifyPaymentPerformed(ScheduledPayment scheduledPayment)

Send all notifications derived from to a scheduled payment creation E.g notifies the receiving user if the scheduled payment is visible, and not generated from a payment request (as it is already notified)

previewAcceptPaymentRequest

ScheduledPaymentPreviewVO previewAcceptPaymentRequest(PaymentRequest paymentRequest)

Previews accepting the given payment request, which must be open and scheduled

processInstallment

InstallmentTransfer processInstallment(ScheduledPaymentInstallment installment)

Process the given installment if it's status is not terminal, returning the root generated transfer This method doesn't validate the installment amount because it was already done when the scheduled payment was created.

Throws:

IllegalActionException - If the installment is already processed or in some other state that cannot be processed

See Also:

InstallmentStatus.isTerminal()

settleInstallment

void settleInstallment(ScheduledPaymentInstallment installment)

Marks the given installment status as InstallmentStatus.SETTLED if the status is either not terminal

See Also:

InstallmentStatus.isTerminal()