com.crm.businessobject.billing

Class CRMBOBillingRunBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.billing.CRMBOBillingRunBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CRMBONormalBillingRunBean, CRMBOPrepaidBillingRunBean

public class CRMBOBillingRunBean
extends CRMBO

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Integer	BILLING_RUN_DUE_DATE_SIGN_PLUS
java.lang.Integer	BILLING_RUN_DUE_DATE_SIGN_SUBTRACT

Constructor Summary

Constructors

Constructor and Description
CRMBOBillingRunBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.math.BigDecimal	calculateTotalAmount(java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> serviceRatedBillingItems) Calculates the total amount of service rated billing items.
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructCreditRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructInvoiceRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods, com.crm.dataobject.activities.CRMDOActivityService activityService, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructInvoiceRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods, com.crm.dataobject.jobs.CRMDOJobProduct jobProduct, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructInvoiceRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods, com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory serviceLifeCycleStateHistory, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructInvoiceRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
com.crm.dataobject.billing.CRMDOBillingRun	constructNextBillingRun(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition) Constructs the next billing run.
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory serviceLifeCycleStateHistory, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.jobs.CRMDOJobProduct jobProduct, com.crm.dataobject.activities.CRMDOActivityService activityService, com.crm.dataobject.billing.RatedBillingItemType billingItemType, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods, com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory serviceLifeCycleStateHistory, com.crm.dataobject.billing.RatedBillingItemType billingItemType, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.RatedBillingItemType billingItemType, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem>	constructRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.RatedBillingItemType billingItemType, com.crm.dataobject.billing.CRMDOBillingRun billingRun)
com.crm.framework.util.ResultSetUtil	getBills(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the bills of a billing run.
com.crm.framework.util.ResultSetUtil	getCreditNotes(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the credit notes of a billing run.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a billing run.
com.crm.framework.util.ResultSetUtil	getInvoices(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the invoices of a billing run.
java.math.BigDecimal	getTotalAmountCredited(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the total amount credited of a billing run.
java.math.BigDecimal	getTotalAmountDebited(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the total amount debited of a billing run.
java.lang.Integer	getTotalNumberOfBills(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the total number of bills of a billing run.
java.lang.Integer	getTotalNumberOfCreditNotes(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the total number of credit notes of a billing run.
java.lang.Integer	getTotalNumberOfInvoices(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the total number of invoices of a billing run.
java.lang.Integer	getTotalNumberOfServices(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Returns the total number of services of a billing run.
com.crm.dataobject.billing.CRMDOBillingRun	initializeConditions(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Initialises the conditions of a billing run.
com.crm.framework.util.ResultSetUtil	loadRatedAccountsReceivable(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Loads the rated subscriptions using a billing run.
java.util.Date	setDefaultAsOfDate(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition, com.crm.dataobject.billing.CRMDOBillingRun previousBillingRun) Sets a default as of date from a billing run definition.
com.crm.dataobject.billing.CRMDOBillingRun	setObjectsFromXML(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Sets the objects of a billing run read from an xml file.
com.crm.dataobject.billing.CRMDOBillingRun	setXMLFromObjects(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Creates xml file from the objects of a billing run.

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

Field Detail

BILLING_RUN_DUE_DATE_SIGN_PLUS

public final java.lang.Integer BILLING_RUN_DUE_DATE_SIGN_PLUS

BILLING_RUN_DUE_DATE_SIGN_SUBTRACT

public final java.lang.Integer BILLING_RUN_DUE_DATE_SIGN_SUBTRACT

Constructor Detail

CRMBOBillingRunBean

public CRMBOBillingRunBean()

Default constructor.

Method Detail

initializeConditions

public com.crm.dataobject.billing.CRMDOBillingRun initializeConditions(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                throws java.lang.Exception

Initialises the conditions of a billing run.

Parameters:

billingRun - - the billing run to initialise the conditions for

Returns:

the updated billing run

Throws:

java.lang.Exception

setObjectsFromXML

public com.crm.dataobject.billing.CRMDOBillingRun setObjectsFromXML(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                             throws java.lang.Exception

Sets the objects of a billing run read from an xml file.

Parameters:

billingRun - - the billing run to set the objects for

Returns:

the updated billing run

Throws:

java.lang.Exception

setXMLFromObjects

public com.crm.dataobject.billing.CRMDOBillingRun setXMLFromObjects(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                             throws java.lang.Exception

Creates xml file from the objects of a billing run.

Parameters:

billingRun - - the billing run to get the objects to create the xml file

Returns:

the updated billing run

Throws:

java.lang.Exception

setDefaultAsOfDate

public java.util.Date setDefaultAsOfDate(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition,
                                com.crm.dataobject.billing.CRMDOBillingRun previousBillingRun)

Sets a default as of date from a billing run definition.

Parameters:

billingRun - - the billing run to use

billingRunDefinition - - the billing run definition to use

previousBillingRun - - the previous billing run

Returns:

the default as of date

getDefaultAssociations

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

Returns the default associated data objects of a billing run.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the billing run

calculateTotalAmount

public java.math.BigDecimal calculateTotalAmount(java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> serviceRatedBillingItems)

Calculates the total amount of service rated billing items. Invoice + CREDIT_NOTE -

Parameters:

serviceRatedBillingItems - - the service rated billing items to calculate the total for

Returns:

the calculated total amount of service rated billing items

constructNextBillingRun

public com.crm.dataobject.billing.CRMDOBillingRun constructNextBillingRun(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                 com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition)
                                                                   throws java.lang.Exception

Constructs the next billing run.

Parameters:

billingRun - - the billing run to construct the next billing run for

billingRunDefinition - - the billing run definition to use

Returns:

the updated billing run

Throws:

java.lang.Exception

getInvoices

public com.crm.framework.util.ResultSetUtil getInvoices(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                 throws java.lang.Exception

Returns the invoices of a billing run.

Parameters:

billingRun - - the billing run to get the invoices from

Returns:

the invoices of the given billing run

Throws:

java.lang.Exception

getTotalNumberOfInvoices

public java.lang.Integer getTotalNumberOfInvoices(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                           throws java.lang.Exception

Returns the total number of invoices of a billing run.

Parameters:

billingRun - - the billing run to return the total number of invoices from

Returns:

the total number of invoices of the given billing run

Throws:

java.lang.Exception

getCreditNotes

public com.crm.framework.util.ResultSetUtil getCreditNotes(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                    throws java.lang.Exception

Returns the credit notes of a billing run.

Parameters:

billingRun - - the billing run to get the credit notes from

Returns:

the credit notes of the given billing run

Throws:

java.lang.Exception

getTotalNumberOfCreditNotes

public java.lang.Integer getTotalNumberOfCreditNotes(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                              throws java.lang.Exception

Returns the total number of credit notes of a billing run.

Parameters:

billingRun - - the billing run to return the total number of credit notes from

Returns:

the total number of credit notes of a billing run

Throws:

java.lang.Exception

getBills

public com.crm.framework.util.ResultSetUtil getBills(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                              throws java.lang.Exception

Returns the bills of a billing run.

Parameters:

billingRun - - the billing run to get the bills from

Returns:

the bills of the given billing run

Throws:

java.lang.Exception

getTotalNumberOfBills

public java.lang.Integer getTotalNumberOfBills(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                        throws java.lang.Exception

Returns the total number of bills of a billing run.

Parameters:

billingRun - - the billing run to return the total number of bills from

Returns:

the total number of bills of a billing run

Throws:

java.lang.Exception

getTotalNumberOfServices

public java.lang.Integer getTotalNumberOfServices(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                           throws java.lang.Exception

Returns the total number of services of a billing run.

Parameters:

billingRun - - the billing run to return the total number of services from

Returns:

the total number of services of the given billing run

Throws:

java.lang.Exception

getTotalAmountDebited

public java.math.BigDecimal getTotalAmountDebited(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                           throws java.lang.Exception

Returns the total amount debited of a billing run.

Parameters:

billingRun - - the billing run the return the total amount debited from

Returns:

the total amount debited of a billing run

Throws:

java.lang.Exception

getTotalAmountCredited

public java.math.BigDecimal getTotalAmountCredited(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                            throws java.lang.Exception

Returns the total amount credited of a billing run.

Parameters:

billingRun - - the billing run the return the total amount credited from

Returns:

the total amount credited of a billing run

Throws:

java.lang.Exception

loadRatedAccountsReceivable

public com.crm.framework.util.ResultSetUtil loadRatedAccountsReceivable(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                 throws java.lang.Exception

Loads the rated subscriptions using a billing run.

Parameters:

billingRun - - the billing run to use

Returns:

the rated subscriptions using the given billing run

Throws:

java.lang.Exception

constructInvoiceRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructInvoiceRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods,
                                                                                                      com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory serviceLifeCycleStateHistory,
                                                                                                      com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

constructRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory serviceLifeCycleStateHistory,
                                                                                               com.crm.dataobject.billing.RatedBillingItemType billingItemType,
                                                                                               com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

constructInvoiceRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructInvoiceRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods,
                                                                                                      com.crm.dataobject.jobs.CRMDOJobProduct jobProduct,
                                                                                                      com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

constructInvoiceRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructInvoiceRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods,
                                                                                                      com.crm.dataobject.activities.CRMDOActivityService activityService,
                                                                                                      com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

constructRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructRatedBillingItems(java.util.ArrayList<ProductTieredPeriod> productTieredPeriods,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                               com.crm.dataobject.jobs.CRMDOJob job,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory serviceLifeCycleStateHistory,
                                                                                               com.crm.dataobject.billing.CRMDOUdr udr,
                                                                                               com.crm.dataobject.jobs.CRMDOJobProduct jobProduct,
                                                                                               com.crm.dataobject.activities.CRMDOActivityService activityService,
                                                                                               com.crm.dataobject.billing.RatedBillingItemType billingItemType,
                                                                                               com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

constructInvoiceRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructInvoiceRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods,
                                                                                                      com.crm.dataobject.billing.CRMDOUdr udr,
                                                                                                      com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                                      com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

constructCreditRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructCreditRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods,
                                                                                                     com.crm.dataobject.billing.CRMDOUdr udr,
                                                                                                     com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                                     com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                       throws java.lang.Exception

Throws:

java.lang.Exception

constructRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods,
                                                                                               com.crm.dataobject.billing.CRMDOUdr udr,
                                                                                               com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                               com.crm.dataobject.billing.RatedBillingItemType billingItemType,
                                                                                               com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

constructRatedBillingItems

public java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> constructRatedBillingItems(java.util.ArrayList<UsageServiceTieredPeriod> usageServiceTieredPeriods,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                               com.crm.dataobject.billing.CRMDOUdr udr,
                                                                                               com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                               com.crm.dataobject.billing.RatedBillingItemType billingItemType,
                                                                                               com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                                                                 throws java.lang.Exception

Throws:

java.lang.Exception