org.cyclos.services.banking

Interface RecurringPaymentService

All Superinterfaces:

Service

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

Method Detail

cancel

void cancel(@NotNull
            @NotNull RecurringPaymentActionDTO params)
     throws FrameworkException

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

Throws:

FrameworkException

getData

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

Returns data about a recurring payment

Throws:

FrameworkException

perform

RecurringPaymentVO perform(@NotNull
                           @NotNull 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(@NotNull
                                  @NotNull PerformRecurringPaymentDTO parameters)
                           throws FrameworkException

Previews a recurring payment to be performed

Throws:

FrameworkException

previewReceive

RecurringPaymentPreviewVO previewReceive(@NotNull
                                         @NotNull PerformRecurringPaymentDTO parameters)
                                  throws FrameworkException

Previews a recurring payment to be received

Throws:

FrameworkException

print

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

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

Throws:

FrameworkException

ReportExecutionException

printRecurringPayments

SerializableInputStream printRecurringPayments(@NotNull
                                               @NotNull RecurringPaymentQuery query)

Generates a PDF with the recurring payments list result.

processFailure

TransferVO processFailure(@NotNull
                          @NotNull FailedOccurrenceActionDTO params)
                   throws FrameworkException,
                          TransferException

Processes a failed occurence

Throws:

FrameworkException

TransferException

receive

RecurringPaymentVO receive(@NotNull
                           @NotNull PerformRecurringPaymentDTO recurringPayment)
                    throws TransferException,
                           PosPayerException,
                           FrameworkException

Receives a recurring payment, returning its data

Throws:

TransferException

PosPayerException

FrameworkException

See Also:

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

search

Page<RecurringPaymentEntryVO> search(@NotNull
                                     @NotNull RecurringPaymentQuery query)
                              throws FrameworkException

Searches for recurring payments, according to the given query

Throws:

FrameworkException