com.crm.businessobject.billing

Class CRMBOUdrBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.billing.CRMBOUdrBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOUdrBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOUdrBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.billing.CRMDOUdr	construct(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService, com.crm.dataobject.products.CRMDOProduct product) Constructs a udr.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a udr.
com.crm.dataobject.billing.UdrStatus	getStatus(com.crm.dataobject.billing.CRMDOUdr udr) Returns the status of a udr.
com.crm.dataobject.billing.UdrStatus	getStatus(java.lang.String udrID) Returns the status of a udr by an id.
java.lang.Integer	getTotalQuantity(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs)
java.lang.Integer	getTotalQuantity(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs, com.crm.framework.util.UnitOfTime unitOfTime, java.util.Date asOfDate)
java.math.BigDecimal	getTotalUsage(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs)
java.math.BigDecimal	getTotalUsage(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs, com.crm.framework.util.UnitOfTime unitOfTime, java.util.Date asOfDate)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOUdrSourceSystem udrSourceSystem, com.crm.dataobject.billing.CRMDOUdrType udrType, com.crm.dataobject.billing.CRMDOUsageServiceCatalog usageServiceCatalog, com.crm.dataobject.billing.CRMDOUdrDevice udrDevice, com.crm.dataobject.billing.CRMDOUdrUsageMethod udrUsageMethod, com.crm.dataobject.billing.CRMDOUdrSourceCategory udrSourceCategory, com.crm.dataobject.billing.CRMDOUdrDestinationCategory udrDestinationCategory, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.billing.UDRLifeCycleState excludeLifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of udrs based an Accounts Receivable or a subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.billing.CRMDOBill bill) Loads a list of udrs of a bill.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.billing.CRMDOBillItem billItem) Loads a list of udrs based on a bill item.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Loads a list of udrs of a subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.ArrayList<java.lang.String> associations) Loads a list of udrs of a subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.products.CRMDOProduct product) Loads a list of udrs based on subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.products.CRMDOProduct product, java.util.ArrayList<java.lang.String> associations) Loads a list of udrs based on subscription.
com.crm.dataobject.billing.CRMDOUdr	loadAdditionalInformation(com.crm.dataobject.billing.CRMDOUdr udr) Loads the additional information of a udr.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date billAsOfDate) Loads a list of billable udrs based on a subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date billAsOfDate, java.util.ArrayList<java.lang.String> associations) Loads a list of billable udrs based on a subscription.
com.crm.dataobject.billing.CRMDOUdr	loadByNumber(java.lang.String number) Loads a Udr of a subscription based on a number.
com.crm.dataobject.billing.CRMDOUdr	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a Udr of a subscription based on a number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNonCancelled(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.ArrayList<java.lang.String> associations) Loads a list of udrs of a subscription.
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	rate(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition, com.crm.dataobject.billing.CRMDOUsageServiceCatalogDefinition serviceCatalogDefinition, java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageServiceCatalog> usageServiceCatalogs, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment) Rates a udr with usage Service catalog.
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	rate(com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm) Rates a udr with usage Service catalog.

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

CRMBOUdrBean

public CRMBOUdrBean()

Default constructor.

Method Detail

construct

public com.crm.dataobject.billing.CRMDOUdr construct(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                            com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService,
                                            com.crm.dataobject.products.CRMDOProduct product)
                                              throws java.lang.Exception

Constructs a udr.

Parameters:

subscription - - the subscription to construct the udr for

subscriptionService - - the subscription service to construct the udr for

product - - the product that will be added on the udr

Returns:

the created udr

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a udr.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the udr

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.billing.CRMDOBill bill)
                                                   throws java.lang.Exception

Loads a list of udrs of a bill.

Parameters:

bill - - the bill to load the udrs of

Returns:

a list of udrs of the given bill

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.billing.CRMDOBillItem billItem)
                                                   throws java.lang.Exception

Loads a list of udrs based on a bill item.

Parameters:

billItem - - the bill item to load the udrs

Returns:

a list of udrs based on the given criteria

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.billing.CRMDOUdr loadByNumber(java.lang.String number)
                                                 throws java.lang.Exception

Loads a Udr of a subscription based on a number.

Parameters:

number - - the number of udr to load

associations - - a list of associated data objects

Returns:

Throws:

java.lang.Exception

loadByNumber

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

Loads a Udr of a subscription based on a number.

Parameters:

number - - the number of udr to load

associations - - a list of associated data objects

Returns:

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                   throws java.lang.Exception

Loads a list of udrs of a subscription.

Parameters:

subscription - - the subscription to load the udrs of

Returns:

a list of udrs of the given subscription

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of udrs of a subscription.

Parameters:

subscription - - the subscription to load the udrs of

associations - - a list of associated data objects

Returns:

a list of udrs of the given subscription

Throws:

java.lang.Exception

loadNonCancelled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNonCancelled(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                             java.util.ArrayList<java.lang.String> associations)
                                                               throws java.lang.Exception

Loads a list of udrs of a subscription.

Parameters:

subscription - - the subscription to load the udrs of

associations - - a list of associated data objects

Returns:

