Generated by
JDiff

org.cyclos.services.banking Documentation Differences

This file contains all the changes in documentation in the package org.cyclos.services.banking as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class ChargebackService, Long chargeback(TransferActionDTO)

Performs the chargeback for the given transfer, returning the chargeback id. The chargeback transfer is from / toto the same original transfer, but the amount is negative @throws IllegalActionException When the given transfer has already been charged back @throws InsufficientBalanceException When the source account, or source account for any generated fee is limitedlimited and had insufficient balance for such a payment @throws MaxAmountPerDayExceededException When the maximum amount for payments of this transfer type has beenbeen exceeded, according to the transfer type configuration @throws UpperCreditLimitReachedException When the destination account, or destination account for any generatedgenerated fee is limited and would have more balance than the allowed maximum

Class PaymentService

Service interface to perform payments and for searching and retrieve information about a payment. A payment is aa transaction, and performing a 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 .preview(PerformPaymentDTO) and eventuallyeventually .perform(PerformPaymentDTO) the payment. @see TransactionService @see ScheduledPaymentService @author luis
Class PaymentService, PaymentVO perform(PerformPaymentDTO)

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 limitedlimited and had insufficient balance for such a payment @throws MaxAmountPerDayExceededException When the maximum amount for payments of this transfer type has beenbeen exceeded, according to the transfer type configuration @throws UpperCreditLimitReachedException When the destination account, or destination account for any generatedgenerated fee is limited and would have more balance than the allowed maximum @throws PasswordException When the confirmation password doesn't match

Class ScheduledPaymentService

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. @see TransactionService @see PaymentService @author luis
Class ScheduledPaymentService, void settleInstallment(ScheduledPaymentInstallmentActionDTO)

Marks the given installment status as ScheduledPaymentInstallmentStatus.SETTLED if the status is notnot terminal. @see ScheduledPaymentInstallmentStatus#isTerminal()
Class ScheduledPaymentService, void settleRemaining(ScheduledPaymentActionDTO)

Marks all installments whose status is not terminal as ScheduledPaymentInstallmentStatus.SETTLED, andand closes the scheduled payment @see ScheduledPaymentInstallmentStatus#isTerminal()

Class TransactionAuthorizationService, void authorize(TransactionAuthorizationDTO)

Authorizes a payment pending authorization @throws IllegalActionException The payment is not on a state which can be authorized or was already authorized byby the logged user, even if it would be possible (through multiple roles) to authorize again
Class TransactionAuthorizationService, void cancel(TransactionAuthorizationDTO)

Cancels a payment pending authorization @throws IllegalActionException The payment is not on a state which can be canceled, or is part of a scheduledscheduled payment (instead, the entire scheduled payment should be canceled)

Class TransactionService, Page<MaturityTableItemData> getMaturityTable(MaturityTableQuery)

returns the maturity table which the user can view in case of paying with a zero d-rate of an earlier account state, when when MaturityPolicy.HISTORY is valid.
Class TransactionService, ReceivePaymentFromUserData getReceivePaymentFromUserData(UserLocatorVO)

Returns data used to receive a payment from a specific user @throws UserNotInPosChannelExceptionPosPayerNotInChannelException When the chosen user doesn't have the POS channel enabled (either by preference or permission)
Class TransactionService, PerformPaymentTypeData getReceivePaymentTypeData(UserLocatorVO, TransferTypeVO)

Returns the data related to a payment type for receiving a payment from a specific user and payment type @throws UserNotInPosChannelExceptionPosPayerNotInChannelException When the chosen user doesn't have the POS channel enabled (either by preference or permission)

Class TransferService

Service which allows access to transfers and scheduled payments. Not to confuse with PaymentService, which isis used to perform the payments. @author luis

Class VoucherService, VouchersSearchData getSearchData(VoucherSearchContext, UserLocatorVO)

Returns data for searching vouchers, either over an user or for a general search