com.crm.process.billing

Class CRMProcessBillingRunBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMProcess

com.crm.process.billing.CRMProcessBillingRunBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CRMProcessNormalBillingRunBean, CRMProcessPrepaidBillingRunBean

public class CRMProcessBillingRunBean
extends CRMProcess

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMProcessBillingRunBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.accounts.CRMDOAccountReceivable	billAccountReceivable(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.lang.Boolean billPreview) Bills an account.
com.crm.dataobject.accounts.CRMDOAccountReceivable	billJob(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.jobs.CRMDOJob job, java.lang.Boolean billPreview) Bills a job of an account by a billing run.
com.crm.dataobject.accounts.CRMDOAccountReceivable	billSubscription(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.lang.Boolean billPreview) Bills a subscription of an account by a billing run.
com.crm.dataobject.billing.CRMDOBillingRunTransaction	constructCreditTransaction(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> ratedBillingItems, com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition) Creates a credit note transaction by an account, a list of rated billing items, a billing run and a billing run definition.
com.crm.dataobject.billing.CRMDOBillingRunTransaction	constructDebitTransaction(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> ratedBillingItems, com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition) Creates an invoice transaction by an account, a list of rated billing items, a billing run and a billing run definition.
com.crm.dataobject.billing.CRMDOBillingRun	createBillingRunResults(com.crm.dataobject.billing.CRMDOBillingRun billingRun, java.util.Date startDate) Creates the billing run results.
void	execute(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Executes a billing run.
void	saveRatedBillingItems(com.crm.dataobject.billing.CRMDOBillingRun billingRun, java.util.ArrayList<com.crm.dataobject.CRMDO> ratedBillingItems) Saves the rated billing items.
void	saveResults(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable account) Saves the results of a billing run of an account.
java.util.Date	sendToScheduler(com.crm.dataobject.billing.CRMDOBillingRun billingRun) Sends a billing run to the scheduler.
com.crm.dataobject.billing.CRMDOBillingRun	setAdditionalInformation(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.BillingTermDefinitionClassification definitionClassification, java.lang.Boolean quickLoad) Sets additional information for a billing run.
void	updateSubscriptionInformation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Updates subscription rating information.

Methods inherited from class com.crm.process.CRMProcess

createCronExpressionFromDate, createCronExpressionFromDate, setMandatoryField

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

CRMProcessBillingRunBean

public CRMProcessBillingRunBean()

Default constructor.

Method Detail

execute

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

Executes a billing run.

Parameters:

billingRun - - the billing run to execute

Throws:

java.lang.Exception

billSubscription

public com.crm.dataobject.accounts.CRMDOAccountReceivable billSubscription(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                           com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                           java.lang.Boolean billPreview)
                                                                    throws java.lang.Exception,
                                                                           com.crm.exception.MandatoryFieldException

Bills a subscription of an account by a billing run.

Parameters:

billingRun - - the billing run to use

subscription - - the subscription to bill

billPreview - - a boolean indicating if the account should be billed, or if it should execute in preview mode

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

billAccountReceivable

public com.crm.dataobject.accounts.CRMDOAccountReceivable billAccountReceivable(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                                com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                                java.lang.Boolean billPreview)
                                                                         throws java.lang.Exception,
                                                                                com.crm.exception.MandatoryFieldException

Bills an account.

Parameters:

billingRun - - the billing run to use

account - - the account to bill

billPreview - - a boolean indicating if the account should be billed, or if it should execute in preview mode

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

billJob

public com.crm.dataobject.accounts.CRMDOAccountReceivable billJob(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                  com.crm.dataobject.jobs.CRMDOJob job,
                                                                  java.lang.Boolean billPreview)
                                                           throws java.lang.Exception,
                                                                  com.crm.exception.MandatoryFieldException

Bills a job of an account by a billing run.

Parameters:

billingRun - - the billing run to use

job - - the job to bill

billPreview - - a boolean indicating if the account should be billed, or if it should execute in preview mode

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

saveResults

public void saveResults(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                        com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                 throws java.lang.Exception

Saves the results of a billing run of an account.

Parameters:

billingRun - - the billing run to use

account - - the account to use

Throws:

java.lang.Exception

saveRatedBillingItems

public void saveRatedBillingItems(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                  java.util.ArrayList<com.crm.dataobject.CRMDO> ratedBillingItems)
                           throws java.lang.Exception

Saves the rated billing items.

Parameters:

billingRun - - the billing run to use

ratedBillingItems - - the rated billing items to save

Throws:

java.lang.Exception

updateSubscriptionInformation

public void updateSubscriptionInformation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                   throws java.lang.Exception

Updates subscription rating information.

Parameters:

subscription - - the subscription to update

Throws:

java.lang.Exception

setAdditionalInformation

public com.crm.dataobject.billing.CRMDOBillingRun setAdditionalInformation(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                           com.crm.dataobject.billing.BillingTermDefinitionClassification definitionClassification,
                                                                           java.lang.Boolean quickLoad)
                                                                    throws java.lang.Exception

Sets additional information for a billing run.

Parameters:

billingRun - - the billing run to use

quickLoad - - a boolean indicating if the additional information should be quick loaded

Returns:

the updated billing run

Throws:

java.lang.Exception

constructDebitTransaction

public com.crm.dataobject.billing.CRMDOBillingRunTransaction constructDebitTransaction(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                                       java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> ratedBillingItems,
                                                                                       com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                                       com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition)
                                                                                throws java.lang.Exception

Creates an invoice transaction by an account, a list of rated billing items, a billing run and a billing run definition.

Parameters:

account - - the account to use

ratedBillingItems - - the rated billing items to use

billingRun - - the billing run to use

billingRunDefinition - - the billing run definition to use

Returns:

the updated billing run transaction

Throws:

java.lang.Exception

constructCreditTransaction

public com.crm.dataobject.billing.CRMDOBillingRunTransaction constructCreditTransaction(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                                        java.util.ArrayList<com.crm.dataobject.billing.CRMDORatedBillingItem> ratedBillingItems,
                                                                                        com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                                        com.crm.dataobject.billing.CRMDOBillingRunDefinition billingRunDefinition)
                                                                                 throws java.lang.Exception

Creates a credit note transaction by an account, a list of rated billing items, a billing run and a billing run definition.

Parameters:

account - - the account to use

ratedBillingItems - - the rated billing items to use

billingRun - - the billing run to use

billingRunDefinition - - the billing run definition to use

Returns:

the updated billing run transaction

Throws:

java.lang.Exception

sendToScheduler

public java.util.Date sendToScheduler(com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                               throws java.lang.Exception,
                                      com.crm.exception.MandatoryFieldException

Sends a billing run to the scheduler.

Parameters:

billingRun - - the billing run to send to the scheduler

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

createBillingRunResults

public com.crm.dataobject.billing.CRMDOBillingRun createBillingRunResults(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                          java.util.Date startDate)
                                                                   throws java.lang.Exception

Creates the billing run results.

Parameters:

billingRun - - the billing run to create the results for

startDate - - the start date to create the results from

Returns:

the updated billing run

Throws:

java.lang.Exception