org.cyclos.services.banking

Interface ScheduledPaymentService

All Superinterfaces:

Service

public interface ScheduledPaymentService
extends Service

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

Author:

luis

See Also:

TransactionService, PaymentService

Method Summary

Modifier and Type	Method and Description
void	block(ScheduledPaymentActionDTO params) Blocks the given scheduled payment, so installments won't be processed on their respective due dates
java.util.List<ScheduledPaymentInstallmentDTO>	calculateInstallments(CalculateInstallmentsDTO dto) Calculates future installments for the given parameters
java.util.List<ScheduledPaymentInstallmentDTO>	calculateInstallmentsReceive(CalculateInstallmentsDTO dto) Calculates future installments for the given parameters on a receive payment
void	cancel(ScheduledPaymentActionDTO params) Permanently cancels the given scheduled payment, so installments will never be processed
ScheduledPaymentData	getData(java.lang.Long id) Returns data about a scheduled payment
ScheduledPaymentVO	perform(PerformScheduledPaymentDTO scheduledPayment) Performs an scheduled payment, returning its data
ScheduledPaymentPreviewVO	preview(PerformScheduledPaymentDTO parameters) Previews a scheduled payment to be performed
ScheduledPaymentPreviewVO	previewReceive(PerformScheduledPaymentDTO parameters) Previews a scheduled payment to be received
SerializableInputStream	print(java.lang.Long id) Generates a PDF file with the details of a scheduled payment.
SerializableInputStream	printScheduledPayments(ScheduledPaymentQuery query) Generates a PDF with the scheduled payment list result.
java.lang.Long	processInstallment(ScheduledPaymentInstallmentActionDTO params) Process the given installment if it's status is not terminal, returning the resulting transfer id
ScheduledPaymentVO	receive(PerformScheduledPaymentDTO scheduledPayment) Receives a scheduled payment, returning its data
Page<ScheduledPaymentEntryVO>	search(ScheduledPaymentQuery query) Searches for scheduled payments, according to the given query
Page<ScheduledPaymentInstallmentEntryVO>	searchInstallments(ScheduledPaymentInstallmentQuery query) Searches for scheduled payment installments, according to the given query
void	settleInstallment(ScheduledPaymentInstallmentActionDTO params) Marks the given installment status as ScheduledPaymentInstallmentStatus.SETTLED if the status is not terminal.
void	settleRemaining(ScheduledPaymentActionDTO params) Marks all installments whose status is not terminal as ScheduledPaymentInstallmentStatus.SETTLED, and closes the scheduled payment
void	unblock(ScheduledPaymentActionDTO params) Unlocks the given scheduled payment, so installments will be processed on their respective due dates

Method Detail

block

void block(@NotNull
           ScheduledPaymentActionDTO params)
    throws FrameworkException

Blocks the given scheduled payment, so installments won't be processed on their respective due dates

Throws:

FrameworkException

calculateInstallments

java.util.List<ScheduledPaymentInstallmentDTO> calculateInstallments(@NotNull
                                                                     CalculateInstallmentsDTO dto)
                                                              throws FrameworkException

Calculates future installments for the given parameters

Throws:

FrameworkException

calculateInstallmentsReceive

java.util.List<ScheduledPaymentInstallmentDTO> calculateInstallmentsReceive(@NotNull
                                                                            CalculateInstallmentsDTO dto)
                                                                     throws FrameworkException

Calculates future installments for the given parameters on a receive payment

Throws:

FrameworkException

cancel

void cancel(@NotNull
            ScheduledPaymentActionDTO params)
     throws FrameworkException

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

Throws:

FrameworkException

getData

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

Returns data about a scheduled payment

Throws:

FrameworkException

perform

ScheduledPaymentVO perform(@NotNull
                           PerformScheduledPaymentDTO scheduledPayment)
                    throws TransferException,
                           FrameworkException

Performs an scheduled payment, returning its data

Throws:

TransferException

FrameworkException

See Also:

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

preview

ScheduledPaymentPreviewVO preview(@NotNull
                                  PerformScheduledPaymentDTO parameters)
                           throws FrameworkException

Previews a scheduled payment to be performed

Throws:

FrameworkException

previewReceive

ScheduledPaymentPreviewVO previewReceive(@NotNull
                                         PerformScheduledPaymentDTO parameters)
                                  throws FrameworkException

Previews a scheduled payment to be received

Throws:

FrameworkException

print

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

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

Throws:

FrameworkException

ReportExecutionException

printScheduledPayments

SerializableInputStream printScheduledPayments(@NotNull
                                               ScheduledPaymentQuery query)

Generates a PDF with the scheduled payment list result.

processInstallment

java.lang.Long processInstallment(@NotNull
                                  ScheduledPaymentInstallmentActionDTO params)
                           throws TransferException,
                                  FrameworkException

Process the given installment if it's status is not terminal, returning the resulting transfer id

Throws:

TransferException

FrameworkException

See Also:

ScheduledPaymentInstallmentStatus.isTerminal()

receive

ScheduledPaymentVO receive(@NotNull
                           PerformScheduledPaymentDTO scheduledPayment)
                    throws TransferException,
                           PosPayerException,
                           FrameworkException

Receives a scheduled payment, returning its data

Throws:

TransferException

PosPayerException

FrameworkException

See Also:

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

search

Page<ScheduledPaymentEntryVO> search(@NotNull
                                     ScheduledPaymentQuery query)
                              throws FrameworkException

Searches for scheduled payments, according to the given query

Throws:

FrameworkException

searchInstallments

Page<ScheduledPaymentInstallmentEntryVO> searchInstallments(@NotNull
                                                            ScheduledPaymentInstallmentQuery query)
                                                     throws FrameworkException

Searches for scheduled payment installments, according to the given query

Throws:

FrameworkException

settleInstallment

void settleInstallment(@NotNull
                       ScheduledPaymentInstallmentActionDTO params)
                throws FrameworkException

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

Throws:

FrameworkException

See Also:

ScheduledPaymentInstallmentStatus.isTerminal()

settleRemaining

void settleRemaining(@NotNull
                     ScheduledPaymentActionDTO params)
              throws FrameworkException

Marks all installments whose status is not terminal as ScheduledPaymentInstallmentStatus.SETTLED, and closes the scheduled payment

Throws:

FrameworkException

See Also:

ScheduledPaymentInstallmentStatus.isTerminal()

unblock

void unblock(@NotNull
             ScheduledPaymentActionDTO params)
      throws FrameworkException

Unlocks the given scheduled payment, so installments will be processed on their respective due dates

Throws:

FrameworkException