Package org.cyclos.services.banking

Interface AccountService

All Superinterfaces:

Service

All Known Subinterfaces:

AccountServiceLocal

public interface AccountService
extends Service

Service interface for accounts

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_BALANCE_HISTORY_DATAPOINTS	The maximum number of data points allowed in a balance history

Method Summary

Modifier and Type	Method	Description
FileInfo	exportAccountBalanceLimitsOverview(@NotNull ExportFormatVO format, @NotNull AccountBalanceLimitsOverviewQuery params)	Generates a file with the query result listing the account balance limits
FileInfo	exportAccountHistoriesOverview(@NotNull ExportFormatVO format, @NotNull AccountHistoriesOverviewQuery params)	Exports the account histories overview result to file
FileInfo	exportAccountHistory(@NotNull ExportFormatVO format, @NotNull AccountHistoryQuery params)	Exports the account history result to file
FileInfo	exportAccountPaymentAmountLimitsOverview(@NotNull ExportFormatVO format, @NotNull AccountPaymentAmountLimitsOverviewQuery params)	Generates a file with the query result listing the account balance limits
FileInfo	exportArchivedAccountHistory(@NotNull ExportFormatVO format, @NotNull ArchivedAccountHistoryQuery params)	Exports the archived account history result to file
FileInfo	exportArchivedTransfer(@NotNull ExportFormatVO format, @NotNull Long id)	Exports the given archived transfer to file
FileInfo	exportUsersWithBalances(@NotNull ExportFormatVO format, @NotNull UserWithBalanceQuery params)	Generates a file with the query result listing the user balances
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(@NotNull AccountHistoriesOverviewQuery params)	Returns the statuses by currency for the result of searching transactions with the given parameters
AccountHistoryData	getAccountHistoryData(@NotNull AccountVO account, RateVisibility rateVisibility)	Gets the details for viewing an account history
AccountWithHistoryStatusVO	getAccountHistoryStatus(@NotNull AccountHistoryQuery params)	Returns historic status for the account
AccountLimitsOverviewData	getAccountPaymentAmountLimitsOverviewData()	Account limits (balance and payment amounts) overview data for performing searches.
List<AccountWithStatusVO>	getAccountsSummary(@NotNull InternalAccountOwner owner, DateTime dateTime)	Lists the visible accounts summary for the given account owner, with balances relative to the given date
AccountStatusVO	getAccountStatus(@NotNull AccountVO account, DateTime dateTime, RateVisibility rateVisibility)	Gets the status for the given account
AccountWithStatusVO	getAccountWithStatus(@NotNull AccountVO account, DateTime dateTime)	Returns the information of an account, with its status, by owner and type
ArchivedAccountHistoryData	getArchivedAccountHistoryData(@NotNull AccountVO account)	Gets the details for viewing archived information of an account
ArchivedTransferData	getArchivedTransferData(@NotNull Long id)	Returns a data for viewing a single archived transfer details
AccountPermissionsData	getPermissions(@NotNull AccountVO account)	Returns permissions of what the logged user can do over the given account
UserAccountBalanceLimitData	getUserAccountBalanceLimitData(@NotNull AccountVO account)	Get an account limit data
UserAccountPaymentAmountLimitData	getUserAccountPaymentAmountLimitData(@NotNull AccountVO account)	Get an account payment amount limit data
List<AccountBalanceLimitVO>	getUserAccountsBalanceLimits(@NotNull UserLocatorVO userLocator)	Returns the user accounts with their upper and lower balance limits
List<AccountPaymentAmountLimitVO>	getUserAccountsPaymentAmountLimits(@NotNull UserLocatorVO userLocator)	Returns the user accounts with their upper and lower balance limits
UsersWithBalancesOverview	getUsersWithBalancesOverview(@NotNull UserWithBalanceQuery params)	Returns the overview of users with balances according to the given query
UserWithBalanceSearchData	getUserWithBalanceSearchData()	Returns data to search for users with balances
AccountWithCurrencyVO	load(@NotNull Long id)	Loads an account by id
Page<AccountBalanceLimitVO>	searchAccountBalanceLimitsOverview(@NotNull AccountBalanceLimitsOverviewQuery params)	Overview search of account balance limits
Page<AccountHistoryOverviewEntryVO>	searchAccountHistoriesOverview(@NotNull AccountHistoriesOverviewQuery params)	Account histories overview filtered by the specified query parameters.
Page<AccountHistoryEntryVO>	searchAccountHistory(@NotNull 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
ArchivedAccountHistoryVO	searchArchivedAccountHistory(@NotNull ArchivedAccountHistoryQuery params)	Searches for archived information of an account
Page<UserWithBalanceVO>	searchUsersWithBalances(@NotNull UserWithBalanceQuery params)	Searches for users together with their respective account balances
void	setBalanceLimit(@NotNull AccountBalanceLimitDTO data)	Change limits of an account
void	setPaymentAmountLimit(@NotNull AccountPaymentAmountLimitDTO data)	Change limits of an account

Field Detail

MAX_BALANCE_HISTORY_DATAPOINTS

static final int MAX_BALANCE_HISTORY_DATAPOINTS

The maximum number of data points allowed in a balance history

See Also:

Constant Field Values

Method Detail

exportAccountBalanceLimitsOverview

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

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

Throws:

FrameworkException

exportAccountHistoriesOverview

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

Exports the account histories overview result to file

Throws:

FrameworkException

exportAccountHistory

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

Exports the account history result to file

Throws:

FrameworkException

exportAccountPaymentAmountLimitsOverview

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

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

Throws:

FrameworkException

exportArchivedAccountHistory

FileInfo exportArchivedAccountHistory(@NotNull
                                      @NotNull ExportFormatVO format,
                                      @NotNull
                                      @NotNull ArchivedAccountHistoryQuery params)
                               throws FrameworkException

Exports the archived account history result to file

Throws:

FrameworkException

exportArchivedTransfer

FileInfo exportArchivedTransfer(@NotNull
                                @NotNull ExportFormatVO format,
                                @NotNull
                                @NotNull Long id)
                         throws FrameworkException

Exports the given archived transfer to file

Throws:

FrameworkException

exportUsersWithBalances

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

Generates a file with the query result listing the user balances

Throws:

FrameworkException

getAccountBalanceHistory

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

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.

Throws:

FrameworkException

getAccountBalanceLimitsOverviewData

AccountLimitsOverviewData getAccountBalanceLimitsOverviewData()
                                                       throws FrameworkException

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

Throws:

FrameworkException

getAccountHistoriesOverviewData

AccountHistoriesOverviewData getAccountHistoriesOverviewData()
                                                      throws FrameworkException

Gets the details for viewing an account histories overview

Throws:

FrameworkException

getAccountHistoriesOverviewStatus

AccountHistoriesOverviewStatusVO getAccountHistoriesOverviewStatus(@NotNull
                                                                   @NotNull AccountHistoriesOverviewQuery params)

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

getAccountHistoryData

AccountHistoryData getAccountHistoryData(@NotNull
                                         @NotNull AccountVO account,
                                         RateVisibility rateVisibility)
                                  throws FrameworkException

Gets the details for viewing an account history

Parameters:

rateVisibility - if null RateVisibility.NOT is used

Throws:

FrameworkException

getAccountHistoryStatus

AccountWithHistoryStatusVO getAccountHistoryStatus(@NotNull
                                                   @NotNull AccountHistoryQuery params)
                                            throws FrameworkException

Returns historic status for the account

Throws:

FrameworkException

getAccountPaymentAmountLimitsOverviewData

AccountLimitsOverviewData getAccountPaymentAmountLimitsOverviewData()
                                                             throws FrameworkException

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

Throws:

FrameworkException

getAccountsSummary

List<AccountWithStatusVO> getAccountsSummary(@NotNull
                                             @NotNull InternalAccountOwner owner,
                                             DateTime dateTime)
                                      throws FrameworkException

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

Throws:

FrameworkException

getAccountStatus

AccountStatusVO getAccountStatus(@NotNull
                                 @NotNull AccountVO account,
                                 DateTime dateTime,
                                 RateVisibility rateVisibility)
                          throws FrameworkException

Gets the status for the given account

Parameters:

rateVisibility - if null RateVisibility.NOT is used

Throws:

FrameworkException

getAccountWithStatus

AccountWithStatusVO getAccountWithStatus(@NotNull
                                         @NotNull AccountVO account,
                                         DateTime dateTime)
                                  throws FrameworkException

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

Throws:

FrameworkException

getArchivedAccountHistoryData

ArchivedAccountHistoryData getArchivedAccountHistoryData(@NotNull
                                                         @NotNull AccountVO account)
                                                  throws FrameworkException

Gets the details for viewing archived information of an account

Throws:

FrameworkException

getArchivedTransferData

ArchivedTransferData getArchivedTransferData(@NotNull
                                             @NotNull Long id)
                                      throws FrameworkException

Returns a data for viewing a single archived transfer details

Throws:

FrameworkException

getPermissions

AccountPermissionsData getPermissions(@NotNull
                                      @NotNull AccountVO account)
                               throws FrameworkException

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

Throws:

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

FrameworkException

getUserAccountBalanceLimitData

UserAccountBalanceLimitData getUserAccountBalanceLimitData(@NotNull
                                                           @NotNull AccountVO account)
                                                    throws FrameworkException

Get an account limit data

Throws:

FrameworkException

getUserAccountPaymentAmountLimitData

UserAccountPaymentAmountLimitData getUserAccountPaymentAmountLimitData(@NotNull
                                                                       @NotNull AccountVO account)
                                                                throws FrameworkException

Get an account payment amount limit data

Throws:

FrameworkException

getUserAccountsBalanceLimits

List<AccountBalanceLimitVO> getUserAccountsBalanceLimits(@NotNull
                                                         @NotNull UserLocatorVO userLocator)
                                                  throws FrameworkException

Returns the user accounts with their upper and lower balance limits

Throws:

FrameworkException

getUserAccountsPaymentAmountLimits

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

Returns the user accounts with their upper and lower balance limits

Throws:

FrameworkException

getUsersWithBalancesOverview

UsersWithBalancesOverview getUsersWithBalancesOverview(@NotNull
                                                       @NotNull UserWithBalanceQuery params)
                                                throws FrameworkException,
                                                       QueryParseException

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

Throws:

FrameworkException

QueryParseException

getUserWithBalanceSearchData

UserWithBalanceSearchData getUserWithBalanceSearchData()
                                                throws FrameworkException

Returns data to search for users with balances

Throws:

FrameworkException

load

AccountWithCurrencyVO load(@NotNull
                           @NotNull Long id)
                    throws FrameworkException

Loads an account by id

Throws:

FrameworkException

searchAccountBalanceLimitsOverview

Page<AccountBalanceLimitVO> searchAccountBalanceLimitsOverview(@NotNull
                                                               @NotNull AccountBalanceLimitsOverviewQuery params)
                                                        throws FrameworkException

Overview search of account balance limits

Throws:

FrameworkException

searchAccountHistoriesOverview

Page<AccountHistoryOverviewEntryVO> searchAccountHistoriesOverview(@NotNull
                                                                   @NotNull AccountHistoriesOverviewQuery params)
                                                            throws FrameworkException

Account histories overview filtered by the specified query parameters.

Throws:

FrameworkException

searchAccountHistory

Page<AccountHistoryEntryVO> searchAccountHistory(@NotNull
                                                 @NotNull AccountHistoryQuery params)
                                          throws FrameworkException

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

Throws:

FrameworkException

searchAccountPaymentAmountLimitsOverview

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

Overview search of account balance limits

Throws:

FrameworkException

searchArchivedAccountHistory

ArchivedAccountHistoryVO searchArchivedAccountHistory(@NotNull
                                                      @NotNull ArchivedAccountHistoryQuery params)
                                               throws FrameworkException

Searches for archived information of an account

Throws:

FrameworkException

searchUsersWithBalances

Page<UserWithBalanceVO> searchUsersWithBalances(@NotNull
                                                @NotNull UserWithBalanceQuery params)
                                         throws FrameworkException,
                                                QueryParseException

Searches for users together with their respective account balances

Throws:

FrameworkException

QueryParseException

setBalanceLimit

void setBalanceLimit(@NotNull
                     @NotNull AccountBalanceLimitDTO data)
              throws FrameworkException

Change limits of an account

Throws:

FrameworkException

setPaymentAmountLimit

void setPaymentAmountLimit(@NotNull
                           @NotNull AccountPaymentAmountLimitDTO data)
                    throws FrameworkException

Change limits of an account

Throws:

FrameworkException