org.cyclos.impl.banking

Interface AccountServiceLocal

All Superinterfaces:

AccountService, Service

public interface AccountServiceLocal
extends AccountService

Local interface for AccountService

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ACCOUNT_TYPE Script bind variable: the account type
static java.lang.String	ATTR_OWNER Script bind variable: the account owner (either an User or SystemAccountOwner)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accountNumberExistsOrIsReserved(AccountNumberConfiguration accountNumberConfiguration, java.lang.String accountNumber) Returns true if the given account number is used in an existing account or is reserved to be used for a pending user
boolean	canDispose(java.util.Collection<UserAccount> accounts) checks if the accounts can be disposed safely.
void	checkActive(Account account) Checks that the given account is active, throwing an IllegalActionException in case it is an inactive user account, or the owner is inactive
void	checkActive(AccountOwner owner) Checks that the given account owner is active, throwing an IllegalActionException in case it is a removed or pending user
ClosedAccountBalance	closeBalance(Account account) Closes the balance for the given account
void	createMissingOrActivateAccount(UserAccountType accountType, ProductOwner owner) Creates the account for the given account type if it still doesn't exists for the given ProductOwner, or activates it.
SystemAccount	createSystemAccount(SystemAccountType type) Creates a new system account
ExternalPaymentNegativeAmountReservation	dereserveAmount(ExternalPayment externalPayment) Cancels the amount reservation related to the given external payment
OrderAmountReservation	dereserveAmount(Order order) Cancels the amount reservation related to the given order
ScheduledPaymentInstallmentAmountReservation	dereserveAmount(ScheduledPaymentInstallment installment) Dereserves the amount for the given installment
PendingAuthorizationAmountReservation	dereserveAmountForAuthorization(BasePayment transaction) Dereserves the amount for the transaction which was previously awaiting authorization
void	disposeAccounts(User user, java.util.Collection<UserAccount> lostAccounts) Disables the given accounts of the given user. Note that the calling method is responsible for checking if this account really needs to be disposed (for example because it is associated via another product). The method does the following: cancel all user's webshop orders with any pending status.
void	disposeAllAccounts(User user) Disposes all users' accounts
void	fillTransSearchData(TransSearchData data, Account account, InternalAccountOwner accountOwner) Fills the given data with data common to transfer and transaction search.
Account	findByNumber(java.lang.String number) Returns the account with the given number
java.lang.String	generateNumber(AccountType type, InternalAccountOwner owner) Generates an unique account number for the given type and owner.
java.util.List<Account>	getAccountsByCurrency(Currency currency) Returns all the logged user accounts for the given currency
AccountStatusVO	getAccountStatus(Account account, java.util.Date date, RateVisibility rateVisibility) Returns the account status for the given account at the given time
java.util.List<AccountWithStatusVO>	getAccountsWithStatus(InternalAccountOwner accountOwner, java.util.Date date, java.util.Date receivedSince, boolean includeRates) Similar to list(InternalAccountOwner), but returns each account with the account status, at the given time point.
java.math.BigDecimal	getAvailableBalance(Account account, java.util.Date date) Returns the available balance for the given account at the given date
java.math.BigDecimal	getAvailableBalanceByAccountType(InternalAccountOwner accountOwner, AccountType accountType) Returns the available balance for the account that has the given account owner and type
java.math.BigDecimal	getAverageBalance(Account account, java.math.BigDecimal balanceDiff, DatePeriod period, boolean positive, java.math.BigDecimal freebase) Returns the balance average for the given account over the given period.
java.math.BigDecimal	getBalance(Account account, java.util.Date date) Returns the raw balance for the given account at the given time
org.cyclos.impl.utils.validation.Validator	getCanDisposeValidator() gets a Validator for checking if an account can be disposed.
java.math.BigDecimal	getCreditLimit(Account account, java.util.Date date) Returns the credit limit of the given account at the given date
AccountLimitLog	getLimitLog(Account account, java.util.Date date) Returns the limit log which is valid on the given time.
java.util.List<TransferStatusFlow>	getManagedFlows(Account account) Returns the managed transfer status flows for the logged user over the given account
java.lang.String	getOwnerName(Account account) Returns the owner name: if is a system account, get the system account type.
java.math.BigDecimal	getUpperCreditLimit(Account account, java.util.Date date) Returns the upper credit limit of the given account at the given date
java.util.List<UserAccountData>	getUserAccountsData(User user) Returns the user's accounts data visible in profile
java.util.List<TransferStatusFlow>	getVisibleFlows(Account account) Returns the visible transfer status flows for the logged user over the given account
boolean	hasAccess(Account account) Returns whether the given account is accessible by the logged user
boolean	hasTransfers(java.util.Set<UserAccountType> userAccounts, java.util.Set<Group> groups) Returns true if there is at least one transfer performed from or to a user of any of the specified groups, to or from any of the given accounts.
void	incrementBalanceCounter(Account account) Increments the counter for closing the given account's balance
boolean	isOnlyOwnPayments(AccountType account) Returns whether the logged user can only view payments performed / received by himself on the given account
<A extends Account> java.util.List<A>	list(InternalAccountOwner owner) Returns the available accounts for the given owner
<A extends Account> A	load(AccountLocator locator) Loads an account for the given locator, without checking permissions for the logged user
<A extends Account> A	load(InternalAccountOwner owner, AccountType type) Loads an account for the given owner / type, without checking permissions for the logged user
void	removeLastClosedAccountBalances(Transfer transfer) Removes all the closes from the initial date to now of the from and to account of the transfer
ExternalPaymentAmountReservation	reserveAmount(ExternalPayment externalPayment) Reserves the amount for the given external payment
OrderAmountReservation	reserveAmount(Order order) Reserves the amount for the given webshop order
ScheduledPaymentAmountReservation	reserveAmount(ScheduledPayment scheduledPayment) Reserves the total amount for the given scheduled payment
PendingAuthorizationAmountReservation	reserveAmountForAuthorization(BasePayment transaction) Reserves the amount for a given payment pending authorization
AccountWithStatusVO	toAccountWithStatus(Account account, java.util.Date date, java.util.Date paymentsSince, boolean includeRates) Converts the given account with AccountWithStatusVO, getting the status at the given time point.

