com.crm.businessobject.wallets

Class CRMBOWalletBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOMasterEntity

com.crm.businessobject.wallets.CRMBOWalletBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOWalletBean
extends CRMBOMasterEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOWalletBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	adjustAmountToAlternativeCurrency(com.crm.dataobject.wallets.CRMDOWallet wallet, java.math.BigDecimal awardAmount)
com.crm.dataobject.wallets.CRMDOWallet	cancel(com.crm.dataobject.wallets.CRMDOWallet wallet) Cancels a wallet.
com.crm.dataobject.wallets.CRMDOWallet	estimateConsumptionDates(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.billing.CRMDOPrepaidBillingRun billingRun) Estimates the product consumption dates of a wallet.
com.crm.dataobject.wallets.CRMDOWallet	estimateConsumptionDates(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, java.lang.Integer numberOfDays) Estimates the product consumption dates of a wallet for the next number of days given.
java.math.BigDecimal	getAlternativeBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.ArrayList<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition> allotmentGroupConditions, java.util.Date asOfDate) Returns the alternative balance of a wallet Group Conditions list.
java.math.BigDecimal	getAlternativeBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, java.util.Date validityDate, java.util.Date asOfDate) Returns the balance of a wallet Group Conditions list.
java.math.BigDecimal	getAlternativeBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate) Returns the balance of a wallet Group Conditions list.
java.math.BigDecimal	getAlternativeConditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date date)
com.crm.dataobject.platform.CRMDOCurrency	getAlternativeCurrency() Returns the alternative currency of the wallet.
java.math.BigDecimal	getAlternativeLatestMonthAwardAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate, java.lang.Integer months)
java.math.BigDecimal	getAlternativeLatestMonthSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate, java.lang.Integer months)
java.math.BigDecimal	getAlternativeLatestMonthSubscriptionsSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate, java.lang.Integer months)
java.math.BigDecimal	getAlternativeTotalPeriodCredits(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getAlternativeTotalPeriodDebits(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getAlternativeUnconditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date date)
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet) Returns the balance of wallet.
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition allotmentGroupCondition) Returns the balance of a wallet Group Condition.
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition allotmentGroupCondition, java.util.Date asOfDate) Returns the balance of a wallet Group Condition.
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.ArrayList<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition> allotmentGroupConditions, java.util.Date asOfDate) Returns the balance of a wallet Group Conditions list.
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.products.CRMDOProduct product) Returns the balance of wallet product.
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date validityDate) Returns the balance of wallet.
java.math.BigDecimal	getConditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getConditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date date)
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a wallet.
java.math.BigDecimal	getExpiringAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date thresholdDate) Returns the unallocated amount of a wallet
java.math.BigDecimal	getExpiringAmount(com.crm.dataobject.wallets.CRMDOWalletTransaction walletTransaction, java.util.Date thresholdDate) Returns the unallocated amount of a wallet
java.util.HashMap<java.util.Date,java.math.BigDecimal>	getExpiringAmountPerDay(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date thresholdDate) Returns the unallocated amount of a wallet per day
java.util.Date	getLatestCreditDate(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.util.Date	getLatestDebitDate(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getLatestMonthAwardAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate, java.lang.Integer months)
java.math.BigDecimal	getLatestMonthSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate, java.lang.Integer months)
java.math.BigDecimal	getLatestMonthSubscriptionsSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date asOfDate, java.lang.Integer months)
java.math.BigDecimal	getMinimumBalanceThreshold(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition) Get the minimum balance threshold from the wallet definition and convert it to the alternative currency of the account
java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct>	getProductAllotments(com.crm.dataobject.wallets.CRMDOWallet wallet) Loads a list of product allotments of a wallet.
java.math.BigDecimal	getProductAvailableAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, java.util.Date asOfDate) Returns the product available amount based on the parameters given.
java.math.BigDecimal	getProductAvailableAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, java.util.Date validityDate, java.util.Date asOfDate) Returns the product available amount based on the parameters given.
java.math.BigDecimal	getProductAvailableAmount(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.HashMap<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition,java.math.BigDecimal> walletTrxAmounts, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, java.util.Date asOfDate, java.math.BigDecimal requestedAmount) Returns the product available amount based on the parameters given - If available amount bigger than requested amount then it returns the requested amount else return the available amount
java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct>	getProducts(com.crm.dataobject.wallets.CRMDOWallet wallet) Loads a list of product allotments of a wallet.
java.math.BigDecimal	getTotalPeriodCredits(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getTotalPeriodDebits(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getUnconditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.math.BigDecimal	getUnconditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.Date date)
java.util.ArrayList<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition>	getWalletAllotmentGroupConditions(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, java.util.Date validityDate, java.util.Date asOfDate) Returns the wallet allotment group conditions based on the parameters given.
java.lang.Boolean	ifWalletExists(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if a wallet exists based on an accounts receivable.
java.lang.Boolean	isRelatedChangesExists(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.wallets.CRMDOWallet wallet) Return true if the specify wallet has related changes that may change the consumption dates
java.lang.Boolean	isRelatedChangesExists(com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.wallets.CRMDOWallet wallet) Return true if the specify wallet has related changes that may change the consumption dates
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations) Loads a wallet by an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations) Loads a wallet by an account.
com.crm.dataobject.wallets.CRMDOWallet	loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Loads the active wallet of an account.
com.crm.dataobject.wallets.CRMDOWallet	loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.ArrayList<java.lang.String> associations) Loads the active wallet of an account.
com.crm.dataobject.wallets.CRMDOWallet	loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.wallets.CRMDOWallet excludeWallet) Loads the active wallet of an account.
com.crm.dataobject.wallets.CRMDOWallet	loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.wallets.CRMDOWallet excludeWallet, java.lang.Boolean skipNetworkBusinessFiltering) Loads the active wallet of an account.
com.crm.dataobject.wallets.CRMDOWallet	loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.wallets.CRMDOWallet excludeWallet, java.lang.Boolean skipNetworkBusinessFiltering, java.util.ArrayList<java.lang.String> associations) Loads the active wallet of an account.
com.crm.dataobject.wallets.CRMDOWallet	loadAdditionalInformation(com.crm.dataobject.wallets.CRMDOWallet wallet) Loads additional information of a wallet.
com.crm.dataobject.wallets.CRMDOWallet	loadBalanceInformation(com.crm.dataobject.wallets.CRMDOWallet wallet)
com.crm.dataobject.wallets.CRMDOWallet	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Loads the active wallet of an account during billing run.
com.crm.dataobject.wallets.CRMDOWallet	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a wallet by a number.
com.crm.dataobject.wallets.CRMDOWallet	loadCancelledByEntityValue(com.crm.dataobject.wallets.CRMDOWallet wallet) Loads a wallet and sets cancelled by entity information based on the entity that cancelled it.
com.crm.dataobject.wallets.CRMDOWallet	loadCreatedByEntityValue(com.crm.dataobject.wallets.CRMDOWallet wallet) Loads a wallet and sets created by entity information based on the entity that created it.
com.crm.dataobject.wallets.CRMDOWallet	loadGroupConditions(com.crm.dataobject.wallets.CRMDOWallet wallet)
com.crm.dataobject.wallets.CRMDOWallet	loadGroupConditions(com.crm.dataobject.wallets.CRMDOWallet wallet, java.lang.Boolean initializeAllotments, java.lang.Boolean initializeConditions)
com.crm.dataobject.wallets.CRMDOWallet	setWalletEstimationDates(com.crm.dataobject.wallets.CRMDOWallet wallet) Sets Wallet Estimation consumption Dates of a wallet.
void	validateTransferToAccount(java.math.BigDecimal transferAmount, com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition) Validates the transfer from a wallet to an account, by validating the amount of the transfer, the wallet balance and the applicable wallet definition cause configuration
void	validateTransferToWallet(java.math.BigDecimal transferAmount, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition) Validates the transfer from an account to a wallet, by validating the amount of the transfer, the account balance and the applicable wallet definition cause configuration
void	validateTransferToWallet(java.math.BigDecimal transferAmount, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition) Validates the transfer from an account to a wallet, by validating the amount of the transfer, the account balance and the applicable wallet definition cause configuration

