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

Methods

Modifier and Type	Method and Description
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	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.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a wallet.
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.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.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.
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, com.crm.dataobject.wallets.CRMDOWallet excludeWallet) 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	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	setWalletEstimationDates(com.crm.dataobject.wallets.CRMDOWallet wallet) Sets Wallet Estimation consumption Dates of a wallet.

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, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

dispatch, getCRMSession, getCRMSessionHandle, 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:

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

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

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

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

prepaidBillingRun - - 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

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

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

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:

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