Methods inherited from interface org.cyclos.services.banking.AccountService

exportToCSV, getAccountBalanceLimitsOverviewData, getAccountHistoriesOverviewData, getAccountHistoryData, getAccountHistoryStatus, getAccountsSummary, getAccountStatus, getUserAccountLimitData, getUserAccountsLimits, getUserWithBalanceSearchData, hasAccessibleAccounts, load, printAccountHistory, searchAccountBalanceLimitsOverview, searchAccountHistoriesOverview, searchAccountHistory, searchUsersWithBalances, setBalanceLimit

Field Detail

ATTR_ACCOUNT_TYPE

static final java.lang.String ATTR_ACCOUNT_TYPE

Script bind variable: the account type

See Also:

Constant Field Values

ATTR_OWNER

static final java.lang.String ATTR_OWNER

Script bind variable: the account owner (either an User or SystemAccountOwner)

See Also:

Constant Field Values

Method Detail

canDispose

boolean canDispose(java.util.Collection<UserAccount> accounts)
                   throws FrameworkException

checks if the accounts can be disposed safely. This is the case if an account does not have:

• pending loans
• open invoices
• a non zero balance
• reserved amounts
• payments scheduled from it

Returns:

false if any account in the list has one of the items in the list above; true if all the accounts may be abrogated.

Throws:

FrameworkException

checkActive

void checkActive(Account account)
                 throws FrameworkException

Checks that the given account is active, throwing an IllegalActionException in case it is an inactive user account, or the owner is inactive

Throws:

FrameworkException

See Also:

#checkActive(InternalAccountOwner)

checkActive

void checkActive(AccountOwner owner)
                 throws FrameworkException

Checks that the given account owner is active, throwing an IllegalActionException in case it is a removed or pending user

Throws:

FrameworkException

closeBalance

ClosedAccountBalance closeBalance(Account account)
                                  throws FrameworkException

Closes the balance for the given account

Throws:

FrameworkException

createMissingOrActivateAccount

void createMissingOrActivateAccount(UserAccountType accountType,
                                  ProductOwner owner)
                                    throws FrameworkException

Creates the account for the given account type if it still doesn't exists for the given ProductOwner, or activates it. If the account already exists and is active, does nothing

Throws:

FrameworkException

createSystemAccount

SystemAccount createSystemAccount(SystemAccountType type)
                                  throws FrameworkException

Creates a new system account

Throws:

FrameworkException

dereserveAmount

ExternalPaymentNegativeAmountReservation dereserveAmount(ExternalPayment externalPayment)

Cancels the amount reservation related to the given external payment

dereserveAmount

OrderAmountReservation dereserveAmount(Order order)
                                       throws FrameworkException

Cancels the amount reservation related to the given order

Throws:

FrameworkException

dereserveAmount

ScheduledPaymentInstallmentAmountReservation dereserveAmount(ScheduledPaymentInstallment installment)
                                                             throws FrameworkException

Dereserves the amount for the given installment

Throws:

IllegalActionException - When the given installment is not in a state which allows dereserving amount

FrameworkException

dereserveAmountForAuthorization

PendingAuthorizationAmountReservation dereserveAmountForAuthorization(BasePayment transaction)
                                                                      throws FrameworkException

Dereserves the amount for the transaction which was previously awaiting authorization

