org.cyclos.services.banking

Interface PaymentService

All Superinterfaces:

Service

All Known Subinterfaces:

PaymentServiceLocal

public interface PaymentService
extends Service

Service interface to perform payments and for searching and retrieve information about a payment. A payment is a transaction, and performing a payment normally starts by using TransactionService.getPaymentData(org.cyclos.model.banking.accounts.AccountOwner, org.cyclos.model.banking.accounts.AccountOwner). Then, at a certain point, the user can preview(PerformPaymentDTO) and eventually perform(PerformPaymentDTO) the payment.

Author:

luis

See Also:

TransactionService, ScheduledPaymentService

Method Summary

Methods

Modifier and Type	Method and Description
PaymentData	getData(java.lang.Long id) Returns data about a payment
PaymentVO	perform(PerformPaymentDTO parameters) Performs a payment, according to the given parameters, returning the resulting payment.
PaymentPreviewVO	preview(PerformPaymentDTO parameters) Previews a payment to be performed
PaymentPreviewVO	previewReceive(PerformPaymentDTO parameters) Previews a payment to be received
SerializableInputStream	print(java.lang.Long id) Generates a PDF file with the details for a payment.
PaymentVO	receive(PerformPaymentDTO parameters) Receives a payment, according to the given parameters, returning the resulting payment.
Page<PaymentEntryVO>	search(PaymentQuery query) Searches for payments, according to the given query

Method Detail

getData

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

Returns data about a payment

Throws:

FrameworkException

perform

PaymentVO perform(PerformPaymentDTO parameters)
                  throws FrameworkException,
                         TransferException,
                         PasswordException

Performs a payment, according to the given parameters, returning the resulting payment.

Throws:

InsufficientBalanceException - When the source account, or source account for any generated fee is limited and had insufficient balance for such a payment

MaxAmountPerDayExceededException - When the maximum amount for payments of this transfer type has been exceeded, according to the transfer type configuration

UpperCreditLimitReachedException - When the destination account, or destination account for any generated fee is limited and would have more balance than the allowed maximum

PasswordException - When the confirmation password doesn't match

FrameworkException

TransferException

preview

PaymentPreviewVO preview(PerformPaymentDTO parameters)
                         throws FrameworkException,
                                TransferException

Previews a payment to be performed

Throws:

FrameworkException

TransferException

previewReceive

PaymentPreviewVO previewReceive(PerformPaymentDTO parameters)
                                throws FrameworkException,
                                       TransferException

Previews a payment to be received

Throws:

FrameworkException

TransferException

print

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

Generates a PDF file with the details for a payment.

Throws:

ReportExecutionException - if there is an error generating the PDF.

FrameworkException

receive

PaymentVO receive(PerformPaymentDTO parameters)
                  throws FrameworkException,
                         TransferException

Receives a payment, according to the given parameters, returning the resulting payment.

Throws:

FrameworkException

TransferException

See Also:

perform(PerformPaymentDTO)

search

Page<PaymentEntryVO> search(PaymentQuery query)
                            throws FrameworkException

Searches for payments, according to the given query

Throws:

FrameworkException