org.cyclos.impl.banking

Interface ScheduledPaymentServiceLocal

All Superinterfaces:

ScheduledPaymentService, Service

public interface ScheduledPaymentServiceLocal
extends ScheduledPaymentService

Local interface for ScheduledPaymentService

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_INSTALLMENT Script bind variable: the ScheduledPaymentInstallment

Method Summary

Modifier and Type	Method and Description
ScheduledPayment	acceptPaymentRequest(PaymentRequest paymentRequest) Generates the scheduled payment for accepting a payment request, which must be open and scheduled
java.math.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
boolean	hasOpenScheduledPayments(InternalAccountOwner owner, AccountType type) Checks if a given account owner has any open scheduled payments on it's account of the given type
ScheduledPaymentPreviewVO	previewAcceptPaymentRequest(PaymentRequest paymentRequest) Previews accepting the given payment request, which must be open and scheduled
ScheduledPaymentInstallmentTransfer	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 ScheduledPaymentInstallmentStatus.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, print, printScheduledPayments, processInstallment, receive, search, searchInstallments, settleInstallment, settleRemaining, unblock

Field Detail

ATTR_INSTALLMENT

static final java.lang.String ATTR_INSTALLMENT

Script bind variable: the ScheduledPaymentInstallment

See Also:

Constant Field Values

Method Detail

acceptPaymentRequest

ScheduledPayment acceptPaymentRequest(PaymentRequest paymentRequest)

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

calculateDueAmount

java.math.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

hasOpenScheduledPayments

boolean hasOpenScheduledPayments(InternalAccountOwner owner,
                                 AccountType type)

Checks if a given account owner has any open scheduled payments on it's account of the given type

previewAcceptPaymentRequest

ScheduledPaymentPreviewVO previewAcceptPaymentRequest(PaymentRequest paymentRequest)

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

processInstallment

ScheduledPaymentInstallmentTransfer 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:

ScheduledPaymentInstallmentStatus.isTerminal()

settleInstallment

void settleInstallment(ScheduledPaymentInstallment installment)

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

See Also:

ScheduledPaymentInstallmentStatus.isTerminal()