org.everit.osgi.balance.api

Interface BalanceAccountService

public interface BalanceAccountService

Service interface for balance account management.

Method Summary

Modifier and Type	Method and Description
long	activateAccount(long accountId) Activates an inactive account.
long	createAccount(Long ownerResourceId, boolean active) Creates an active/inactive account.
long	deactivateAccount(long accountId) Deactivates an active account.
BalanceAccount	findAccountById(long accountId) Finds an account by its id.
BalanceAccount	findAccountByResourceId(long resourceId) Finds an account by its resource id.
org.everit.commons.selection.LimitedResult<BalanceAccount>	findAccountsByOwnerResourceId(Long ownerResourceId, org.everit.commons.selection.Limit limit) Returns the LimitedResult of accounts ordered by accountId.
long[]	lockAccounts(long... accountIds) Locks the given accounts to be able to create transfers on them.

Method Detail

activateAccount

long activateAccount(long accountId)

Activates an inactive account.

Parameters:

accountId - the ID of the account to activate.

Returns:

the number of activated accounts

createAccount

long createAccount(Long ownerResourceId,
                   boolean active)

Creates an active/inactive account.

Parameters:

ownerResourceId - The resource ID of the owner of the account, if null a new resource will be created.

active - To create an active or an inactive account.

Returns:

The ID of the created account.

deactivateAccount

long deactivateAccount(long accountId)

Deactivates an active account.

Parameters:

accountId - The ID of the account to deactivate.

Returns:

the number of activated accounts

findAccountById

BalanceAccount findAccountById(long accountId)

Finds an account by its id.

Parameters:

accountId - The id of the account to be found.

Returns:

An BalanceAccount or null if there is no matches.

findAccountByResourceId

BalanceAccount findAccountByResourceId(long resourceId)

Finds an account by its resource id.

Parameters:

resourceId - the resource id of the account to be found

Returns:

the account or null if there is no matches

findAccountsByOwnerResourceId

org.everit.commons.selection.LimitedResult<BalanceAccount> findAccountsByOwnerResourceId(Long ownerResourceId,
                                                                                         org.everit.commons.selection.Limit limit)

Returns the LimitedResult of accounts ordered by accountId.

Parameters:

ownerResourceId - The resource ID of the owner of the interested accounts or null if all accounts are interested.

limit - the limit of the query, cannot be null

Returns:

The LimitedResult of accounts.

lockAccounts

long[] lockAccounts(long... accountIds)

Locks the given accounts to be able to create transfers on them. This method must be invoked before a balance of an account will be changed by calling the following methods:

• BalanceTransferService.createInstantTransfer(String, long, long, java.math.BigDecimal, String)
• BalanceTransferService.createBlockedTransfer(String, long, long, java.math.BigDecimal, String)
• BalanceTransferService.acceptBlockedTransfer(long)
• BalanceTransferService.rejectBlockedTransfer(long)

Note 1: A transaction must be available (mandatory) while calling this method, otherwise an exception will be thrown!

Note 2: A deadlock could happen if this method is invoked from different places at the same time!

Parameters:

accountIds - the ID of the accounts to lock

Returns:

the locked account IDs