Package org.cyclos.impl.banking

Class AccountFeeLogServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.banking.AccountFeeLogServiceImpl

All Implemented Interfaces:

AccountFeeLogServiceLocal, AccountFeeLogService, Service

@Service
public class AccountFeeLogServiceImpl
extends BaseServiceImpl
implements AccountFeeLogServiceLocal

Implementation for AccountFeeLogService

Field Summary

Fields

Modifier and Type	Field	Description
protected JdbcTemplate	jdbcTemplate

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.impl.banking.AccountFeeLogServiceLocal

ATTR_ACCOUNT, ATTR_EXECUTION_DATE, ATTR_FEE

Constructor Summary

Constructors

Constructor	Description
AccountFeeLogServiceImpl()

Method Summary

Modifier and Type	Method	Description
long	archiveAccountFee(long id)	Archives the account fee log with the given id, returning the number of removed UserAccountFeeLogs
BigDecimal	calculateAmount(AccountFeeLog execution, UserAccount account)	Calculates the amount to be charged for the given user account on the given fee execution.
BigDecimal	calculateReservedAmount(AccountFee accountFee, UserAccount account)	Returns the reserved amount for an account fee over a given account
void	chargeBatch(List<Long> uaflIds)	Changes a batch of UserAccountFeeLogs.
AccountFeeLogData	getData(Long id)	Returns data about an account fee execution
AccountFeeExecutionSearchData	getFeeExecutionsSearchData()	Returns data for searching account fee executions
AccountFeeLog	getLastExecution(AccountFee accountFee)	Returns the last execution log for a given fee, or null if it was never charged
Date	getNextExecutionDate(AccountFee accountFee, AccountFeeLog lastExecution)	Returns the next date the given fee should be executed, or null if the fee is disabled or manual
AccountFeeLogsSearchData	getSearchData(AccountFeeVO accountFeeVO)	Returns data to search account fee logs of the given account fee
com.mysema.commons.lang.CloseableIterator<Long>	getUserAFLIdsToCharge(AccountFeeLog log)	Returns the identifiers of UserAccountFeeLogs that should be charged for this log.
boolean	hasUsers(AccountFeeLog accountFeeLog)	Returns whether there are UserAccountFeeLogs for the given fee execution
long	insertMissingScheduledExecutions()	For each enabled scheduled fee, inserts all missing AccountFeeLogs
void	markFinished(AccountFeeLog log)	Marks the given account fee log as finished.
void	rechargeFailed(Long id)	Starts recharging a fee which has finished and some failed users
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
UserAccount	resolveAccount(AccountFeeLog accountFeeLog, User user)	Returns the UserAccount for the given user involved in the given fee log.
Long	runNow(AccountFeeVO accountFeeVO)	Starts charging a manual fee, returning the resulting account fee log id
Page<AccountFeeLogVO>	search(AccountFeeLogQuery query)	Searches for account fee logs according to the given criteria
Page<AccountFeeExecutionVO>	searchFeeExecutions(AccountFeeQuery query)	Search for visible account fees, together with the previous and next execution data

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, persist, 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

Field Detail

jdbcTemplate

@Autowired
protected JdbcTemplate jdbcTemplate

Constructor Detail

AccountFeeLogServiceImpl

public AccountFeeLogServiceImpl()

Method Detail

archiveAccountFee

public long archiveAccountFee(long id)

Description copied from interface: AccountFeeLogServiceLocal

Archives the account fee log with the given id, returning the number of removed UserAccountFeeLogs

Specified by:

archiveAccountFee in interface AccountFeeLogServiceLocal

calculateAmount

public BigDecimal calculateAmount(AccountFeeLog execution,
                                  UserAccount account)
                           throws FrameworkException

Description copied from interface: AccountFeeLogServiceLocal

Calculates the amount to be charged for the given user account on the given fee execution. Returns null when nothing should be charged (for example, because of the freebase)

Specified by:

calculateAmount in interface AccountFeeLogServiceLocal

Throws:

FrameworkException

calculateReservedAmount

public BigDecimal calculateReservedAmount(AccountFee accountFee,
                                          UserAccount account)

Description copied from interface: AccountFeeLogServiceLocal

Returns the reserved amount for an account fee over a given account

Specified by:

calculateReservedAmount in interface AccountFeeLogServiceLocal

chargeBatch

public void chargeBatch(List<Long> uaflIds)

Description copied from interface: AccountFeeLogServiceLocal

Changes a batch of UserAccountFeeLogs.

Specified by:

chargeBatch in interface AccountFeeLogServiceLocal

getData

public AccountFeeLogData getData(Long id)
                          throws FrameworkException