Throws:

IllegalActionException - When the given transfer is not in a state which allows returning the reserved amount

FrameworkException

disposeAccounts

void disposeAccounts(User user,
                   java.util.Collection<UserAccount> lostAccounts)
                     throws IllegalActionException

Disables the given accounts of the given user.
Note that the calling method is responsible for checking if this account really needs to be disposed (for example because it is associated via another product).

The method does the following:

• cancel all user's webshop orders with any pending status.
• delete all user's webshop orders which are still in a shopping cart
• cancel all scheduled payments to the account being lost, plus notification to users involved.
• remove or disable the account
• Check if the currency of the account is also lost, that is: not associated via another account of the same user. If the currency is also lost:
  • set all ads which refer via their price to this currency to status DISABLED
  • disable all user's delivery methods referring to the currency

Parameters:

user -

lostAccounts - the accounts to be disposed of

Throws:

IllegalActionException - if any of the accounts cannot be disposed of because of existing dependencies (scheduled payments, amount reservations, balances).

disposeAllAccounts

void disposeAllAccounts(User user)
                        throws FrameworkException

Disposes all users' accounts

Throws:

FrameworkException

accountNumberExistsOrIsReserved

boolean accountNumberExistsOrIsReserved(AccountNumberConfiguration accountNumberConfiguration,
                                      java.lang.String accountNumber)

Returns true if the given account number is used in an existing account or is reserved to be used for a pending user

fillTransSearchData

void fillTransSearchData(TransSearchData data,
                       Account account,
                       InternalAccountOwner accountOwner)
                         throws FrameworkException

Fills the given data with data common to transfer and transaction search. A source account can be provided to retrieve more specific data.

Throws:

FrameworkException

findByNumber

Account findByNumber(java.lang.String number)
                     throws FrameworkException

Returns the account with the given number

Throws:

EntityNotFoundException - If there are is no account with the given number

FrameworkException

generateNumber

java.lang.String generateNumber(AccountType type,
                              InternalAccountOwner owner)
                                throws FrameworkException

Generates an unique account number for the given type and owner. This method can not only be internally used when an account is created, but scripts could benefit from it to generate numbers for existing accounts.

Throws:

FrameworkException

getAccountsByCurrency

java.util.List<Account> getAccountsByCurrency(Currency currency)

Returns all the logged user accounts for the given currency

getAccountStatus

AccountStatusVO getAccountStatus(Account account,
                               java.util.Date date,
                               RateVisibility rateVisibility)
                                 throws FrameworkException

Returns the account status for the given account at the given time

Parameters:

rateVisibility - if null RateVisibility.NOT is used

Throws:

FrameworkException

getAccountsWithStatus

java.util.List<AccountWithStatusVO> getAccountsWithStatus(InternalAccountOwner accountOwner,
                                                        java.util.Date date,
                                                        java.util.Date receivedSince,
                                                        boolean includeRates)
                                                          throws FrameworkException

Similar to list(InternalAccountOwner), but returns each account with the account status, at the given time point.

Throws:

FrameworkException

getAvailableBalance

java.math.BigDecimal getAvailableBalance(Account account,
                                       java.util.Date date)
                                         throws FrameworkException

Returns the available balance for the given account at the given date

Throws:

FrameworkException

getAvailableBalanceByAccountType

java.math.BigDecimal getAvailableBalanceByAccountType(InternalAccountOwner accountOwner,
                                                    AccountType accountType)

Returns the available balance for the account that has the given account owner and type

getAverageBalance

java.math.BigDecimal getAverageBalance(Account account,
                                     java.math.BigDecimal balanceDiff,
                                     DatePeriod period,
                                     boolean positive,
                                     java.math.BigDecimal freebase)
                                       throws FrameworkException

