com.crm.businessobject.billing

Class CRMBOUsageAllowanceLimitBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.billing.CRMBOUsageAllowanceLimitBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOUsageAllowanceLimitBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOUsageAllowanceLimitBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateConsumedUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate) Calculates the consumed usage allowance of an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateConsumedUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate, com.crm.dataobject.billing.CRMDOUsageAuthorisation excludeUsageAuthorisation) Calculates the consumed usage allowance of an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateConsumedUsageAllowancePerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate) Calculates the consumed usage allowance per service of an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateConsumedUsageAllowancePerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate, com.crm.dataobject.billing.CRMDOUsageAuthorisation excludeUsageAuthorisation) Calculates the consumed usage allowance per service of an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateMaximumAllowedUsageConsumptionAgainstCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Calculates the maximum allowed usage consumption for an acounts receivable
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateMaximumAllowedUsageConsumptionAgainstCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate) Calculates the maximum allowed usage consumption for an acounts receivable
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateRemainingUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Calculates the remaining usage allowance of an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateRemainingUsageAllowancePerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Calculates the remaining usage allowance per service of an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	calculateUsageAllowanceLimitWithExceededAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Calculates the usage allowance limit with exceeded amount
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a usage allowance limit
boolean	isAllowedOrginisationalUnitValid(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit, com.crm.dataobject.networkmanagement.CRMDOUnit unit) Checks if the the logged in user is allowed against organisational unit conditions If the usage allowance limit is configured on the account definition, then is valid, else the conditions are evaluated
java.lang.Boolean	isExistsForAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if a usage allowance limit exists for an account
boolean	isProductRestricted(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit, com.crm.dataobject.products.CRMDOProduct product)
com.crm.dataobject.billing.CRMDOUsageAllowanceLimit	load(com.crm.dataobject.accounts.CRMDOAccDefUsageAllowanceLimitRule ualRule) Loads a usage allowance limit by an account definition usage allowance limit rule.
com.crm.dataobject.billing.CRMDOUsageAllowanceLimit	load(com.crm.dataobject.accounts.CRMDOAccDefUsageAllowanceLimitRule ualRule, java.util.ArrayList<java.lang.String> associations) Loads a usage allowance limit by an account definition usage allowance limit rule.
com.crm.dataobject.billing.CRMDOUsageAllowanceLimit	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Loads a usage allowance limit by an account receivable.
com.crm.dataobject.billing.CRMDOUsageAllowanceLimit	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations) Loads a usage allowance limit by an account receivable.
com.crm.dataobject.accounts.CRMDOAccountReceivable	resetRemainingUsageAllowanceLimitsBasedOnCurrency(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Reset the remaining usage allowance limits for an account receivable based on the currency.
com.crm.dataobject.accounts.CRMDOAccountReceivable	resetUsageAllowanceLimitBasedOnCurrency(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Reset the usage allowance limit for an account receivable based on the currency.
com.crm.dataobject.accounts.CRMDOAccountReceivable	setAllowedExceededUsageAllowanceAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate) Calculates the allowed exceeded usage allowance for an account
com.crm.dataobject.accounts.CRMDOAccountReceivable	setAllowedRatedAmounts(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.Boolean addAllowedExceededAmount) Reset the usage allowance limit for an account receivable based on the currency.
com.crm.dataobject.accounts.CRMDOAccountReceivable	setRemainingUsageAllowanceForAllowanceWithoutLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Sets the remaining usage allowance for the usage allowance values without limit, by setting the remaining allowance per month on the remaining allowance per day and the remaining allowance per day on the remaining allowance per transaction, if any of these values are empty.
void	validateAccountMembersLimitsOnSave(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit) Validates the usage allowance limits of member accounts against the usage allowance limits of the parent accounts on save
void	validateMemberUALAgainstParentUAL(com.crm.dataobject.accounts.CRMDOAccountReceivable accountMember, com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit) Validates the usage allowance limits of member accounts against the usage allowance limits of the parent accounts on save
void	validateMemberUALAgainstParentUAL(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit memberUAL, com.crm.dataobject.billing.CRMDOUsageAllowanceLimit parentUAL) Validates the usage allowance limits of a member account against the usage allowance limits of the parent account
void	validateMemberUALAgainstParentUAL(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit memberUAL, com.crm.dataobject.billing.CRMDOUsageAllowanceLimit parentUAL, java.lang.Boolean validateUsageAllowanceLimits) Validates the usage allowance limits of a member account against the usage allowance limits of the parent account
void	validateUsageAllowanceLimitsAcrossFundedServices(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit memberUAL, com.crm.dataobject.billing.CRMDOUsageAllowanceLimit parentUAL)

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

CRMBOUsageAllowanceLimitBean

public CRMBOUsageAllowanceLimitBean()

Default constructor.

Method Detail

validateAccountMembersLimitsOnSave

public void validateAccountMembersLimitsOnSave(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                               com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)
                                        throws com.crm.exception.NumberEqualGreaterThanNumberException,
                                               java.lang.Exception

Validates the usage allowance limits of member accounts against the usage allowance limits of the parent accounts on save

Parameters:

usageAllowanceLimit - - the usage allowance limit to validate the limits for

Throws:

com.crm.exception.NumberEqualGreaterThanNumberException

java.lang.Exception

validateMemberUALAgainstParentUAL

public void validateMemberUALAgainstParentUAL(com.crm.dataobject.accounts.CRMDOAccountReceivable accountMember,
                                              com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)
                                       throws java.lang.Exception

Validates the usage allowance limits of member accounts against the usage allowance limits of the parent accounts on save

Parameters:

accountMember - - the account member to validate

usageAllowanceLimit - - the usage allowance limit to validate the limits for

Throws:

com.crm.exception.NumberEqualGreaterThanNumberException

java.lang.Exception

validateMemberUALAgainstParentUAL

public void validateMemberUALAgainstParentUAL(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit memberUAL,
                                              com.crm.dataobject.billing.CRMDOUsageAllowanceLimit parentUAL)
                                       throws com.crm.exception.NumberEqualGreaterThanNumberException,
                                              java.lang.Exception

Validates the usage allowance limits of a member account against the usage allowance limits of the parent account

Parameters:

memberUAL - - the usage allowance limit of the member account

parentUAL - - the usage allowance limit of the parent account

Throws:

com.crm.exception.NumberEqualGreaterThanNumberException

java.lang.Exception

validateMemberUALAgainstParentUAL

public void validateMemberUALAgainstParentUAL(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit memberUAL,
                                              com.crm.dataobject.billing.CRMDOUsageAllowanceLimit parentUAL,
                                              java.lang.Boolean validateUsageAllowanceLimits)
                                       throws com.crm.exception.NumberEqualGreaterThanNumberException,
                                              java.lang.Exception

Validates the usage allowance limits of a member account against the usage allowance limits of the parent account

Parameters:

memberUAL - - the usage allowance limit of the member account

parentUAL - - the usage allowance limit of the parent account

validateUsageAllowanceLimits - - whether to validate the usage allowance limit of the parent account

Throws:

com.crm.exception.NumberEqualGreaterThanNumberException

java.lang.Exception

validateUsageAllowanceLimitsAcrossFundedServices

public void validateUsageAllowanceLimitsAcrossFundedServices(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit memberUAL,
                                                             com.crm.dataobject.billing.CRMDOUsageAllowanceLimit parentUAL)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a usage allowance limit

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the usage allowance limit

load

public com.crm.dataobject.billing.CRMDOUsageAllowanceLimit load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                         throws java.lang.Exception

Loads a usage allowance limit by an account receivable.

Parameters:

accountReceivable - - the account receivable to load the usage allowance limit for

Returns:

a usage allowance limit of the given account receivable

Throws:

java.lang.Exception

load

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

Loads a usage allowance limit by an account receivable.

Parameters:

accountReceivable - - the account receivable to load the usage allowance limit for

Returns:

a usage allowance limit of the given account receivable

Throws:

java.lang.Exception

load

public com.crm.dataobject.billing.CRMDOUsageAllowanceLimit load(com.crm.dataobject.accounts.CRMDOAccDefUsageAllowanceLimitRule ualRule)
                                                         throws java.lang.Exception

Loads a usage allowance limit by an account definition usage allowance limit rule.

Parameters:

ualRule - - the account definition usage allowance limit rule to load the usage allowance limit for

Returns:

a usage allowance limit of the given account definition usage allowance limit rule

Throws:

java.lang.Exception

load

public com.crm.dataobject.billing.CRMDOUsageAllowanceLimit load(com.crm.dataobject.accounts.CRMDOAccDefUsageAllowanceLimitRule ualRule,
                                                                java.util.ArrayList<java.lang.String> associations)
                                                         throws java.lang.Exception

Loads a usage allowance limit by an account definition usage allowance limit rule.

Parameters:

ualRule - - the account definition usage allowance limit rule to load the usage allowance limit for

associations - - the associations to load with

Returns:

a usage allowance limit of the given account definition usage allowance limit rule

Throws:

java.lang.Exception

calculateConsumedUsageAllowance

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateConsumedUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                          java.util.Date validityDate)
                                                                                   throws java.lang.Exception