Methods inherited from class com.crm.businessobject.CRMBOMasterEntity

setLifeCycleState

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMBOWalletBean

public CRMBOWalletBean()

Default constructor.

Method Detail

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Returns the default associated data objects of a wallet.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the wallet

cancel

public com.crm.dataobject.wallets.CRMDOWallet cancel(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                              throws java.lang.Exception,
                                                     com.crm.exception.AlreadyCancelledException

Cancels a wallet.

Parameters:

wallet - - the wallet to cancel

Returns:

the cancelled wallet

Throws:

java.lang.Exception

com.crm.exception.AlreadyCancelledException

loadActive

public com.crm.dataobject.wallets.CRMDOWallet loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                  throws java.lang.Exception

Loads the active wallet of an account.

Parameters:

account - - the account to load the active wallet from

Returns:

the active wallet of the given account

Throws:

java.lang.Exception

loadActive

public com.crm.dataobject.wallets.CRMDOWallet loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         java.util.ArrayList<java.lang.String> associations)
                                                  throws java.lang.Exception

Loads the active wallet of an account.

Parameters:

account - - the account to load the active wallet from

Returns:

the active wallet of the given account

Throws:

java.lang.Exception

loadActive

public com.crm.dataobject.wallets.CRMDOWallet loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         com.crm.dataobject.wallets.CRMDOWallet excludeWallet)
                                                  throws java.lang.Exception

