org.cyclos.services.banking

Interface RecurringPaymentService

All Superinterfaces:

Service

All Known Subinterfaces:

RecurringPaymentServiceLocal

All Known Implementing Classes:

RecurringPaymentServiceSecurity

public interface RecurringPaymentService
extends Service

Service interface to perform recurring payments and for searching and retrieve information about a recurring payment. A recurring payment is a transaction, and performing a recurring payment normally starts by using TransactionService#getPaymentData(org.cyclos.model.banking.accounts.InternalAccountOwner, org.cyclos.model.banking.accounts.AccountOwner) . preview(PerformRecurringPaymentDTO) and eventually perform(PerformRecurringPaymentDTO) the recurring payment.

Author:

luis

See Also:

TransactionService, PaymentService

Method Summary

Modifier and Type	Method and Description
void	cancel(RecurringPaymentActionDTO params) Permanently cancels the given recurring payment, so installments will never be processed
RecurringPaymentData	getData(java.lang.Long id) Returns data about a recurring payment
RecurringPaymentVO	perform(PerformRecurringPaymentDTO recurringPayment) Performs an recurring payment, returning its data
RecurringPaymentPreviewVO	preview(PerformRecurringPaymentDTO parameters) Previews a recurring payment to be performed
RecurringPaymentPreviewVO	previewReceive(PerformRecurringPaymentDTO parameters) Previews a recurring payment to be received
SerializableInputStream	print(java.lang.Long id) Generates a PDF file with the details of a recurring payment.
SerializableInputStream	printRecurringPayments(RecurringPaymentQuery query) Generates a PDF with the recurring payments list result.
java.lang.Long	processFailure(FailedOccurrenceActionDTO params) Processes a failed occurence
RecurringPaymentVO	receive(PerformRecurringPaymentDTO recurringPayment) Receives a recurring payment, returning its data
Page<RecurringPaymentEntryVO>	search(RecurringPaymentQuery query) Searches for recurring payments, according to the given query

Method Detail

cancel

void cancel(RecurringPaymentActionDTO params)
     throws FrameworkException

Permanently cancels the given recurring payment, so installments will never be processed

Throws:

FrameworkException

getData

RecurringPaymentData getData(java.lang.Long id)
                      throws FrameworkException

Returns data about a recurring payment

Throws:

FrameworkException

perform

RecurringPaymentVO perform(PerformRecurringPaymentDTO recurringPayment)
                    throws TransferException,
                           FrameworkException

Performs an recurring payment, returning its data

Throws:

TransferException

FrameworkException

See Also:

PaymentService.perform(org.cyclos.model.banking.transactions.PerformPaymentDTO)

preview

RecurringPaymentPreviewVO preview(PerformRecurringPaymentDTO parameters)
                           throws FrameworkException

Previews a recurring payment to be performed

Throws:

FrameworkException

previewReceive

RecurringPaymentPreviewVO previewReceive(PerformRecurringPaymentDTO parameters)
                                  throws FrameworkException

Previews a recurring payment to be received

Throws:

FrameworkException

print

SerializableInputStream print(java.lang.Long id)
                       throws FrameworkException,
                              ReportExecutionException

Generates a PDF file with the details of a recurring payment.

Throws:

FrameworkException

ReportExecutionException

printRecurringPayments

SerializableInputStream printRecurringPayments(RecurringPaymentQuery query)

Generates a PDF with the recurring payments list result.

processFailure

java.lang.Long processFailure(FailedOccurrenceActionDTO params)
                       throws FrameworkException,
                              TransferException

Processes a failed occurence

Throws:

FrameworkException

TransferException

receive

RecurringPaymentVO receive(PerformRecurringPaymentDTO recurringPayment)
                    throws TransferException,
                           FrameworkException

Receives a recurring payment, returning its data

Throws:

TransferException

FrameworkException

See Also:

PaymentService.perform(org.cyclos.model.banking.transactions.PerformPaymentDTO)

search

Page<RecurringPaymentEntryVO> search(RecurringPaymentQuery query)
                              throws FrameworkException

Searches for recurring payments, according to the given query

Throws:

FrameworkException