Calculates the consumed usage allowance of an account receivable.

Parameters:

accountReceivable - - the account receivable to calculate the usage allowance

Returns:

the account receivable with the calculated consumed usage allowance

Throws:

java.lang.Exception

calculateConsumedUsageAllowance

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateConsumedUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                          java.util.Date validityDate,
                                                                                          com.crm.dataobject.billing.CRMDOUsageAuthorisation excludeUsageAuthorisation)
                                                                                   throws java.lang.Exception

Calculates the consumed usage allowance of an account receivable.

Parameters:

accountReceivable - - the account receivable to calculate the usage allowance

excludeUsageAuthorisation - - the usage authorisation to exclude

Returns:

the account receivable with the calculated consumed usage allowance

Throws:

java.lang.Exception

isProductRestricted

public boolean isProductRestricted(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit,
                                   com.crm.dataobject.products.CRMDOProduct product)
                            throws java.lang.Exception

Throws:

java.lang.Exception

calculateConsumedUsageAllowancePerService

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateConsumedUsageAllowancePerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                    java.util.Date validityDate)
                                                                                             throws java.lang.Exception

Calculates the consumed usage allowance per service of an account receivable.

Parameters:

accountReceivable - - the account receivable to calculate the consumed usage allowance per service

validityDate - - the date to calculate the amounts