Returns the balance average for the given account over the given period. It is calculated per day, having the balance at the end of each day, averaging by the number of days the balance was unchanged. It can be calculated either over positive or negative balances, and taking the free base into account (which is subtracted from each day's balance when calculating the total). If present, the balanceDiff is summed to the initial balance when performing calculations.

Throws:

FrameworkException

getBalance

java.math.BigDecimal getBalance(Account account,
                              java.util.Date date)
                                throws FrameworkException

Returns the raw balance for the given account at the given time

Throws:

FrameworkException

getCanDisposeValidator

org.cyclos.impl.utils.validation.Validator getCanDisposeValidator()
                                                                  throws FrameworkException

gets a Validator for checking if an account can be disposed.

Throws:

FrameworkException

See Also:

canDispose(Collection)

getCreditLimit

java.math.BigDecimal getCreditLimit(Account account,
                                  java.util.Date date)
                                    throws FrameworkException

Returns the credit limit of the given account at the given date

Throws:

FrameworkException

getLimitLog

AccountLimitLog getLimitLog(Account account,
                          java.util.Date date)
                            throws FrameworkException

Returns the limit log which is valid on the given time. When the time is null, the current time is assumed

Throws:

FrameworkException

getManagedFlows

java.util.List<TransferStatusFlow> getManagedFlows(Account account)
                                                   throws FrameworkException

Returns the managed transfer status flows for the logged user over the given account

Throws:

FrameworkException

getOwnerName

java.lang.String getOwnerName(Account account)
                              throws FrameworkException

Returns the owner name: if is a system account, get the system account type. otherwise, the name / username of the owner user

Throws:

FrameworkException

getUpperCreditLimit

java.math.BigDecimal getUpperCreditLimit(Account account,
                                       java.util.Date date)
                                         throws FrameworkException

Returns the upper credit limit of the given account at the given date

Throws:

FrameworkException

getUserAccountsData

java.util.List<UserAccountData> getUserAccountsData(User user)
                                                    throws FrameworkException

Returns the user's accounts data visible in profile

Throws:

FrameworkException

getVisibleFlows

java.util.List<TransferStatusFlow> getVisibleFlows(Account account)
                                                   throws FrameworkException

Returns the visible transfer status flows for the logged user over the given account

Throws:

FrameworkException

hasAccess

boolean hasAccess(Account account)
                  throws FrameworkException

Returns whether the given account is accessible by the logged user

Throws:

FrameworkException

hasTransfers

boolean hasTransfers(java.util.Set<UserAccountType> userAccounts,
                   java.util.Set<Group> groups)

Returns true if there is at least one transfer performed from or to a user of any of the specified groups, to or from any of the given accounts.

incrementBalanceCounter

void incrementBalanceCounter(Account account)
                             throws FrameworkException

Increments the counter for closing the given account's balance

Throws:

FrameworkException

isOnlyOwnPayments

boolean isOnlyOwnPayments(AccountType account)
                          throws FrameworkException

Returns whether the logged user can only view payments performed / received by himself on the given account

Throws:

FrameworkException

list

<A extends Account> java.util.List<A> list(InternalAccountOwner owner)
                                       throws FrameworkException

Returns the available accounts for the given owner

Throws:

FrameworkException

load

<A extends Account> A load(AccountLocator locator)
                       throws FrameworkException

Loads an account for the given locator, without checking permissions for the logged user

Throws:

FrameworkException

load

<A extends Account> A load(InternalAccountOwner owner,
                         AccountType type)
                       throws FrameworkException

Loads an account for the given owner / type, without checking permissions for the logged user

Throws:

FrameworkException

removeLastClosedAccountBalances

void removeLastClosedAccountBalances(Transfer transfer)

Removes all the closes from the initial date to now of the from and to account of the transfer

reserveAmount

ExternalPaymentAmountReservation reserveAmount(ExternalPayment externalPayment)
                                               throws InsufficientBalanceException

Reserves the amount for the given external payment

Throws:

InsufficientBalanceException - When there is not enough funds on the expected account to reserve

IllegalActionException - When the given external payment is not in a state which allows reserving amount

reserveAmount

OrderAmountReservation reserveAmount(Order order)
                                     throws FrameworkException,
                                            InsufficientBalanceException,
                                            IllegalActionException

Reserves the amount for the given webshop order

Throws:

InsufficientBalanceException - When there is not enough funds on the expected account to reserve

IllegalActionException - When the given order is not in a state which allows reserving amount

FrameworkException

reserveAmount

ScheduledPaymentAmountReservation reserveAmount(ScheduledPayment scheduledPayment)
                                                throws FrameworkException,
                                                       InsufficientBalanceException,
                                                       IllegalActionException

Reserves the total amount for the given scheduled payment

Throws:

InsufficientBalanceException - When there is not enough funds on the expected account to reserve

IllegalActionException - When the given scheduled payment is not in a state which allows reserving amount

FrameworkException

reserveAmountForAuthorization

PendingAuthorizationAmountReservation reserveAmountForAuthorization(BasePayment transaction)
                                                                    throws FrameworkException,
                                                                           InsufficientBalanceException,
                                                                           IllegalActionException

Reserves the amount for a given payment pending authorization

Throws:

InsufficientBalanceException - When there is not enough funds on the expected account to reserve

IllegalActionException - When the given transfer is not in a state which allows reserving amount

FrameworkException

toAccountWithStatus

AccountWithStatusVO toAccountWithStatus(Account account,
                                      java.util.Date date,
                                      java.util.Date paymentsSince,
                                      boolean includeRates)
                                        throws FrameworkException

Converts the given account with AccountWithStatusVO, getting the status at the given time point. If paymentsSince is not null, will also return the sum of incoming payments since the given date

Throws:

FrameworkException