org.everit.osgi.balance.api

Interface BalanceTransferService

public interface BalanceTransferService

Service interface for balance transfer management.

Method Summary

Modifier and Type	Method and Description
void	acceptBlockedTransfer(long transferId) Accepts the given transfer.
long	createBlockedTransfer(String transferCode, long creditorAccountId, long debtorAccountId, BigDecimal amount, String notes) Creates a new transfer with status TransferStatus.BLOCKED.
long	createInstantTransfer(String transferCode, long creditorAccountId, long debtorAccountId, BigDecimal amount, String notes) Creates two new transfer with status TransferStatus.SUCCESSFUL.
BalanceTransfer	findTransferById(long transferId)
org.everit.commons.selection.LimitedResult<BalanceTransfer>	findTransfers(TransferFilter filter, TransferOrder order, org.everit.commons.selection.Limit limit) Finds the transfers based on the parameters.
BalanceTransfer[]	findTransfersByPairId(String transferPairId)
void	rejectBlockedTransfer(long transferId) Rejects the given transfer.

Method Detail

acceptBlockedTransfer

void acceptBlockedTransfer(long transferId)

Accepts the given transfer. The following steps must be done in one transaction:

• the creditor and debtor accounts must be locked
• the status of the accepted transfer must equal to TransferStatus.BLOCKED
• the status of the accepted transfer must be changed to TransferStatus.SUCCESSFUL
• a new TransferStatus.SUCCESSFUL transfer must be created with reversed accounts and opposite sign of credit amount
• the balances of the accounts must be recalculated

Parameters:

transferId - The ID of the transfer to accept.

createBlockedTransfer

long createBlockedTransfer(String transferCode,
                           long creditorAccountId,
                           long debtorAccountId,
                           BigDecimal amount,
                           String notes)

Creates a new transfer with status TransferStatus.BLOCKED. The following steps must be done in one transaction:

• the creditor account must be locked
• a new TransferStatus.BLOCKED transfer must be created with the given parameters
• the balances of the creditor account must be recalculated

Parameters:

transferCode - The external code of the transfer to support filtering and grouping certain transfers.

creditorAccountId - The ID of the creditor account.

debtorAccountId - The ID of the debtor account.

amount - The amount of the transfered credit. Must be a positive number. Cannot be null.

notes - The notes belonging of the transfer.

Returns:

The ID of the created transfer.

createInstantTransfer

long createInstantTransfer(String transferCode,
                           long creditorAccountId,
                           long debtorAccountId,
                           BigDecimal amount,
                           String notes)

Creates two new transfer with status TransferStatus.SUCCESSFUL. The following steps must be done in one transaction:

• the creditor and debtor accounts must be locked
• a new TransferStatus.SUCCESSFUL transfer must be created with the given parameters
• another new TransferStatus.SUCCESSFUL transfer must be created with reversed accounts and opposite sign of credit amount
• the balances of the accounts must be recalculated

Parameters:

transferCode - The external code of the transfer to support filtering and grouping certain transfers.

creditorAccountId - The ID of the creditor account.

debtorAccountId - The ID of the debtor account.

amount - The amount of the transfered credit. Must be a positive number. Cannot be null.

notes - The notes belonging of the transfer.

Returns:

the ID of the created credit transfer

findTransferById

BalanceTransfer findTransferById(long transferId)

findTransfers

org.everit.commons.selection.LimitedResult<BalanceTransfer> findTransfers(TransferFilter filter,
                                                                          TransferOrder order,
                                                                          org.everit.commons.selection.Limit limit)

Finds the transfers based on the parameters. All primitive properties of the returned BalanceTransfer instances will be returned, furthermore the Id property of the creditor account and the debtor account will also be loaded, but the further properties of the accounts won't be queried.

Parameters:

filter - Filter parameters for listing transfers.

order - The desired ordering of the result list. Cannot be null.

limit - The Limit of the query. Cannot be null.

Returns:

the transfers

findTransfersByPairId

BalanceTransfer[] findTransfersByPairId(String transferPairId)

rejectBlockedTransfer

void rejectBlockedTransfer(long transferId)

Rejects the given transfer. The following steps must be done in one transaction:

• the creditor account must be locked
• the status of the rejected transfer must equal to TransferStatus.BLOCKED
• the status of the rejected transfer must be changed to TransferStatus.REJECTED
• the balances of the creditor account must be recalculated

Parameters:

transferId - The ID of the transfer to reject.