Loads the active wallet of an account.

Parameters:

account - - the account to load the active wallet from

excludeWallet - - the wallet to exclude

Returns:

the active wallet of the given account

Throws:

java.lang.Exception

loadActive

public com.crm.dataobject.wallets.CRMDOWallet loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         com.crm.dataobject.wallets.CRMDOWallet excludeWallet,
                                                         java.lang.Boolean skipNetworkBusinessFiltering)
                                                  throws java.lang.Exception

Loads the active wallet of an account.

Parameters:

account - - the account to load the active wallet from

excludeWallet - - the wallet to exclude

skipNetworkBusinessFiltering - - a flag to skip network business filtering

Returns:

the active wallet of the given account

Throws:

java.lang.Exception

loadActive

public com.crm.dataobject.wallets.CRMDOWallet loadActive(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         com.crm.dataobject.wallets.CRMDOWallet excludeWallet,
                                                         java.lang.Boolean skipNetworkBusinessFiltering,
                                                         java.util.ArrayList<java.lang.String> associations)
                                                  throws java.lang.Exception

Loads the active wallet of an account.

Parameters:

account - - the account to load the active wallet from

excludeWallet - - the wallet to exclude

skipNetworkBusinessFiltering - - a flag to skip network business filtering

Returns:

the active wallet of the given account

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.wallets.CRMDOWallet loadByNumber(java.lang.String number,
                                                           java.util.ArrayList<java.lang.String> associations)
                                                    throws java.lang.Exception

Loads a wallet by a number.

Parameters:

number - - the wallet number

associations - - a list of associated data objects

Returns:

a wallet with the given number

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a wallet by an account.

Parameters:

accountReceivable - - the account to load the wallet for

associations - - a list of associated data objects

Returns:

a wallet of the given account

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String orderBy,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offset,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a wallet by an account.

Parameters:

orderBy - - the ordering field

numberOfResults - - The number of results that can be retrieved

offset - - It defines the number of entities that should be skipped from the results

accountReceivable - - the account to load the wallet for

associations - - a list of associated data objects

Returns:

a list of wallets based on the given parameters