Returns:

the account receivable with the calculated consumed usage allowance per service

Throws:

java.lang.Exception

calculateConsumedUsageAllowancePerService

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateConsumedUsageAllowancePerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                    java.util.Date validityDate,
                                                                                                    com.crm.dataobject.billing.CRMDOUsageAuthorisation excludeUsageAuthorisation)
                                                                                             throws java.lang.Exception

Calculates the consumed usage allowance per service of an account receivable.

Parameters:

accountReceivable - - the account receivable to calculate the consumed usage allowance per service

validityDate - - the date to calculate the amounts

excludeUsageAuthorisation - - the usage authorisation to exclude

Returns:

the account receivable with the calculated consumed usage allowance per service

Throws:

java.lang.Exception

calculateRemainingUsageAllowance

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

Calculates the remaining usage allowance of an account receivable.

Parameters:

accountReceivable - - the account receivable to calculate the remaining usage allowance

Returns:

the account receivable with the calculated remaining usage allowance

Throws:

java.lang.Exception

calculateRemainingUsageAllowancePerService

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

Calculates the remaining usage allowance per service of an account receivable.

Parameters:

accountReceivable - - the account receivable to calculate the remaining usage allowance per service

Returns:

the account receivable with the calculated remaining usage allowance

Throws:

java.lang.Exception

resetRemainingUsageAllowanceLimitsBasedOnCurrency

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

Reset the remaining usage allowance limits for an account receivable based on the currency.

Parameters:

accountReceivable - - the account receivable to copy the values to

Returns:

the account receivable

Throws:

java.lang.Exception

calculateUsageAllowanceLimitWithExceededAmount

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

Calculates the usage allowance limit with exceeded amount

Parameters:

accountReceivable - - the account receivable to calculate the usage allowance limit with exceeded amount

Returns:

the account receivable with the calculate with usage allowance limit with exceeded amount

Throws:

java.lang.Exception

setRemainingUsageAllowanceForAllowanceWithoutLimit

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

Sets the remaining usage allowance for the usage allowance values without limit, by setting the remaining allowance per month on the remaining allowance per day and the remaining allowance per day on the remaining allowance per transaction, if any of these values are empty.

Parameters:

accountReceivable - - the account receivable to set the remaining usage allowance for

Returns:

the account receivable with the updated remaining usage allowance

Throws:

java.lang.Exception

isExistsForAccount

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

Checks if a usage allowance limit exists for an account

Parameters:

accountReceivable - - the account to check

Returns:

true if a usage allowan limit exists, false if not

Throws:

java.lang.Exception

setAllowedExceededUsageAllowanceAmount

public com.crm.dataobject.accounts.CRMDOAccountReceivable setAllowedExceededUsageAllowanceAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                 java.util.Date validityDate)
                                                                                          throws java.lang.Exception

Calculates the allowed exceeded usage allowance for an account

Parameters:

accountReceivable - - the account to calculate the allowed exceeded usage allowance

Returns:

the updated account receivable

Throws:

java.lang.Exception

resetUsageAllowanceLimitBasedOnCurrency

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

Reset the usage allowance limit for an account receivable based on the currency.

Parameters:

accountReceivable - - the account receivable to copy the values to

Returns:

the account receivable

Throws:

java.lang.Exception

setAllowedRatedAmounts

public com.crm.dataobject.accounts.CRMDOAccountReceivable setAllowedRatedAmounts(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                 java.lang.Boolean addAllowedExceededAmount)
                                                                          throws java.lang.Exception

Reset the usage allowance limit for an account receivable based on the currency.

Parameters:

accountReceivable - - the account receivable to copy the values to

Returns:

the account receivable

Throws:

java.lang.Exception

isAllowedOrginisationalUnitValid

public boolean isAllowedOrginisationalUnitValid(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit,
                                                com.crm.dataobject.networkmanagement.CRMDOUnit unit)
                                         throws java.lang.Exception

Checks if the the logged in user is allowed against organisational unit conditions If the usage allowance limit is configured on the account definition, then is valid, else the conditions are evaluated

Parameters:

usageAllowanceLimit - - the usage allowance limit to validate

unit - - the unit to validate

Returns:

true if the logged in user is allowed against the organisational unit conditions, false if not

Throws:

java.lang.Exception

calculateMaximumAllowedUsageConsumptionAgainstCreditLimit

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

Calculates the maximum allowed usage consumption for an acounts receivable

Parameters:

accountReceivable - - the account receivable to set the information on the related usage allowance limit

Returns:

the updated account receivable

Throws:

java.lang.Exception

calculateMaximumAllowedUsageConsumptionAgainstCreditLimit

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateMaximumAllowedUsageConsumptionAgainstCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                    java.util.Date validityDate)
                                                                                                             throws java.lang.Exception

Calculates the maximum allowed usage consumption for an acounts receivable

Parameters:

accountReceivable - - the account receivable to set the information on the related usage allowance limit

Returns:

the updated account receivable

Throws:

java.lang.Exception