Package org.cyclos.impl.banking

Class AccountServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.banking.AccountServiceImpl

All Implemented Interfaces:

AccountServiceLocal, AccountService, Service

@Service
public class AccountServiceImpl
extends BaseServiceImpl
implements AccountServiceLocal

implementation for AccountService

Nested Class Summary

Nested classes/interfaces inherited from interface org.cyclos.impl.banking.AccountServiceLocal

AccountServiceLocal.AdjustAccountsResult

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

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

MAX_BALANCE_HISTORY_DATAPOINTS

Fields inherited from interface org.cyclos.impl.banking.AccountServiceLocal

ATTR_ACCOUNT, ATTR_ACCOUNT_TYPE, ATTR_OWNER, EXPORT, POSSIBLE_STATUSES_TO_OWN_ACCOUNTS

Constructor Summary

Constructors

Constructor	Description
AccountServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	accountNumberExistsOrIsReserved(AccountNumberConfiguration accountNumberConfiguration, 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
AccountServiceLocal.AdjustAccountsResult	adjustAccounts(User user, boolean allowInitialCredit)	Creates / disposes accounts for the given user, optionally allowing initial credit
void	checkActive(Account account)	If the given account is not active, throws an IllegalActionException
void	checkActive(AccountOwner owner)	If the given owner is a user which is either pending or removed, throes an IllegalActionException
void	checkAvailableBalance(Account account, BigDecimal amount)	Checks that the given account has enough balance for performing a payment with the given amount.
SystemAccount	createSystemAccount(SystemAccountType type)	Creates a new system account
ExternalPaymentAmountReservation	dereserveAmount(ExternalPayment externalPayment)	Cancels the amount reservation related to the given external payment
InstallmentAmountReservation	dereserveAmount(ScheduledPaymentInstallment installment)	Dereserves the amount for the given installment
OrderAmountReservation	dereserveAmount(Order order)	Cancels the amount reservation related to the given order
PendingAuthorizationAmountReservation	dereserveAmountForAuthorization(BasePayment transaction)	Dereserves the amount for the transaction which was previously awaiting authorization
VoucherAmountReservation	dereserveAmountIfNeeded(Voucher voucher)	If the voucher pack had an amount reservation, dereserve the amount for the given voucher
VoucherRedeemAmountReservation	dereserveAmountIfNeeded(VoucherRedeem voucherRedeem)	If the voucher pack had an amount reservation, dereserve the amount for the given voucher redeem
FileInfo	exportAccountBalanceLimitsOverview(@NotNull ExportFormatVO formatVO, @NotNull AccountBalanceLimitsOverviewQuery params)	Generates a file with the query result listing the account balance limits
FileInfo	exportAccountHistoriesOverview(@NotNull ExportFormatVO formatVO, @NotNull AccountHistoriesOverviewQuery params)	Exports the account histories overview result to file
FileInfo	exportAccountHistory(@NotNull ExportFormatVO formatVO, @NotNull AccountHistoryQuery params)	Exports the account history result to file
FileInfo	exportAccountPaymentAmountLimitsOverview(@NotNull ExportFormatVO formatVO, @NotNull AccountPaymentAmountLimitsOverviewQuery params)	Generates a file with the query result listing the account balance limits
FileInfo	exportUsersWithBalances(@NotNull ExportFormatVO formatVO, @NotNull UserWithBalanceQuery params)	Generates a file with the query result listing the user balances
void	fillTransSearchData(ITransSearchData data, Account account, InternalAccountOwner accountOwner, ExportFormatContext exportContext)	Fills the given data with data common to transfer and transaction search.
Account	findByNumber(String number)	Returns the account with the given number
String	generateNumber(AccountType type, InternalAccountOwner owner)	Generates an unique account number for the given type and owner.
AccountBalanceHistoryVO	getAccountBalanceHistory(@NotNull AccountBalanceHistoryParams params)	Returns the balance at each data point for a given account.
AccountLimitsOverviewData	getAccountBalanceLimitsOverviewData()	Account limits (balance and payment amounts) overview data for performing searches.
AccountHistoriesOverviewData	getAccountHistoriesOverviewData()	Gets the details for viewing an account histories overview
AccountHistoriesOverviewStatusVO	getAccountHistoriesOverviewStatus(AccountHistoriesOverviewQuery params)	Returns the statuses by currency for the result of searching transactions with the given parameters
AccountHistoryData	getAccountHistoryData(AccountVO accountVO, RateVisibility rateVisibility)	Gets the details for viewing an account history
AccountHistoryStatusVO	getAccountHistoryStatus(Account account, AccountHistoryQuery params)	Returns historic status for the account
AccountWithHistoryStatusVO	getAccountHistoryStatus(AccountHistoryQuery params)	Returns historic status for the account
AccountLimitsOverviewData	getAccountPaymentAmountLimitsOverviewData()	Account limits (balance and payment amounts) overview data for performing searches.
List<AccountWithStatusVO>	getAccountsSummary(InternalAccountOwner owner, DateTime dateTime)	Lists the visible accounts summary for the given account owner, with balances relative to the given date
AccountStatusVO	getAccountStatus(Account account, Date time, RateVisibility includeRates)	Returns the account status for the given account at the given time
AccountStatusVO	getAccountStatus(AccountVO accountVO, DateTime dateTime, RateVisibility includeRates)	Gets the status for the given account
List<AccountWithStatusVO>	getAccountsWithStatus(InternalAccountOwner accountOwner, Date date, Date receivedSince, boolean includeRates)	Similar to AccountServiceLocal.listVisible(InternalAccountOwner), but returns each account with the account status, at the given time point.
AccountWithStatusVO	getAccountWithStatus(AccountVO vo, DateTime dateTime)	Returns the information of an account, with its status, by owner and type
OrderAmountReservation	getAmountDereservation(Order order)	Returns the OrderAmountReservation that canceled the order reserved amount, or null if none
PendingAuthorizationAmountReservation	getAmountDereservationForAuthorization(BasePayment transaction)	Returns the PendingAuthorizationAmountReservation created when a payment was no longer pending authorization, or null if none
OrderAmountReservation	getAmountReservation(Order order)	Returns the OrderAmountReservation that reserved amount when the order was submitted, or null if none
PendingAuthorizationAmountReservation	getAmountReservationForAuthorization(BasePayment transaction)	Returns the PendingAuthorizationAmountReservation created when a payment was submitted for authorization, or null if none
BigDecimal	getAvailableBalance(Account account, Date date)	Returns the available balance for the given account at the given date
BigDecimal	getAverageBalance(Account account, BigDecimal balanceDiff, DatePeriod period, boolean positive, BigDecimal freebase)	Returns the balance average for the given account over the given period.
BigDecimal	getBalance(Account account, Date date)	Returns the raw balance for the given account at the given time
AccountBalanceLimitLog	getBalanceLimitLog(Account account, Date date)	Returns the limit log which is valid on the given time.
BigDecimal	getCreditLimit(Account account, Date date)	Returns the credit limit of the given account at the given date
BigDecimal	getCurrentAvailableBalance(Account account, NativeAccountStatus status)	Returns the available balance for the given account, given that the native account status was already fetched
FrontendDashboardAccountVO	getFrontendDashbordAcccount(Account account, int lastTransfers)	Returns data for an account to be used in the new frontend dashboard
List<TransferStatusFlow>	getManagedFlows(Account account)	Returns the managed transfer status flows for the logged user over the given account
NativeAccountStatus	getNativeAccountStatus(Account account, Date date)	Returns the native account status for the given account
String	getOwnerName(Account account)	Returns the owner name: if is a system account, get the system account type.
AccountPermissionsData	getPermissions(@NotNull AccountVO accountVO)	Returns permissions of what the logged user can do over the given account
AccountPermissionsData	getPermissions(Account account)	Returns permissions of what the logged user can do over the given account
RestrictedOperatorAccessibleAccounts	getRetrictedOperatorAccessibleAccounts()	Returns which owner user accounts types are accessible and how by the logged restricted operator.
BigDecimal	getUpperCreditLimit(Account account, Date date)	Returns the upper credit limit of the given account at the given date
UserAccountBalanceLimitData	getUserAccountBalanceLimitData(AccountVO accountVO)	Get an account limit data
UserAccountPaymentAmountLimitData	getUserAccountPaymentAmountLimitData(@NotNull AccountVO accountVO)	Get an account payment amount limit data
List<AccountBalanceLimitVO>	getUserAccountsBalanceLimits(UserLocatorVO userLocator)	Returns the user accounts with their upper and lower balance limits
List<UserAccountData>	getUserAccountsData(User user)	Returns the user's accounts data visible in profile
List<AccountPaymentAmountLimitVO>	getUserAccountsPaymentAmountLimits(@NotNull UserLocatorVO userLocator)	Returns the user accounts with their upper and lower balance limits
UsersWithBalancesOverview	getUsersWithBalancesOverview(UserWithBalanceQuery params)	Returns the overview of users with balances according to the given query
UserWithBalanceSearchData	getUserWithBalanceSearchData()	Returns data to search for users with balances
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	hasVisibility(Account account)	Returns whether the given account is visible by the logged user or not. An account is visible if it's accessible and the associated AccountAccessibility allow view it.
boolean	isActive(IAccount account)	Returns whether the given account is active.
<A extends Account> List<A>	listVisible(InternalAccountOwner owner)	Returns the visible accounts for the given owner.
<A extends AccountType> List<A>	listVisibleTypes(InternalAccountOwner owner)	Calls listVisible(), but projecting each account type
AccountWithCurrencyVO	load(Long id)	Loads an account by id
<A extends Account> A	load(AccountLocator locator)	Loads an account for the given locator, without checking permissions for the logged user For user accounts, if the account is not found yet, returns a transient account.
<A extends Account> A	load(InternalAccountOwner owner, AccountType type)	Loads an account for the given owner / type, without checking permissions for the logged user For user accounts, if the account is not found yet, returns a transient account.
<A extends Account> A	load(InternalAccountOwner owner, AccountType type, boolean allowDisposed)	Loads an account for the given owner / type, without checking permissions for the logged user.
void	makeBalanceDirty(Account account, Transfer transfer)	Marks the balance of the given account as dirty for given transfer.
protected void	persist(IEntity entity)
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeLastClosedAccountBalances(Transfer transfer)	Removes all the closes from the initial date to now of the from and to account of the transfer.
<A extends Account> A	require(InternalAccountOwner owner, AccountType type)	Loads an account for the given owner / type, without checking permissions for the logged user.
CustomAmountReservation	reserveAmount(Account account, BigDecimal amount)	Reserves the given amount for an account checking its available balance. WARNING: Intended to be used via scripts (it can't be removed after a static analysis).
CustomAmountReservation	reserveAmount(Account account, BigDecimal amount, boolean ignoreAccountLimits)	Reserves the given amount for an account ignoring the limits only if ignoreAccountLimits is true. WARNING: Intended to be used via scripts (it can't be removed after a static analysis).
ExternalPaymentAmountReservation	reserveAmount(ExternalPayment externalPayment)	Reserves the amount for the given external payment
ScheduledPaymentAmountReservation	reserveAmount(ScheduledPayment scheduledPayment)	Reserves the total amount for the given scheduled payment
OrderAmountReservation	reserveAmount(Order order)	Reserves the amount for the given webshop order
PendingAuthorizationAmountReservation	reserveAmountForAuthorization(PerformTransactionDTO performTransaction, BasePayment transaction)	Reserves the amount for a pending by authorization payment created from the given DTO.
VoucherUnblockAmountReservation	reserveAmountForUnblocking(Voucher voucher)	Reserves the amount for unblocking a blocked voucher
VoucherPackAmountReservation	reserveAmountIfNeeded(VoucherPack pack)	Reserves the total amount for the given voucher pack (count * amount) on the source account of the redeem type, if that account is limited.
List<PeriodPreselectorOptionData>	resolvePreselectedPeriods()	Resolve the available preselected periods for the logged user configuration
Page<AccountBalanceLimitVO>	searchAccountBalanceLimitsOverview(AccountBalanceLimitsOverviewQuery params)	Overview search of account balance limits
Page<AccountHistoryOverviewEntryVO>	searchAccountHistoriesOverview(AccountHistoriesOverviewQuery params)	Account histories overview filtered by the specified query parameters.
Page<AccountHistoryEntryVO>	searchAccountHistory(AccountHistoryQuery params)	Searches the history entries of a required visible account according to the given query parameters.
Page<AccountPaymentAmountLimitVO>	searchAccountPaymentAmountLimitsOverview(@NotNull AccountPaymentAmountLimitsOverviewQuery params)	Overview search of account balance limits
Page<UserWithBalanceVO>	searchUsersWithBalances(UserWithBalanceQuery params)	Searches for users together with their respective account balances
void	setBalanceLimit(AccountBalanceLimitDTO dto)	Change limits of an account
void	setPaymentAmountLimit(@NotNull AccountPaymentAmountLimitDTO dto)	Change limits of an account
boolean	shouldAdjustAccountsWhenAssigning(MemberProduct product)	Indicates whether user accounts should be adjusted if the given member product is assigned to a group / group set
AccountWithStatusVO	toAccountWithStatus(Account account, Date date, Date paymentsSince, boolean includeRates)	Converts the given account with AccountWithStatusVO, getting the status at the given time point.
void	updateBalance(Account account, BigDecimal balance, Long[] dirtyTransferIds)	Updates the current account balance.

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cyclos.impl.banking.AccountServiceLocal

adjustAccounts, hasAccess

Constructor Detail

AccountServiceImpl

public AccountServiceImpl()

Method Detail

accountNumberExistsOrIsReserved

public boolean accountNumberExistsOrIsReserved(AccountNumberConfiguration accountNumberConfiguration,
                                               String accountNumber)

Description copied from interface: AccountServiceLocal

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

Specified by:

accountNumberExistsOrIsReserved in interface AccountServiceLocal

adjustAccounts

public AccountServiceLocal.AdjustAccountsResult adjustAccounts(User user,
                                                               boolean allowInitialCredit)

Description copied from interface: AccountServiceLocal

Creates / disposes accounts for the given user, optionally allowing initial credit

Specified by:

adjustAccounts in interface AccountServiceLocal

checkActive

public void checkActive(Account account)
                 throws IllegalActionException

Description copied from interface: AccountServiceLocal

If the given account is not active, throws an IllegalActionException

Specified by:

checkActive in interface AccountServiceLocal

Throws:

IllegalActionException

See Also:

#isActive(Account)

checkActive

public void checkActive(AccountOwner owner)
                 throws IllegalActionException

Description copied from interface: AccountServiceLocal

If the given owner is a user which is either pending or removed, throes an IllegalActionException

Specified by:

checkActive in interface AccountServiceLocal

Throws:

IllegalActionException

checkAvailableBalance

public void checkAvailableBalance(Account account,
                                  BigDecimal amount)
                           throws InsufficientBalanceException,
                                  LockAcquisitionException

Description copied from interface: AccountServiceLocal

Checks that the given account has enough balance for performing a payment with the given amount.

Specified by:

checkAvailableBalance in interface AccountServiceLocal

Throws:

InsufficientBalanceException

LockAcquisitionException

createSystemAccount

public SystemAccount createSystemAccount(SystemAccountType type)

Description copied from interface: AccountServiceLocal

Creates a new system account

Specified by:

createSystemAccount in interface AccountServiceLocal

dereserveAmount

public ExternalPaymentAmountReservation dereserveAmount(ExternalPayment externalPayment)

Description copied from interface: AccountServiceLocal

Cancels the amount reservation related to the given external payment

Specified by:

dereserveAmount in interface AccountServiceLocal

dereserveAmount

public OrderAmountReservation dereserveAmount(Order order)

Description copied from interface: AccountServiceLocal

Cancels the amount reservation related to the given order

Specified by:

dereserveAmount in interface AccountServiceLocal

dereserveAmount

public InstallmentAmountReservation dereserveAmount(ScheduledPaymentInstallment installment)
                                             throws FrameworkException,
                                                    IllegalActionException

Description copied from interface: AccountServiceLocal

Dereserves the amount for the given installment

Specified by:

dereserveAmount in interface AccountServiceLocal

Throws:

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

FrameworkException

dereserveAmountForAuthorization

public PendingAuthorizationAmountReservation dereserveAmountForAuthorization(BasePayment transaction)
                                                                      throws FrameworkException

Description copied from interface: AccountServiceLocal

Dereserves the amount for the transaction which was previously awaiting authorization

Specified by:

dereserveAmountForAuthorization in interface AccountServiceLocal

Throws:

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

FrameworkException

dereserveAmountIfNeeded

public VoucherAmountReservation dereserveAmountIfNeeded(Voucher voucher)
                                                 throws FrameworkException,
                                                        InsufficientBalanceException

Description copied from interface: AccountServiceLocal

If the voucher pack had an amount reservation, dereserve the amount for the given voucher

Specified by:

dereserveAmountIfNeeded in interface AccountServiceLocal

Throws:

FrameworkException

InsufficientBalanceException

dereserveAmountIfNeeded

public VoucherRedeemAmountReservation dereserveAmountIfNeeded(VoucherRedeem voucherRedeem)
                                                       throws FrameworkException,
                                                              InsufficientBalanceException

Description copied from interface: AccountServiceLocal

If the voucher pack had an amount reservation, dereserve the amount for the given voucher redeem

Specified by:

dereserveAmountIfNeeded in interface AccountServiceLocal

Throws:

FrameworkException

InsufficientBalanceException

exportAccountBalanceLimitsOverview

public FileInfo exportAccountBalanceLimitsOverview(@NotNull
                                                   @NotNull ExportFormatVO formatVO,
                                                   @NotNull
                                                   @NotNull AccountBalanceLimitsOverviewQuery params)
                                            throws FrameworkException

Description copied from interface: AccountService

Generates a file with the query result listing the account balance limits

Specified by:

exportAccountBalanceLimitsOverview in interface AccountService

Throws:

FrameworkException

exportAccountHistoriesOverview

public FileInfo exportAccountHistoriesOverview(@NotNull
                                               @NotNull ExportFormatVO formatVO,
                                               @NotNull
                                               @NotNull AccountHistoriesOverviewQuery params)
                                        throws FrameworkException

Description copied from interface: AccountService

Exports the account histories overview result to file

Specified by:

exportAccountHistoriesOverview in interface AccountService

Throws:

FrameworkException

exportAccountHistory

public FileInfo exportAccountHistory(@NotNull
                                     @NotNull ExportFormatVO formatVO,
                                     @NotNull
                                     @NotNull AccountHistoryQuery params)
                              throws FrameworkException

Description copied from interface: AccountService

Exports the account history result to file

Specified by:

exportAccountHistory in interface AccountService

Throws:

FrameworkException

exportAccountPaymentAmountLimitsOverview

public FileInfo exportAccountPaymentAmountLimitsOverview(@NotNull
                                                         @NotNull ExportFormatVO formatVO,
                                                         @NotNull
                                                         @NotNull AccountPaymentAmountLimitsOverviewQuery params)
                                                  throws FrameworkException

Description copied from interface: AccountService

Generates a file with the query result listing the account balance limits

Specified by:

exportAccountPaymentAmountLimitsOverview in interface AccountService

Throws:

FrameworkException

exportUsersWithBalances

public FileInfo exportUsersWithBalances(@NotNull
                                        @NotNull ExportFormatVO formatVO,
                                        @NotNull
                                        @NotNull UserWithBalanceQuery params)
                                 throws FrameworkException

Description copied from interface: AccountService

Generates a file with the query result listing the user balances

Specified by:

exportUsersWithBalances in interface AccountService

Throws:

FrameworkException

fillTransSearchData

public void fillTransSearchData(ITransSearchData data,
                                Account account,
                                InternalAccountOwner accountOwner,
                                ExportFormatContext exportContext)

Description copied from interface: AccountServiceLocal

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

Specified by:

fillTransSearchData in interface AccountServiceLocal

findByNumber

public Account findByNumber(String number)
                     throws FrameworkException

Description copied from interface: AccountServiceLocal

Returns the account with the given number

Specified by:

findByNumber in interface AccountServiceLocal

Throws:

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

FrameworkException

generateNumber

public String generateNumber(AccountType type,
                             InternalAccountOwner owner)
                      throws FrameworkException

Description copied from interface: AccountServiceLocal

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.

Specified by:

generateNumber in interface AccountServiceLocal

Throws:

FrameworkException

getAccountBalanceHistory

public AccountBalanceHistoryVO getAccountBalanceHistory(@NotNull
                                                        @NotNull AccountBalanceHistoryParams params)
                                                 throws FrameworkException

Description copied from interface: AccountService

Returns the balance at each data point for a given account. The account and status are also returned. For example, if the account had 50 transfers over 1 month, but in 20 distinct days of the month, and the request was to return for the month, with a balance per day, there will be 21 entries (the balance on the first day, plus the 20 days that had changed) When no period is given, or if the begin date was before the account creation, it is assumed since the day the account was created. The possible periods for data points are: - Months - Weeks - Days The maximum number of data points cannot exceed 61. So, for example, if the requested period is 1 year, it is possible to request balances per month or week (there's about 52 weeks in a year), but not days.

Specified by:

getAccountBalanceHistory in interface AccountService

Throws:

FrameworkException

getAccountBalanceLimitsOverviewData

public AccountLimitsOverviewData getAccountBalanceLimitsOverviewData()

Description copied from interface: AccountService

Account limits (balance and payment amounts) overview data for performing searches.

Specified by:

getAccountBalanceLimitsOverviewData in interface AccountService

getAccountHistoriesOverviewData

public AccountHistoriesOverviewData getAccountHistoriesOverviewData()

Description copied from interface: AccountService

Gets the details for viewing an account histories overview

Specified by:

getAccountHistoriesOverviewData in interface AccountService

getAccountHistoriesOverviewStatus

public AccountHistoriesOverviewStatusVO getAccountHistoriesOverviewStatus(AccountHistoriesOverviewQuery params)

Description copied from interface: AccountService

Returns the statuses by currency for the result of searching transactions with the given parameters

Specified by:

getAccountHistoriesOverviewStatus in interface AccountService

getAccountHistoryData

public AccountHistoryData getAccountHistoryData(AccountVO accountVO,
                                                RateVisibility rateVisibility)

Description copied from interface: AccountService

Gets the details for viewing an account history

Specified by:

getAccountHistoryData in interface AccountService

rateVisibility - if null RateVisibility.NOT is used

getAccountHistoryStatus

public AccountHistoryStatusVO getAccountHistoryStatus(Account account,
                                                      AccountHistoryQuery params)

Description copied from interface: AccountServiceLocal

Returns historic status for the account

Specified by:

getAccountHistoryStatus in interface AccountServiceLocal

getAccountHistoryStatus

public AccountWithHistoryStatusVO getAccountHistoryStatus(AccountHistoryQuery params)
                                                   throws FrameworkException

Description copied from interface: AccountService

Returns historic status for the account

Specified by:

getAccountHistoryStatus in interface AccountService

Throws:

FrameworkException

getAccountPaymentAmountLimitsOverviewData

public AccountLimitsOverviewData getAccountPaymentAmountLimitsOverviewData()

Description copied from interface: AccountService

Account limits (balance and payment amounts) overview data for performing searches.

Specified by:

getAccountPaymentAmountLimitsOverviewData in interface AccountService

getAccountsSummary

public List<AccountWithStatusVO> getAccountsSummary(InternalAccountOwner owner,
                                                    DateTime dateTime)

Description copied from interface: AccountService

Lists the visible accounts summary for the given account owner, with balances relative to the given date

Specified by:

getAccountsSummary in interface AccountService

getAccountStatus

public AccountStatusVO getAccountStatus(Account account,
                                        Date time,
                                        RateVisibility includeRates)

Description copied from interface: AccountServiceLocal

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

Specified by:

getAccountStatus in interface AccountServiceLocal

includeRates - if null RateVisibility.NOT is used

getAccountStatus

public AccountStatusVO getAccountStatus(AccountVO accountVO,
                                        DateTime dateTime,
                                        RateVisibility includeRates)

Description copied from interface: AccountService

Gets the status for the given account

Specified by:

getAccountStatus in interface AccountService

includeRates - if null RateVisibility.NOT is used

getAccountsWithStatus

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

Description copied from interface: AccountServiceLocal

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

Specified by:

getAccountsWithStatus in interface AccountServiceLocal

Throws:

FrameworkException

getAccountWithStatus

public AccountWithStatusVO getAccountWithStatus(AccountVO vo,
                                                DateTime dateTime)
                                         throws FrameworkException

Description copied from interface: AccountService

Returns the information of an account, with its status, by owner and type

Specified by:

getAccountWithStatus in interface AccountService

Throws:

FrameworkException

getAmountDereservation

public OrderAmountReservation getAmountDereservation(Order order)

Description copied from interface: AccountServiceLocal

Returns the OrderAmountReservation that canceled the order reserved amount, or null if none

Specified by:

getAmountDereservation in interface AccountServiceLocal

getAmountDereservationForAuthorization

public PendingAuthorizationAmountReservation getAmountDereservationForAuthorization(BasePayment transaction)

Description copied from interface: AccountServiceLocal

Returns the PendingAuthorizationAmountReservation created when a payment was no longer pending authorization, or null if none

Specified by:

getAmountDereservationForAuthorization in interface AccountServiceLocal

getAmountReservation

public OrderAmountReservation getAmountReservation(Order order)

Description copied from interface: AccountServiceLocal

Returns the OrderAmountReservation that reserved amount when the order was submitted, or null if none

Specified by:

getAmountReservation in interface AccountServiceLocal

getAmountReservationForAuthorization

public PendingAuthorizationAmountReservation getAmountReservationForAuthorization(BasePayment transaction)

Description copied from interface: AccountServiceLocal

Returns the PendingAuthorizationAmountReservation created when a payment was submitted for authorization, or null if none

Specified by:

getAmountReservationForAuthorization in interface AccountServiceLocal

getAvailableBalance

public BigDecimal getAvailableBalance(Account account,
                                      Date date)

Description copied from interface: AccountServiceLocal

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

Specified by:

getAvailableBalance in interface AccountServiceLocal

getAverageBalance

public BigDecimal getAverageBalance(Account account,
                                    BigDecimal balanceDiff,
                                    DatePeriod period,
                                    boolean positive,
                                    BigDecimal freebase)
                             throws FrameworkException

Description copied from interface: AccountServiceLocal

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.

Specified by:

getAverageBalance in interface AccountServiceLocal

Throws:

FrameworkException

getBalance

public BigDecimal getBalance(Account account,
                             Date date)

Description copied from interface: AccountServiceLocal

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

Specified by:

getBalance in interface AccountServiceLocal

getBalanceLimitLog

public AccountBalanceLimitLog getBalanceLimitLog(Account account,
                                                 Date date)

Description copied from interface: AccountServiceLocal

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

Specified by:

getBalanceLimitLog in interface AccountServiceLocal

getCreditLimit

public BigDecimal getCreditLimit(Account account,
                                 Date date)

Description copied from interface: AccountServiceLocal

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

Specified by:

getCreditLimit in interface AccountServiceLocal

getCurrentAvailableBalance

public BigDecimal getCurrentAvailableBalance(Account account,
                                             NativeAccountStatus status)

Description copied from interface: AccountServiceLocal

Returns the available balance for the given account, given that the native account status was already fetched

Specified by:

getCurrentAvailableBalance in interface AccountServiceLocal

getFrontendDashbordAcccount

public FrontendDashboardAccountVO getFrontendDashbordAcccount(Account account,
                                                              int lastTransfers)

Description copied from interface: AccountServiceLocal

Returns data for an account to be used in the new frontend dashboard

Specified by:

getFrontendDashbordAcccount in interface AccountServiceLocal

getManagedFlows

public List<TransferStatusFlow> getManagedFlows(Account account)

Description copied from interface: AccountServiceLocal

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

Specified by:

getManagedFlows in interface AccountServiceLocal

getNativeAccountStatus

public NativeAccountStatus getNativeAccountStatus(Account account,
                                                  Date date)

Description copied from interface: AccountServiceLocal

Returns the native account status for the given account

Specified by:

getNativeAccountStatus in interface AccountServiceLocal

getOwnerName

public String getOwnerName(Account account)

Description copied from interface: AccountServiceLocal

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

Specified by:

getOwnerName in interface AccountServiceLocal

getPermissions

public AccountPermissionsData getPermissions(Account account)
                                      throws FrameworkException

Description copied from interface: AccountServiceLocal

Returns permissions of what the logged user can do over the given account

Specified by:

getPermissions in interface AccountServiceLocal

Throws:

PermissionDeniedException - if the given account is not managed by the authenticated user

FrameworkException

See Also:

AccountService.getPermissions(AccountVO)

getPermissions

public AccountPermissionsData getPermissions(@NotNull
                                             @NotNull AccountVO accountVO)

Description copied from interface: AccountService

Returns permissions of what the logged user can do over the given account

Specified by:

getPermissions in interface AccountService

getRetrictedOperatorAccessibleAccounts

public RestrictedOperatorAccessibleAccounts getRetrictedOperatorAccessibleAccounts()

Description copied from interface: AccountServiceLocal

Returns which owner user accounts types are accessible and how by the logged restricted operator. If not logged-in as a restricted operator, returns null.

Specified by:

getRetrictedOperatorAccessibleAccounts in interface AccountServiceLocal

getUpperCreditLimit

public BigDecimal getUpperCreditLimit(Account account,
                                      Date date)

Description copied from interface: AccountServiceLocal

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

Specified by:

getUpperCreditLimit in interface AccountServiceLocal

getUserAccountBalanceLimitData

public UserAccountBalanceLimitData getUserAccountBalanceLimitData(AccountVO accountVO)

Description copied from interface: AccountService

Get an account limit data

Specified by:

getUserAccountBalanceLimitData in interface AccountService

getUserAccountPaymentAmountLimitData

public UserAccountPaymentAmountLimitData getUserAccountPaymentAmountLimitData(@NotNull
                                                                              @NotNull AccountVO accountVO)
                                                                       throws FrameworkException

Description copied from interface: AccountService

Get an account payment amount limit data

Specified by:

getUserAccountPaymentAmountLimitData in interface AccountService

Throws:

FrameworkException

getUserAccountsBalanceLimits

public List<AccountBalanceLimitVO> getUserAccountsBalanceLimits(UserLocatorVO userLocator)

Description copied from interface: AccountService

Returns the user accounts with their upper and lower balance limits

Specified by:

getUserAccountsBalanceLimits in interface AccountService

getUserAccountsData

public List<UserAccountData> getUserAccountsData(User user)

Description copied from interface: AccountServiceLocal

Returns the user's accounts data visible in profile

Specified by:

getUserAccountsData in interface AccountServiceLocal

getUserAccountsPaymentAmountLimits

public List<AccountPaymentAmountLimitVO> getUserAccountsPaymentAmountLimits(@NotNull
                                                                            @NotNull UserLocatorVO userLocator)
                                                                     throws FrameworkException

Description copied from interface: AccountService

Returns the user accounts with their upper and lower balance limits

Specified by:

getUserAccountsPaymentAmountLimits in interface AccountService

Throws:

FrameworkException

getUsersWithBalancesOverview

public UsersWithBalancesOverview getUsersWithBalancesOverview(UserWithBalanceQuery params)
                                                       throws FrameworkException,
                                                              QueryParseException

Description copied from interface: AccountService

Returns the overview of users with balances according to the given query

Specified by:

getUsersWithBalancesOverview in interface AccountService

Throws:

FrameworkException

QueryParseException

getUserWithBalanceSearchData

public UserWithBalanceSearchData getUserWithBalanceSearchData()
                                                       throws FrameworkException

Description copied from interface: AccountService

Returns data to search for users with balances

Specified by:

getUserWithBalanceSearchData in interface AccountService

Throws:

FrameworkException

getVisibleFlows

public List<TransferStatusFlow> getVisibleFlows(Account account)

Description copied from interface: AccountServiceLocal

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

Specified by:

getVisibleFlows in interface AccountServiceLocal

hasAccess

public boolean hasAccess(Account account)

Description copied from interface: AccountServiceLocal

Returns whether the given account is accessible by the logged user

Specified by:

hasAccess in interface AccountServiceLocal

See Also:

AccountServiceLocal.hasVisibility(Account)

hasVisibility

public boolean hasVisibility(Account account)

Description copied from interface: AccountServiceLocal

Returns whether the given account is visible by the logged user or not.
An account is visible if it's accessible and the associated AccountAccessibility allow view it. If an user can access an account then it can operate with it (e.g make/receive payments) regardless it's visible or not.

The visibility is taken into account only in cases the account is shown (as informative data), to know:

• Accounts summary
• Account history (i.e the transfers)
• HomeData.VISIBLE_ACCOUNTS (only the visible accounts are shown in the home page)
• UserInitializationData.VISIBLE_ACCOUNTS

Specified by:

hasVisibility in interface AccountServiceLocal

isActive

public boolean isActive(IAccount account)

Description copied from interface: AccountServiceLocal

Returns whether the given account is active. System accounts are always active. User accounts are active if the owner is not pending or removed and have at least one product that enables that account type.

Specified by:

isActive in interface AccountServiceLocal

listVisible

public <A extends Account> List<A> listVisible(InternalAccountOwner owner)

Description copied from interface: AccountServiceLocal

Returns the visible accounts for the given owner.

Specified by:

listVisible in interface AccountServiceLocal

listVisibleTypes

public <A extends AccountType> List<A> listVisibleTypes(InternalAccountOwner owner)

Description copied from interface: AccountServiceLocal

Calls listVisible(), but projecting each account type

Specified by:

listVisibleTypes in interface AccountServiceLocal

load

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

Description copied from interface: AccountServiceLocal

Loads an account for the given locator, without checking permissions for the logged user For user accounts, if the account is not found yet, returns a transient account.

Specified by:

load in interface AccountServiceLocal

Throws:

FrameworkException

load

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

Description copied from interface: AccountServiceLocal

Loads an account for the given owner / type, without checking permissions for the logged user For user accounts, if the account is not found yet, returns a transient account.

Specified by:

load in interface AccountServiceLocal

load

public <A extends Account> A load(InternalAccountOwner owner,
                                  AccountType type,
                                  boolean allowDisposed)

Description copied from interface: AccountServiceLocal

Loads an account for the given owner / type, without checking permissions for the logged user. Depending on the flag will return an account even if it was disposed. For user accounts, if the account is not found yet, returns a transient account.

Specified by:

load in interface AccountServiceLocal

load

public AccountWithCurrencyVO load(Long id)

Description copied from interface: AccountService

Loads an account by id

Specified by:

load in interface AccountService

makeBalanceDirty

public void makeBalanceDirty(Account account,
                             Transfer transfer)

Description copied from interface: AccountServiceLocal

Marks the balance of the given account as dirty for given transfer.

Specified by:

makeBalanceDirty in interface AccountServiceLocal

removeLastClosedAccountBalances

public void removeLastClosedAccountBalances(Transfer transfer)

Description copied from interface: AccountServiceLocal

Removes all the closes from the initial date to now of the from and to account of the transfer. Also removes the account_balance row for both accounts

Specified by:

removeLastClosedAccountBalances in interface AccountServiceLocal

require

public <A extends Account> A require(InternalAccountOwner owner,
                                     AccountType type)

Description copied from interface: AccountServiceLocal

Loads an account for the given owner / type, without checking permissions for the logged user. For user accounts, if the account is not found yet, will physically create one.

Specified by:

require in interface AccountServiceLocal

reserveAmount

public CustomAmountReservation reserveAmount(Account account,
                                             BigDecimal amount)
                                      throws InsufficientBalanceException

Description copied from interface: AccountServiceLocal

Reserves the given amount for an account checking its available balance.
WARNING: Intended to be used via scripts (it can't be removed after a static analysis).

Specified by:

reserveAmount in interface AccountServiceLocal

Returns:

If the amount is zero returns null, otherwise the reservation.

Throws:

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

reserveAmount

public CustomAmountReservation reserveAmount(Account account,
                                             BigDecimal amount,
                                             boolean ignoreAccountLimits)
                                      throws InsufficientBalanceException

Description copied from interface: AccountServiceLocal

Reserves the given amount for an account ignoring the limits only if ignoreAccountLimits is true.
WARNING: Intended to be used via scripts (it can't be removed after a static analysis).

Specified by:

reserveAmount in interface AccountServiceLocal

Returns:

If the amount is zero returns null, otherwise the reservation.

Throws:

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

reserveAmount

public ExternalPaymentAmountReservation reserveAmount(ExternalPayment externalPayment)
                                               throws InsufficientBalanceException

Description copied from interface: AccountServiceLocal

Reserves the amount for the given external payment

Specified by:

reserveAmount in interface AccountServiceLocal

Throws:

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

reserveAmount

public OrderAmountReservation reserveAmount(Order order)
                                     throws InsufficientBalanceException

Description copied from interface: AccountServiceLocal

Reserves the amount for the given webshop order

Specified by:

reserveAmount in interface AccountServiceLocal

Throws:

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

reserveAmount

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

Description copied from interface: AccountServiceLocal

Reserves the total amount for the given scheduled payment

Specified by:

reserveAmount in interface AccountServiceLocal

Throws:

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

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

FrameworkException

reserveAmountForAuthorization

public PendingAuthorizationAmountReservation reserveAmountForAuthorization(PerformTransactionDTO performTransaction,
                                                                           BasePayment transaction)
                                                                    throws FrameworkException,
                                                                           InsufficientBalanceException,
                                                                           IllegalActionException

Description copied from interface: AccountServiceLocal

Reserves the amount for a pending by authorization payment created from the given DTO.

Specified by:

reserveAmountForAuthorization in interface AccountServiceLocal

Throws:

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

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

FrameworkException

reserveAmountForUnblocking

public VoucherUnblockAmountReservation reserveAmountForUnblocking(Voucher voucher)

Description copied from interface: AccountServiceLocal

Reserves the amount for unblocking a blocked voucher

Specified by:

reserveAmountForUnblocking in interface AccountServiceLocal

reserveAmountIfNeeded

public VoucherPackAmountReservation reserveAmountIfNeeded(VoucherPack pack)
                                                   throws InsufficientBalanceException

Description copied from interface: AccountServiceLocal

Reserves the total amount for the given voucher pack (count * amount) on the source account of the redeem type, if that account is limited. If it is an unlimited account, just returns null.

Specified by:

reserveAmountIfNeeded in interface AccountServiceLocal

Throws:

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

resolvePreselectedPeriods

public List<PeriodPreselectorOptionData> resolvePreselectedPeriods()

Description copied from interface: AccountServiceLocal

Resolve the available preselected periods for the logged user configuration

Specified by:

resolvePreselectedPeriods in interface AccountServiceLocal

searchAccountBalanceLimitsOverview

public Page<AccountBalanceLimitVO> searchAccountBalanceLimitsOverview(AccountBalanceLimitsOverviewQuery params)

Description copied from interface: AccountService

Overview search of account balance limits

Specified by:

searchAccountBalanceLimitsOverview in interface AccountService

searchAccountHistoriesOverview

public Page<AccountHistoryOverviewEntryVO> searchAccountHistoriesOverview(AccountHistoriesOverviewQuery params)

Description copied from interface: AccountService

Account histories overview filtered by the specified query parameters.

Specified by:

searchAccountHistoriesOverview in interface AccountService

searchAccountHistory

public Page<AccountHistoryEntryVO> searchAccountHistory(AccountHistoryQuery params)

Description copied from interface: AccountService

Searches the history entries of a required visible account according to the given query parameters. For searching on multiple accounts see AccountService.searchAccountHistoriesOverview(AccountHistoriesOverviewQuery)

Specified by:

searchAccountHistory in interface AccountService

searchAccountPaymentAmountLimitsOverview

public Page<AccountPaymentAmountLimitVO> searchAccountPaymentAmountLimitsOverview(@NotNull
                                                                                  @NotNull AccountPaymentAmountLimitsOverviewQuery params)
                                                                           throws FrameworkException

Description copied from interface: AccountService

Overview search of account balance limits

Specified by:

searchAccountPaymentAmountLimitsOverview in interface AccountService

Throws:

FrameworkException

searchUsersWithBalances

public Page<UserWithBalanceVO> searchUsersWithBalances(UserWithBalanceQuery params)
                                                throws FrameworkException

Description copied from interface: AccountService

Searches for users together with their respective account balances

Specified by:

searchUsersWithBalances in interface AccountService

Throws:

FrameworkException

setBalanceLimit

public void setBalanceLimit(AccountBalanceLimitDTO dto)

Description copied from interface: AccountService

Change limits of an account

Specified by:

setBalanceLimit in interface AccountService

setPaymentAmountLimit

public void setPaymentAmountLimit(@NotNull
                                  @NotNull AccountPaymentAmountLimitDTO dto)
                           throws FrameworkException

Description copied from interface: AccountService

Change limits of an account

Specified by:

setPaymentAmountLimit in interface AccountService

Throws:

FrameworkException

shouldAdjustAccountsWhenAssigning

public boolean shouldAdjustAccountsWhenAssigning(MemberProduct product)

Description copied from interface: AccountServiceLocal

Indicates whether user accounts should be adjusted if the given member product is assigned to a group / group set

Specified by:

shouldAdjustAccountsWhenAssigning in interface AccountServiceLocal

toAccountWithStatus

public AccountWithStatusVO toAccountWithStatus(Account account,
                                               Date date,
                                               Date paymentsSince,
                                               boolean includeRates)
                                        throws FrameworkException

Description copied from interface: AccountServiceLocal

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

Specified by:

toAccountWithStatus in interface AccountServiceLocal

Throws:

FrameworkException

updateBalance

public void updateBalance(Account account,
                          BigDecimal balance,
                          Long[] dirtyTransferIds)

Description copied from interface: AccountServiceLocal

Updates the current account balance. IMPORTANT! This method should only be called after acquiring a lock for the given account, to ensure consistency. This method calls the native update_balance function.

Specified by:

updateBalance in interface AccountServiceLocal

persist

protected void persist(IEntity entity)

Overrides:

persist in class AbstractServerComponent

See Also:

BaseEntityManagerHandler.persist(IEntity)

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl