org.cyclos.services.banking

Interface AccountService

All Superinterfaces:

Service

All Known Subinterfaces:

AccountServiceLocal

All Known Implementing Classes:

AccountServiceSecurity

public interface AccountService
extends Service

Service interface for accounts

Author:

luis

Method Summary

Modifier and Type	Method and Description
SerializableInputStream	exportAccountHistoryToCSV(AccountHistoryQuery params) Generates a CSV with the query result listing account history entries
SerializableInputStream	exportAccountLimitsToCSV(AccountBalanceLimitsOverviewQuery params) Generates a CSV with the query result listing account balance limits
SerializableInputStream	exportHistoriesOverviewToCSV(AccountHistoriesOverviewQuery params) Generates a CSV with the query result listing an overview of payments
SerializableInputStream	exportUserBalanceToCSV(UserWithBalanceQuery params) Generates a CSV with the query result listing the user balances
AccountBalanceLimitsOverviewData	getAccountBalanceLimitsOverviewData() Account balance limits overview data for performing searches.
AccountHistoriesOverviewData	getAccountHistoriesOverviewData() Gets the details for viewing an account histories overview
AccountHistoryData	getAccountHistoryData(AccountVO account, RateVisibility rateVisibility) Gets the details for viewing an account history
AccountHistoryStatusVO	getAccountHistoryStatus(AccountHistoryQuery params) Returns historic status for the account
java.util.List<AccountWithStatusVO>	getAccountsSummary(InternalAccountOwner owner, DateTime dateTime) Lists the accounts summary for the given account owner, with balances relative to the given date
AccountStatusVO	getAccountStatus(AccountVO account, DateTime dateTime, RateVisibility rateVisibility) Gets the status for the given account
AccountWithStatusVO	getAccountWithStatus(AccountVO account, DateTime dateTime) Returns the information of an account, with its status, by owner and type
AccountPermissionsData	getPermissions(AccountVO account) Returns permissions of what the logged user can do over the given account
UserAccountLimitData	getUserAccountLimitData(AccountVO account) Get an account limit data
java.util.List<AccountLimitVO>	getUserAccountsLimits(UserLocatorVO userLocator) Returns the user accounts with their upper and lower balance limits
UserWithBalanceSearchData	getUserWithBalanceSearchData() Returns data to search for users with balances
boolean	hasAccessibleAccounts() Returns true if the logged user has at least one account.
AccountWithCurrencyVO	load(java.lang.Long id) Loads an account by id
SerializableInputStream	printAccountHistory(AccountHistoryQuery params) Genertes a PDF with the account history entries for the given query parameters.
Page<AccountLimitVO>	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 account history entries for the given query parameters.
UsersWithBalancesResult	searchUsersWithBalances(UserWithBalanceQuery params) Searches for users together with their respective account balances, returning not only the users, but also an overview
void	setBalanceLimit(AccountLimitDTO data) Change limits of an account

Method Detail

exportAccountHistoryToCSV

SerializableInputStream exportAccountHistoryToCSV(AccountHistoryQuery params)
                                           throws FrameworkException

Generates a CSV with the query result listing account history entries

Throws:

FrameworkException

exportAccountLimitsToCSV

SerializableInputStream exportAccountLimitsToCSV(AccountBalanceLimitsOverviewQuery params)
                                          throws FrameworkException

Generates a CSV with the query result listing account balance limits

Throws:

FrameworkException

exportHistoriesOverviewToCSV

SerializableInputStream exportHistoriesOverviewToCSV(AccountHistoriesOverviewQuery params)
                                              throws FrameworkException

Generates a CSV with the query result listing an overview of payments

Throws:

FrameworkException

exportUserBalanceToCSV

SerializableInputStream exportUserBalanceToCSV(UserWithBalanceQuery params)
                                        throws FrameworkException

Generates a CSV with the query result listing the user balances

Throws:

FrameworkException

getAccountBalanceLimitsOverviewData

AccountBalanceLimitsOverviewData getAccountBalanceLimitsOverviewData()
                                                              throws FrameworkException

Account balance limits overview data for performing searches.

Throws:

FrameworkException

getAccountHistoriesOverviewData

AccountHistoriesOverviewData getAccountHistoriesOverviewData()
                                                      throws FrameworkException

Gets the details for viewing an account histories overview

Throws:

FrameworkException

getAccountHistoryData

AccountHistoryData getAccountHistoryData(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

AccountHistoryStatusVO getAccountHistoryStatus(AccountHistoryQuery params)
                                        throws FrameworkException

Returns historic status for the account

Throws:

FrameworkException

getAccountsSummary

java.util.List<AccountWithStatusVO> getAccountsSummary(InternalAccountOwner owner,
                                                       DateTime dateTime)
                                                throws FrameworkException

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

Throws:

FrameworkException

getAccountStatus

AccountStatusVO getAccountStatus(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(AccountVO account,
                                         DateTime dateTime)
                                  throws FrameworkException

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

Throws:

FrameworkException

getPermissions

AccountPermissionsData getPermissions(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

getUserAccountLimitData

UserAccountLimitData getUserAccountLimitData(AccountVO account)
                                      throws FrameworkException

Get an account limit data

Throws:

FrameworkException

getUserAccountsLimits

java.util.List<AccountLimitVO> getUserAccountsLimits(UserLocatorVO userLocator)
                                              throws FrameworkException

Returns the user accounts with their upper and lower balance limits

Throws:

FrameworkException

getUserWithBalanceSearchData

UserWithBalanceSearchData getUserWithBalanceSearchData()
                                                throws FrameworkException

Returns data to search for users with balances

Throws:

FrameworkException

hasAccessibleAccounts

boolean hasAccessibleAccounts()
                       throws FrameworkException

Returns true if the logged user has at least one account. The logged user invoking this method should be a member

Throws:

FrameworkException

load

AccountWithCurrencyVO load(java.lang.Long id)
                    throws FrameworkException

Loads an account by id

Throws:

FrameworkException

printAccountHistory

SerializableInputStream printAccountHistory(AccountHistoryQuery params)
                                     throws FrameworkException

Genertes a PDF with the account history entries for the given query parameters.

Throws:

FrameworkException

searchAccountBalanceLimitsOverview

Page<AccountLimitVO> searchAccountBalanceLimitsOverview(AccountBalanceLimitsOverviewQuery params)
                                                 throws FrameworkException

Overview search of account balance limits

Throws:

FrameworkException

searchAccountHistoriesOverview

Page<AccountHistoryOverviewEntryVO> searchAccountHistoriesOverview(AccountHistoriesOverviewQuery params)
                                                            throws FrameworkException

Account histories overview filtered by the specified query parameters.

Throws:

FrameworkException

searchAccountHistory

Page<AccountHistoryEntryVO> searchAccountHistory(AccountHistoryQuery params)
                                          throws FrameworkException

Searches the account history entries for the given query parameters.

Throws:

FrameworkException

searchUsersWithBalances

UsersWithBalancesResult searchUsersWithBalances(UserWithBalanceQuery params)
                                         throws FrameworkException,
                                                QueryParseException

Searches for users together with their respective account balances, returning not only the users, but also an overview

Throws:

FrameworkException

QueryParseException

setBalanceLimit

void setBalanceLimit(AccountLimitDTO data)
              throws FrameworkException

Change limits of an account

Throws:

FrameworkException