Throws:

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.wallets.CRMDOWallet loadAdditionalInformation(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                 throws java.lang.Exception

Loads additional information of a wallet. - sets the balance - the entity has create the wallet - the entity has cancel the wallet - Sets Wallet Estimation consumption Dates of wallet

Parameters:

wallet - - the wallet to load the additional information for

Returns:

the updated wallet

Throws:

java.lang.Exception

getAlternativeCurrency

public com.crm.dataobject.platform.CRMDOCurrency getAlternativeCurrency()
                                                                 throws java.lang.Exception

Returns the alternative currency of the wallet.

Returns:

the alternative currency of the wallet

Throws:

java.lang.Exception

setWalletEstimationDates

public com.crm.dataobject.wallets.CRMDOWallet setWalletEstimationDates(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                throws java.lang.Exception

Sets Wallet Estimation consumption Dates of a wallet.

Parameters:

wallet - - the wallet to load Estimation consumption Dates for

Returns:

the updated wallet

Throws:

java.lang.Exception

loadCreatedByEntityValue

public com.crm.dataobject.wallets.CRMDOWallet loadCreatedByEntityValue(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                throws java.lang.Exception

Loads a wallet and sets created by entity information based on the entity that created it.

Parameters:

wallet - - the wallet to use

Returns:

the updated wallet

Throws:

java.lang.Exception

loadCancelledByEntityValue

public com.crm.dataobject.wallets.CRMDOWallet loadCancelledByEntityValue(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                  throws java.lang.Exception

Loads a wallet and sets cancelled by entity information based on the entity that cancelled it.

Parameters:

wallet - - the wallet to use

Returns:

the updated wallet

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                throws java.lang.Exception

Returns the balance of wallet.

Parameters:

wallet - - the wallet to return the balance for

Returns:

the balance of the wallet

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                       java.util.Date validityDate)
                                throws java.lang.Exception

Returns the balance of wallet.

Parameters:

wallet - - the wallet to return the balance for

validityDate - - the validity date to return the balance for

Returns:

the balance of the wallet

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                       com.crm.dataobject.products.CRMDOProduct product)
                                throws java.lang.Exception

Returns the balance of wallet product.

Parameters:

wallet - - the wallet to return the balance for

product - - the product to return the wallet balance for

Returns:

the balance of the wallet

Throws:

java.lang.Exception

estimateConsumptionDates

public com.crm.dataobject.wallets.CRMDOWallet estimateConsumptionDates(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                       com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                                       java.lang.Integer numberOfDays)
                                                                throws java.lang.Exception

Estimates the product consumption dates of a wallet for the next number of days given.

Parameters:

wallet - - the wallet to estimate product consumption dates

prepaidBillingRun - - the billing run to use

numberOfDays - - the period of days to look for consumption dates

Returns:

the updated wallet

Throws:

java.lang.Exception

estimateConsumptionDates

public com.crm.dataobject.wallets.CRMDOWallet estimateConsumptionDates(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                       com.crm.dataobject.billing.CRMDOPrepaidBillingRun billingRun)
                                                                throws java.lang.Exception

Estimates the product consumption dates of a wallet.

Parameters:

wallet - - the wallet to estimate product consumption dates

billingRun - - the billing run to use

Returns:

the updated wallet

Throws:

java.lang.Exception

getProductAllotments

public java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> getProductAllotments(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                                   throws java.lang.Exception

Loads a list of product allotments of a wallet.

Parameters:

wallet - - the wallet to load the product allotments for

Returns:

a list of product allotments of the given wallet

Throws:

java.lang.Exception

getProducts

public java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> getProducts(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                          throws java.lang.Exception

Loads a list of product allotments of a wallet.

Parameters:

wallet - - the wallet to load the product allotments for

Returns:

a list of product allotments of the given wallet

Throws:

java.lang.Exception

getProductAvailableAmount

public java.math.BigDecimal getProductAvailableAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                      com.crm.dataobject.products.CRMDOProduct product,
                                                      com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                      com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                      java.util.Date asOfDate)
                                               throws java.lang.Exception

Returns the product available amount based on the parameters given.

Parameters:

wallet - - the wallet to use

product - - the product to use

unit - - the unit to use

group - - the group to use

asOfDate - - the as of date to use

Returns:

the product available amount based on the parameters given

Throws:

java.lang.Exception

getProductAvailableAmount

public java.math.BigDecimal getProductAvailableAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                      com.crm.dataobject.products.CRMDOProduct product,
                                                      com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                      com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                      java.util.Date validityDate,
                                                      java.util.Date asOfDate)
                                               throws java.lang.Exception

Returns the product available amount based on the parameters given.

Parameters:

wallet - - the wallet to use

product - - the product to use

unit - - the unit to use

group - - the group to use

validityDate - - the validity date to use

asOfDate - - the as of date to use

Returns:

the product available amount based on the parameters given

Throws:

java.lang.Exception

getWalletAllotmentGroupConditions

public java.util.ArrayList<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition> getWalletAllotmentGroupConditions(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                                                                            com.crm.dataobject.products.CRMDOProduct product,
                                                                                                                            com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                                                                                            com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                                                                                            java.util.Date validityDate,
                                                                                                                            java.util.Date asOfDate)
                                                                                                                     throws java.lang.Exception

Returns the wallet allotment group conditions based on the parameters given.

Parameters:

wallet - - the wallet to use

product - - the product to use

unit - - the unit to use

group - - the group to use

validityDate - - the validity date to use

asOfDate - - the as of date to use

Returns:

the allet allotment group conditions based on the parameters given

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition allotmentGroupCondition)
                                throws java.lang.Exception

Returns the balance of a wallet Group Condition.

Parameters:

allotmentGroupCondition - - the wallet Group Condition to return the balance for

Returns:

the balance of the wallet Group Condition.

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition allotmentGroupCondition,
                                       java.util.Date asOfDate)
                                throws java.lang.Exception