Description copied from interface: AccountFeeLogService

Returns data about an account fee execution

Specified by:

getData in interface AccountFeeLogService

Throws:

FrameworkException

getFeeExecutionsSearchData

public AccountFeeExecutionSearchData getFeeExecutionsSearchData()
                                                         throws FrameworkException

Description copied from interface: AccountFeeLogService

Returns data for searching account fee executions

Specified by:

getFeeExecutionsSearchData in interface AccountFeeLogService

Throws:

FrameworkException

getLastExecution

public AccountFeeLog getLastExecution(AccountFee accountFee)

Description copied from interface: AccountFeeLogServiceLocal

Returns the last execution log for a given fee, or null if it was never charged

Specified by:

getLastExecution in interface AccountFeeLogServiceLocal

getNextExecutionDate

public Date getNextExecutionDate(AccountFee accountFee,
                                 AccountFeeLog lastExecution)

Description copied from interface: AccountFeeLogServiceLocal

Returns the next date the given fee should be executed, or null if the fee is disabled or manual

Specified by:

getNextExecutionDate in interface AccountFeeLogServiceLocal

getSearchData

public AccountFeeLogsSearchData getSearchData(AccountFeeVO accountFeeVO)
                                       throws FrameworkException

Description copied from interface: AccountFeeLogService

Returns data to search account fee logs of the given account fee

Specified by:

getSearchData in interface AccountFeeLogService

Throws:

FrameworkException

getUserAFLIdsToCharge

public com.mysema.commons.lang.CloseableIterator<Long> getUserAFLIdsToCharge(AccountFeeLog log)

Description copied from interface: AccountFeeLogServiceLocal

Returns the identifiers of UserAccountFeeLogs that should be charged for this log. If the log is in status AccountFeeLogStatus.RUNNING, returns ids of UAFLs with status UserAccountFeeStatus.PENDING. However, if the status is AccountFeeLogStatus.RECHARGING_FAILED, returns UAFLs with status UserAccountFeeStatus.FAILED and recharge attempt < account fee log's recharge attempt.

Specified by:

getUserAFLIdsToCharge in interface AccountFeeLogServiceLocal

hasUsers

public boolean hasUsers(AccountFeeLog accountFeeLog)

Description copied from interface: AccountFeeLogServiceLocal

Returns whether there are UserAccountFeeLogs for the given fee execution

Specified by:

hasUsers in interface AccountFeeLogServiceLocal

insertMissingScheduledExecutions

public long insertMissingScheduledExecutions()
                                      throws FrameworkException

Description copied from interface: AccountFeeLogServiceLocal

For each enabled scheduled fee, inserts all missing AccountFeeLogs

Specified by:

insertMissingScheduledExecutions in interface AccountFeeLogServiceLocal

Throws:

FrameworkException

markFinished

public void markFinished(AccountFeeLog log)

Description copied from interface: AccountFeeLogServiceLocal

Marks the given account fee log as finished.

Specified by:

markFinished in interface AccountFeeLogServiceLocal

rechargeFailed

public void rechargeFailed(Long id)
                    throws FrameworkException

Description copied from interface: AccountFeeLogService

Starts recharging a fee which has finished and some failed users

Specified by:

rechargeFailed in interface AccountFeeLogService

Throws:

IllegalActionException - If the given account fee log is not finished or doesn't have any failed users

FrameworkException

resolveAccount

public UserAccount resolveAccount(AccountFeeLog accountFeeLog,
                                  User user)

Description copied from interface: AccountFeeLogServiceLocal

Returns the UserAccount for the given user involved in the given fee log. Account fees may be paid from or to system.

Specified by:

resolveAccount in interface AccountFeeLogServiceLocal

runNow

public Long runNow(AccountFeeVO accountFeeVO)
            throws FrameworkException

Description copied from interface: AccountFeeLogService

Starts charging a manual fee, returning the resulting account fee log id

Specified by:

runNow in interface AccountFeeLogService

Throws:

IllegalActionException - If the given fee is disabled or not manual

FrameworkException

search

public Page<AccountFeeLogVO> search(AccountFeeLogQuery query)
                             throws FrameworkException

Description copied from interface: AccountFeeLogService

Searches for account fee logs according to the given criteria

Specified by:

search in interface AccountFeeLogService

Throws:

FrameworkException

searchFeeExecutions

public Page<AccountFeeExecutionVO> searchFeeExecutions(AccountFeeQuery query)
                                                throws FrameworkException

Description copied from interface: AccountFeeLogService

Search for visible account fees, together with the previous and next execution data

Specified by:

searchFeeExecutions in interface AccountFeeLogService

Throws:

FrameworkException

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