com.crm.businessobject.wallets

Class CRMBOWalletAllotmentBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.wallets.CRMBOWalletAllotmentBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOWalletAllotmentBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOWalletAllotmentBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet) Calculates the total amount of the wallet allotments related to the given wallet and wallet balance period
java.math.BigDecimal	getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.wallets.CRMDOWalletBalancePeriod walletBalancePeriod) Calculates the total amount of the wallet allotments related to the given wallet and wallet balance period
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a wallet allotment.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.wallets.CRMDOWallet wallet)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition groupCondition) Loads a list of allotments of a wallet transaction.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition groupCondition, java.util.ArrayList<java.lang.String> associations) Loads a list of wallet allotments of a wallet allotment group condition.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition groupCondition, java.util.ArrayList<java.lang.String> associations, java.lang.Boolean excludedPeriodRelated) Loads a list of wallet allotments of a wallet allotment group condition.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.wallets.CRMDOWalletTransaction walletTransaction) Loads a list of allotments of a wallet transaction.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String walletID, java.util.Date toDate, java.lang.Boolean walletBalancePeriodIncluded) Loads a list of allotments of a wallet valid for a specific period
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String walletID, java.util.Date toDate, java.lang.Boolean walletBalancePeriodIncluded, java.util.ArrayList<java.lang.String> associations) Loads a list of allotments of a wallet valid for a specific period
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPerWalletAllotmentGroupCondition(java.lang.String walletAllotmentGroupConditionID, java.lang.String walletID) Loads a list of wallet allotments for a specific wallet and wallet allotment group condition
com.crm.dataobject.wallets.CRMDOWalletAllotment	setGroupCondition(com.crm.dataobject.wallets.CRMDOWalletAllotment walletAllotment) Sets group conditions to a wallet allotment if none already exist.
void	validateAllotmentConditions(com.crm.dataobject.wallets.CRMDOWalletAllotment walletAllotment) Validates the conditions of a wallet allotment.

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

CRMBOWalletAllotmentBean

public CRMBOWalletAllotmentBean()

Default constructor.

Method Detail

setGroupCondition

public com.crm.dataobject.wallets.CRMDOWalletAllotment setGroupCondition(com.crm.dataobject.wallets.CRMDOWalletAllotment walletAllotment)
                                                                  throws java.lang.Exception

Sets group conditions to a wallet allotment if none already exist.

Parameters:

walletAllotment - - the wallet allotment to set the group conditions to

Returns:

the updated wallet allotment

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a wallet allotment.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the wallet allotment

validateAllotmentConditions

public void validateAllotmentConditions(com.crm.dataobject.wallets.CRMDOWalletAllotment walletAllotment)
                                 throws java.lang.Exception

Validates the conditions of a wallet allotment.

Parameters:

walletAllotment - - the wallet allotment to validate the conditions of

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.wallets.CRMDOWalletTransaction walletTransaction)
                                                   throws java.lang.Exception

Loads a list of allotments of a wallet transaction.

Parameters:

walletTransaction - - the wallet transaction to load the allotments for

Returns:

a list of allotments of the wallet transaction

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String walletID,
                                                          java.util.Date toDate,
                                                          java.lang.Boolean walletBalancePeriodIncluded)
                                                   throws java.lang.Exception

Loads a list of allotments of a wallet valid for a specific period

Parameters:

walletID - - the id of the wallet to load the allotments for

toDate - - the date to which the allotments must be valid

walletBalancePeriodIncluded - - indicates whether the loaded list of allotments should be related to a wallet balance period or not

Returns:

a list of allotments

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String walletID,
                                                          java.util.Date toDate,
                                                          java.lang.Boolean walletBalancePeriodIncluded,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of allotments of a wallet valid for a specific period

Parameters:

walletID - - the id of the wallet to load the allotments for

toDate - - the date to which the allotments must be valid

walletBalancePeriodIncluded - - indicates whether the loaded list of allotments should be related to a wallet balance period or not

associations - - a list of associated objects to load

Returns:

a list of allotments

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition groupCondition)
                                                   throws java.lang.Exception

Loads a list of allotments of a wallet transaction.

Parameters:

groupCondition - - the wallet transaction to load the allotments for

Returns:

a list of allotments of the wallet transaction

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition groupCondition,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of wallet allotments of a wallet allotment group condition.

Parameters:

groupCondition - - the wallet allotment group condition to load the allotments for

associations - - a list of associated data objects

Returns:

a list of wallet allotments

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.wallets.CRMDOWalletAllotmentGroupCondition groupCondition,
                                                          java.util.ArrayList<java.lang.String> associations,
                                                          java.lang.Boolean excludedPeriodRelated)
                                                   throws java.lang.Exception

Loads a list of wallet allotments of a wallet allotment group condition.

Parameters:

groupCondition - - the wallet allotment group condition to load the allotments for

associations - - a list of associated data objects

Returns:

a list of wallet allotments

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

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

Throws:

java.lang.Exception

loadPerWalletAllotmentGroupCondition

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPerWalletAllotmentGroupCondition(java.lang.String walletAllotmentGroupConditionID,
                                                                                          java.lang.String walletID)
                                                                                   throws java.lang.Exception

Loads a list of wallet allotments for a specific wallet and wallet allotment group condition

Parameters:

walletAllotmentGroupConditionID - - the wallet allotment group condition id

walletID - - the wallet id

Returns:

a list of allotments of the wallet transaction

Throws:

java.lang.Exception

getBalance

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

Calculates the total amount of the wallet allotments related to the given wallet and wallet balance period

Parameters:

wallet - - the wallet to calculate the total allotment amount for

Returns:

the total wallet allotment amount

Throws:

java.lang.Exception

com.crm.exception.CRMException

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                       com.crm.dataobject.wallets.CRMDOWalletBalancePeriod walletBalancePeriod)
                                throws com.crm.exception.CRMException,
                                       java.lang.Exception

Calculates the total amount of the wallet allotments related to the given wallet and wallet balance period

Parameters:

wallet - - the wallet to calculate the total allotment amount for

walletBalancePeriod - - the wallet balance period to calculate the total allotment amount for

Returns:

the total wallet allotment amount

Throws:

java.lang.Exception

com.crm.exception.CRMException