a list of udrs of the given subscription

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.products.CRMDOProduct product)
                                                   throws java.lang.Exception

Loads a list of udrs based on subscription.

Parameters:

account - - the account to load the udrs for

subscription - - the subscription to load the udrs for

product - - the product to load the udrs for

Returns:

a list of udrs of the given account receivable or subscription

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.products.CRMDOProduct product,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of udrs based on subscription.

Parameters:

account - - the account to load the udrs for

subscription - - the subscription to load the udrs for

product - - the product to load the udrs for

associations - - a list of associated data objects

Returns:

a list of udrs of the given account receivable or subscription

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                 com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.billing.CRMDOUdrSourceSystem udrSourceSystem,
                                                 com.crm.dataobject.billing.CRMDOUdrType udrType,
                                                 com.crm.dataobject.billing.CRMDOUsageServiceCatalog usageServiceCatalog,
                                                 com.crm.dataobject.billing.CRMDOUdrDevice udrDevice,
                                                 com.crm.dataobject.billing.CRMDOUdrUsageMethod udrUsageMethod,
                                                 com.crm.dataobject.billing.CRMDOUdrSourceCategory udrSourceCategory,
                                                 com.crm.dataobject.billing.CRMDOUdrDestinationCategory udrDestinationCategory,
                                                 com.crm.dataobject.products.CRMDOProduct product,
                                                 com.crm.dataobject.billing.UDRLifeCycleState excludeLifeCycleState,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of udrs based an Accounts Receivable or a subscription.

Parameters:

account - - the account to load the udrs for

subscription - - the subscription to load the udrs for

udrSourceSystem - - the source system to load the udrs for

udrType - - the type to load the udrs for

usageServiceCatalog - - the usage service catalog to load the udrs for

udrDevice - - the device to load the udrs for

udrUsageMethod - - the usage method to load the udrs for

udrSourceCategory - - the source category to load the udrs for

udrDestinationCategory - - the destination category to load the udrs for

product - - the product to load the udrs for

associations - - a list of associated data objects

Returns:

a list of udrs of the given account receivable or subscription

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                         java.util.Date billAsOfDate)
                                                           throws java.lang.Exception

Loads a list of billable udrs based on a subscription.

Parameters:

subscription - - the subscription to load the udrs for

billAsOfDate - - the as of date to consider udrs based on the billing effective date

Returns:

a list of udrs of the given subscription

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                         java.util.Date billAsOfDate,
                                                         java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads a list of billable udrs based on a subscription.

Parameters:

subscription - - the subscription to load the udrs for

billAsOfDate - - the as of date to consider udrs based on the billing effective date

associations - - a list of associated data objects

Returns:

a list of udrs of the given subscription

Throws:

java.lang.Exception

rate

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> rate(com.crm.dataobject.billing.CRMDOUdr udr,
                                                                         com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                                                           throws java.lang.Exception

Rates a udr with usage Service catalog.

Parameters:

udr -

billingTerm -

Returns:

Throws:

java.lang.Exception

rate

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> rate(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                         com.crm.dataobject.billing.CRMDOUdr udr,
                                                                         com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                         com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition,
                                                                         com.crm.dataobject.billing.CRMDOUsageServiceCatalogDefinition serviceCatalogDefinition,
                                                                         java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageServiceCatalog> usageServiceCatalogs,
                                                                         java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions,
                                                                         java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment)
                                                                           throws java.lang.Exception

Rates a udr with usage Service catalog.

Parameters:

billingRun -

udr -

billingTerm -

serviceCatalogDefinition -

usageServiceCatalogs -

Returns:

Throws:

java.lang.Exception

getStatus

public com.crm.dataobject.billing.UdrStatus getStatus(com.crm.dataobject.billing.CRMDOUdr udr)
                                               throws java.lang.Exception

Returns the status of a udr.

Parameters:

udr - - the bill to return the udr status of

Returns:

the udr status of the given bill

Throws:

java.lang.Exception

getStatus

public com.crm.dataobject.billing.UdrStatus getStatus(java.lang.String udrID)
                                               throws java.lang.Exception

Returns the status of a udr by an id.

Parameters:

bill - - the id of the udr to return the status of

Returns:

the status of the given udr

Throws:

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.billing.CRMDOUdr loadAdditionalInformation(com.crm.dataobject.billing.CRMDOUdr udr)
                                                              throws java.lang.Exception

Loads the additional information of a udr. - the status of udr

Parameters:

bill - - the bill to load the additional information of

Returns:

the additional information of the given bill

Throws:

java.lang.Exception

getTotalUsage

public java.math.BigDecimal getTotalUsage(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs)

getTotalUsage

public java.math.BigDecimal getTotalUsage(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs,
                                 com.crm.framework.util.UnitOfTime unitOfTime,
                                 java.util.Date asOfDate)

getTotalQuantity

public java.lang.Integer getTotalQuantity(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs)

getTotalQuantity

public java.lang.Integer getTotalQuantity(java.util.ArrayList<com.crm.dataobject.CRMDO> udrs,
                                 com.crm.framework.util.UnitOfTime unitOfTime,
                                 java.util.Date asOfDate)