Returns the balance of a wallet Group Condition.

Parameters:

allotmentGroupCondition - - the wallet Group Condition to return the balance for

asOfDate - - the as of date to use

Returns:

the balance of the wallet Group Condition.

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                       java.util.ArrayList<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition> allotmentGroupConditions,
                                       java.util.Date asOfDate)
                                throws java.lang.Exception

Returns the balance of a wallet Group Conditions list.

Parameters:

wallet - - the wallet to use

allotmentGroupConditions - - the list of wallet Group Conditions to return the balance for

asOfDate - - the as of date to use

Returns:

the balance of the wallet Group Condition.

Throws:

java.lang.Exception

getAlternativeBalance

public java.math.BigDecimal getAlternativeBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                  java.util.ArrayList<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition> allotmentGroupConditions,
                                                  java.util.Date asOfDate)
                                           throws java.lang.Exception

Returns the alternative balance of a wallet Group Conditions list.

Parameters:

wallet - - the wallet to use

allotmentGroupConditions - - the list of wallet Group Conditions to return the alternative balance for

asOfDate - - the as of date to use

Returns:

the alternative balance of the wallet Group Condition.

Throws:

java.lang.Exception

getAlternativeBalance

public java.math.BigDecimal getAlternativeBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                  java.util.Date asOfDate)
                                           throws java.lang.Exception

Returns the balance of a wallet Group Conditions list.

Parameters:

wallet - - the wallet to use

asOfDate - - the as of date to use

Returns:

the balance of the wallet Group Condition.

Throws:

java.lang.Exception

getAlternativeBalance

public java.math.BigDecimal getAlternativeBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                  com.crm.dataobject.products.CRMDOProduct product,
                                                  com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                  com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                  java.util.Date validityDate,
                                                  java.util.Date asOfDate)
                                           throws java.lang.Exception

Returns the balance of a wallet Group Conditions list.

Parameters:

wallet - - the wallet to use

product - - the product to use

unit - - the unit to use

group - - the group to use

validityDate - - the validity date to use

asOfDate - - the as of date to use

Returns:

the balance of the wallet Group Condition.

Throws:

java.lang.Exception

isRelatedChangesExists

public java.lang.Boolean isRelatedChangesExists(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                com.crm.dataobject.wallets.CRMDOWallet wallet)
                                         throws java.lang.Exception

Return true if the specify wallet has related changes that may change the consumption dates

Parameters:

accountReceivable - - the Accounts Receivable to use

wallet - - the wallet to use

Returns:

