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

Methods

Modifier and Type	Method and Description
void	autoCancelPaymentsScheduledTo(AccountOwner owner, AccountType type) Cancels all open scheduled payments to the specified account
java.math.BigDecimal	calculateDueAmount(ScheduledPayment payment) Returns the remaining amount to be payed.
boolean	hasOpenScheduledPayments(AccountOwner owner, AccountType type) Checks if a given account owner has any open scheduled payments on it's account of the given type
ScheduledPaymentInstallmentTransfer	processInstallment(ScheduledPaymentInstallment installment) Process the given installment if it's status is not terminal, returning the root generated transfer
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, cancel, getData, perform, preview, print, processInstallment, 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

autoCancelPaymentsScheduledTo

void autoCancelPaymentsScheduledTo(AccountOwner owner,
                                 AccountType type)

Cancels all open scheduled payments to the specified account

calculateDueAmount

java.math.BigDecimal calculateDueAmount(ScheduledPayment payment)

Returns the remaining amount to be payed.

hasOpenScheduledPayments

boolean hasOpenScheduledPayments(AccountOwner owner,
                               AccountType type)

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

processInstallment

ScheduledPaymentInstallmentTransfer processInstallment(ScheduledPaymentInstallment installment)
                                                       throws FrameworkException,
                                                              TransferException

Process the given installment if it's status is not terminal, returning the root generated transfer

Throws:

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

FrameworkException

TransferException

See Also:

ScheduledPaymentInstallmentStatus.isTerminal()

settleInstallment

void settleInstallment(ScheduledPaymentInstallment installment)
                       throws FrameworkException

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

Throws:

FrameworkException

See Also:

ScheduledPaymentInstallmentStatus.isTerminal()