Package org.cyclos.impl.banking

Interface AccountFeeLogServiceLocal

All Superinterfaces:

AccountFeeLogService, Service

All Known Implementing Classes:

AccountFeeLogServiceImpl

public interface AccountFeeLogServiceLocal
extends AccountFeeLogService

Local interface for AccountFeeLogService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ACCOUNT	Script attribute: user account being charged
static String	ATTR_EXECUTION_DATE	Script attribute: the expected execution date
static String	ATTR_FEE	Script attribute: fee being charged

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 userAccount)	Returns the reserved amount for an account fee over a given account
boolean	chargeBatch(List<Long> uaflIds)	Changes a batch of UserAccountFeeLogs.
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
com.mysema.commons.lang.CloseableIterator<Long>	getUserAFLIdsToCharge(AccountFeeLog accountFeeLog)	Returns the identifiers of UserAccountFeeLogs that should be charged for this log.
long	insertMissingScheduledExecutions()	For each enabled scheduled fee, inserts all missing AccountFeeLogs
boolean	markFinished(AccountFeeLog log)	Marks the given account fee log as finished.

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

getData, getFeeExecutionsSearchData, getSearchData, rechargeFailed, runNow, search, searchFeeExecutions

Field Detail

ATTR_FEE

static final String ATTR_FEE

Script attribute: fee being charged

See Also:

Constant Field Values

ATTR_ACCOUNT

static final String ATTR_ACCOUNT

Script attribute: user account being charged

See Also:

Constant Field Values

ATTR_EXECUTION_DATE

static final String ATTR_EXECUTION_DATE

Script attribute: the expected execution date

See Also:

Constant Field Values

Method Detail

archiveAccountFee

long archiveAccountFee(long id)

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

calculateAmount

BigDecimal calculateAmount(AccountFeeLog execution,
                           UserAccount account)

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)

calculateReservedAmount

BigDecimal calculateReservedAmount(AccountFee accountFee,
                                   UserAccount userAccount)

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

chargeBatch

boolean chargeBatch(List<Long> uaflIds)

Changes a batch of UserAccountFeeLogs. All ids must belong to the same log If after this batch the log is finished, mark it as finished

Returns:

Whether the log has finished or not.

getLastExecution

AccountFeeLog getLastExecution(AccountFee accountFee)

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

getNextExecutionDate

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

getUserAFLIdsToCharge

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

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.

insertMissingScheduledExecutions

long insertMissingScheduledExecutions()

For each enabled scheduled fee, inserts all missing AccountFeeLogs

markFinished

boolean markFinished(AccountFeeLog log)

Marks the given account fee log as finished. Is here in the local interface because is used by a migration (see database_4.13).

Returns:

Whether the log has marked as finished or not by this invocation.