true if the specify wallet has related changes that may change the consumption dates, false otherwise

Throws:

java.lang.Exception

isRelatedChangesExists

public java.lang.Boolean isRelatedChangesExists(com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                com.crm.dataobject.wallets.CRMDOWallet wallet)
                                         throws java.lang.Exception

Return true if the specify wallet has related changes that may change the consumption dates

Parameters:

prepaidBillingRun - - the prepaid Billing Run to use

accountReceivable - - the Accounts Receivable to use

wallet - - the wallet to use

Returns:

Throws:

java.lang.Exception

ifWalletExists

public java.lang.Boolean ifWalletExists(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                 throws java.lang.Exception

Checks if a wallet exists based on an accounts receivable.

Parameters:

accountReceivable - - the accounts receivable to check

Returns:

true if a wallet exists based on an accounts receivable, false if not

Throws:

java.lang.Exception

loadGroupConditions

public com.crm.dataobject.wallets.CRMDOWallet loadGroupConditions(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

loadGroupConditions

public com.crm.dataobject.wallets.CRMDOWallet loadGroupConditions(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                  java.lang.Boolean initializeAllotments,
                                                                  java.lang.Boolean initializeConditions)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

loadBillable

public com.crm.dataobject.wallets.CRMDOWallet loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                    throws java.lang.Exception

Loads the active wallet of an account during billing run.

Parameters:

account - - the account to load the active wallet for

Returns:

the active wallet of the given account

Throws:

java.lang.Exception

getMinimumBalanceThreshold

public java.math.BigDecimal getMinimumBalanceThreshold(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                       com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition)
                                                throws java.lang.Exception

Get the minimum balance threshold from the wallet definition and convert it to the alternative currency of the account

Parameters:

wallet - - the wallet in order to check if adjustment of the threshold needed

walletDefinition - - the wallet definition data object

Returns:

the minimum balance threshold adjusted in the currency of the wallet

Throws:

java.lang.Exception

getExpiringAmount

public java.math.BigDecimal getExpiringAmount(com.crm.dataobject.wallets.CRMDOWalletTransaction walletTransaction,
                                              java.util.Date thresholdDate)
                                       throws java.lang.Exception

Returns the unallocated amount of a wallet

Parameters:

walletTransaction - - the wallet transaction to get unallocated amount for

thresholdDate - - the date to validate the expiration date

Returns:

the unallocated amount of a wallet

Throws:

java.lang.Exception

getExpiringAmount

public java.math.BigDecimal getExpiringAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                              java.util.Date thresholdDate)
                                       throws java.lang.Exception

Returns the unallocated amount of a wallet

Parameters:

wallet - - the wallet to get unallocated amount for

thresholdDate - - the date to validate the expiration date

Returns:

the unallocated amount of a wallet

Throws:

java.lang.Exception

getExpiringAmountPerDay

public java.util.HashMap<java.util.Date,java.math.BigDecimal> getExpiringAmountPerDay(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                                      java.util.Date thresholdDate)
                                                                               throws java.lang.Exception

Returns the unallocated amount of a wallet per day

Parameters:

wallet - - the wallet to get unallocated amount for

thresholdDate - - the date to validate the expiration date

Returns:

the unallocated amount of a wallet per day

Throws:

java.lang.Exception

getLatestDebitDate

public java.util.Date getLatestDebitDate(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getLatestCreditDate

public java.util.Date getLatestCreditDate(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getTotalPeriodDebits

public java.math.BigDecimal getTotalPeriodDebits(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeTotalPeriodDebits

public java.math.BigDecimal getAlternativeTotalPeriodDebits(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getTotalPeriodCredits

public java.math.BigDecimal getTotalPeriodCredits(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeTotalPeriodCredits

public java.math.BigDecimal getAlternativeTotalPeriodCredits(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getConditionalBalance

public java.math.BigDecimal getConditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getConditionalBalance

public java.math.BigDecimal getConditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                  java.util.Date date)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeConditionalBalance

public java.math.BigDecimal getAlternativeConditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                             java.util.Date date)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getUnconditionalBalance

public java.math.BigDecimal getUnconditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getUnconditionalBalance

public java.math.BigDecimal getUnconditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                    java.util.Date date)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeUnconditionalBalance

public java.math.BigDecimal getAlternativeUnconditionalBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                               java.util.Date date)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

getLatestMonthAwardAmount

public java.math.BigDecimal getLatestMonthAwardAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                      java.util.Date asOfDate,
                                                      java.lang.Integer months)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeLatestMonthAwardAmount

public java.math.BigDecimal getAlternativeLatestMonthAwardAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                 java.util.Date asOfDate,
                                                                 java.lang.Integer months)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getLatestMonthSpendAmount

public java.math.BigDecimal getLatestMonthSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                      java.util.Date asOfDate,
                                                      java.lang.Integer months)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeLatestMonthSpendAmount

public java.math.BigDecimal getAlternativeLatestMonthSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                 java.util.Date asOfDate,
                                                                 java.lang.Integer months)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getLatestMonthSubscriptionsSpendAmount

public java.math.BigDecimal getLatestMonthSubscriptionsSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                   java.util.Date asOfDate,
                                                                   java.lang.Integer months)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeLatestMonthSubscriptionsSpendAmount

public java.math.BigDecimal getAlternativeLatestMonthSubscriptionsSpendAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                              java.util.Date asOfDate,
                                                                              java.lang.Integer months)
                                                                       throws java.lang.Exception

Throws:

java.lang.Exception

loadBalanceInformation

public com.crm.dataobject.wallets.CRMDOWallet loadBalanceInformation(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

adjustAmountToAlternativeCurrency

public java.math.BigDecimal adjustAmountToAlternativeCurrency(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                              java.math.BigDecimal awardAmount)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

validateTransferToWallet

public void validateTransferToWallet(java.math.BigDecimal transferAmount,
                                     com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                     com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition)
                              throws java.lang.Exception

Validates the transfer from an account to a wallet, by validating the amount of the transfer, the account balance and the applicable wallet definition cause configuration

Parameters:

transferAmount - the amount to transfer

account - the account to make the transfer from

walletDefinition - the active wallet definition

Throws:

java.lang.Exception

validateTransferToWallet

public void validateTransferToWallet(java.math.BigDecimal transferAmount,
                                     com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                     com.crm.dataobject.wallets.CRMDOWallet wallet,
                                     com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition)
                              throws java.lang.Exception

Validates the transfer from an account to a wallet, by validating the amount of the transfer, the account balance and the applicable wallet definition cause configuration

Parameters:

transferAmount - the amount to transfer

account - the account to make the transfer from

wallet - the wallet to make the transfer to

walletDefinition - the active wallet definition

Throws:

java.lang.Exception

validateTransferToAccount

public void validateTransferToAccount(java.math.BigDecimal transferAmount,
                                      com.crm.dataobject.wallets.CRMDOWallet wallet,
                                      com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition)
                               throws java.lang.Exception

Validates the transfer from a wallet to an account, by validating the amount of the transfer, the wallet balance and the applicable wallet definition cause configuration

Parameters:

transferAmount - the amount to transfer

wallet - the wallet to make the transfer from

walletDefinition - the active wallet definition

Throws:

java.lang.Exception

getProductAvailableAmount

public java.math.BigDecimal getProductAvailableAmount(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                      java.util.HashMap<com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition,java.math.BigDecimal> walletTrxAmounts,
                                                      com.crm.dataobject.products.CRMDOProduct product,
                                                      com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                      com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                      java.util.Date asOfDate,
                                                      java.math.BigDecimal requestedAmount)
                                               throws java.lang.Exception

Returns the product available amount based on the parameters given
- If available amount bigger than requested amount then it returns the requested amount else return the available amount

Parameters:

wallet - - the wallet to use

walletTrxAmounts - - the wallet transaction amounts

product - - the product to use

unit - - the unit to use

group - - the group to use

asOfDate - - the as of date to use

requestedAmount - - the requested amount

Returns:

the product available amount based on the parameters given

Throws:

java.lang.Exception