com.crm.businessobject.accounts

Class CRMBOAccountReceivableBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOMasterEntity

com.crm.businessobject.accounts.CRMBOAccountReceivableBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOAccountReceivableBean
extends CRMBOMasterEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOAccountReceivableBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.accounts.CRMDOAccountReceivable	bill(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable account) Bills an account by a billing run.
com.crm.dataobject.accounts.CRMDOAccountReceivable	bill(com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable account) Bills an account by a prepaid billing run.
com.crm.dataobject.accounts.CRMDOAccountReceivable	bill(com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.wallets.CRMDOWallet wallet) Bills an account by a prepaid billing run.
java.math.BigDecimal	calculateUnsettledAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
com.crm.dataobject.CRMDO	constructCustomerAccount() Constructs a customer account.
com.crm.dataobject.CRMDO	constructCustomerAccount(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Constructs a customer account.
com.crm.dataobject.CRMDO	constructSystemAccount() Constructs a system account.
com.crm.dataobject.CRMDO	constructSystemAccount(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Constructs a system account.
com.crm.dataobject.accounts.CRMDOAccountReceivable	generateName(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
java.math.BigDecimal	getAdjustedOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date asOfDate) Returns the adjusted outstanding amount for an account.
java.math.BigDecimal	getAdjustedOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date asOfDate, com.crm.dataobject.billing.CRMDONormalBillingRunDefinition normalBillingRunDefinition, com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition, java.util.ArrayList<com.crm.dataobject.CRMDO> pricePlans) Returns the adjusted outstanding amount for an account.
java.math.BigDecimal	getBalance(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date asOfDate) Returns the balance of an account as of a date.
java.util.ArrayList<com.crm.dataobject.CRMDO>	getBillingRunTransactions(com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.accounts.CRMDOAccountReceivable account) Returns a list of billing run transactions of an account.
com.crm.dataobject.accounts.CreditLimitStatus	getCreditLimitStatus(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Returns the credit limit status of an account.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of an account.
java.util.ArrayList<org.apache.axis.types.Entities>	getEntitiesForWhichAddressIsMandatory(com.crm.dataobject.accounts.BillingAddressRules billingAddressRules)
java.util.Date	getLastBillToDate(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Returns the Last Bill To Date
java.math.BigDecimal	getOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Returns the outstanding amount for an account.
java.math.BigDecimal	getOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date asOfDate) Returns the outstanding amount for an account as of a date.
java.math.BigDecimal	getOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date asOfDate, java.lang.Integer dueInXDays, java.lang.Integer dueXDaysAgo) Returns the outstanding amount for an account as of a date.
java.math.BigDecimal	getOverdueAmountOfPreviousBills(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Returns the total due amount of previous bills.
java.lang.Integer	getTotalDraftTransactions(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Returns the number of total draft transactions.
java.lang.Boolean	isUsedByDraftCommunication(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if the Accounts Receivable is used by a draft communication.
java.lang.Boolean	isUsedByJob(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if the Accounts Receivable is used by job
java.lang.Boolean	isUsedByRelatedEntities(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if the Accounts Receivable is used by subscription job or reward participant
java.lang.Boolean	isUsedByRewardParticipant(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if the Accounts Receivable is used by a reward participant
java.lang.Boolean	isUsedByServiceRequest(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if the Accounts Receivable is used by a service request.
java.lang.Boolean	isUsedBySubscription(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Checks if the Accounts Receivable is used by subscription
com.crm.dataobject.CRMDO	load(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Loads an Accounts Receivable based on an access token.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOBank bank, com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference, java.lang.String bankAccountNumber, java.util.ArrayList<java.lang.String> associations) Loads a list of accounts by a bank, payment preference and bank account number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress contactInfoAddress) Loads a list of accounts by an address.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail) Loads a list of accounts by an email.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInfoPhone contactInfoPhone) Loads a list of accounts by a phone.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a list of accounts of a contact.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, java.util.ArrayList<java.lang.String> associations) Loads a list of accounts of a contact.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference, com.crm.dataobject.accounts.CRMDOPresentmentPreference presentmentPreference, com.crm.dataobject.accounts.AccountReceivableLifeCycleState lifeCycleState) Loads a list of accounts by a contact, subscription, payment preference, presentment preference ad lifecycle state.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference, com.crm.dataobject.accounts.CRMDOPresentmentPreference presentmentPreference, com.crm.dataobject.accounts.AccountReceivableLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of accounts by a contact, subscription, payment preference, presentment preference ad lifecycle state.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActive(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a list of active accounts of a contact.
com.crm.dataobject.accounts.CRMDOAccountReceivable	loadAdditionalInformation(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Loads additional information of an account.
com.crm.dataobject.accounts.CRMDOAccountReceivable	loadBillable(java.lang.String accRecID, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByClassification(com.crm.dataobject.accounts.CRMDOAccountClassification accountClassification) Loads a list of accounts by an account classification.
com.crm.dataobject.accounts.CRMDOAccountReceivable	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads an account by a name.
com.crm.dataobject.accounts.CRMDOAccountReceivable	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads an account by a number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNonTerminated(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference, com.crm.dataobject.accounts.CRMDOPresentmentPreference presentmentPreference, com.crm.dataobject.accounts.CRMDOBank bank, com.crm.dataobject.accounts.CRMDOBankBranch bankBranch, com.crm.dataobject.accounts.CRMDOBankAccountType bankAccountType, com.crm.dataobject.accounts.CRMDOAccountClassification accountClassification, java.util.ArrayList<java.lang.String> associations) Loads a list of non terminated accounts by payment preference, presentment preference, bank, bank branch, bank account type and account classification.
com.crm.framework.util.ResultSetUtil	loadOverdueInvoices(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date asOfDate) Returns the overdue invoices of an account as of a date.
com.crm.dataobject.accounts.CRMDOAccountReceivable	loadPrimary(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads the primary account of a contact.
com.crm.framework.util.ResultSetUtil	loadUnpaidInvoices(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Returns the unpaid invoices of an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	rateSubscriptions(java.util.ArrayList<com.crm.dataobject.CRMDO> subscriptions, com.crm.dataobject.billing.CRMDONormalBillingRun normalBillingRun) Rates a list of subscriptions by a billing run.
java.util.ArrayList<com.crm.dataobject.CRMDO>	rateSubscriptions(java.util.ArrayList<com.crm.dataobject.CRMDO> subscriptions, com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, com.crm.dataobject.wallets.CRMDOWallet wallet) Rates a list of subscriptions by a billing run.
com.crm.dataobject.CRMDO	reactivate(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Reactivates an account.
com.crm.dataobject.accounts.CRMDOAccountReceivable	setAccessTokenRestrictions(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
com.crm.dataobject.accounts.CRMDOAccountReceivable	setCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal creditLimit) Sets the credit limit for an account.
com.crm.dataobject.accounts.CRMDOAccountReceivable	setCreditPeriod(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.accounts.CreditPeriodOperator creditPeriodOperator, java.lang.Integer creditPeriodInDays) Sets the credit period information for an account.
com.crm.dataobject.CRMDOMasterEntity	setLifeCycleState(com.crm.dataobject.CRMDOMasterEntity dto, com.crm.dataobject.LifeCycleState lifeCycleState) Sets the life cycle state for an account.
com.crm.dataobject.CRMDO	suspend(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Suspends an account.
com.crm.dataobject.CRMDO	terminate(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Terminates an account.
com.crm.dataobject.CRMDO	validateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal transactionAmount) Validates the credit limit of an account by a transaction amount.
void	validateCreditLimitSettings(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition) Validates the credit limit settings for an account by a definition.
void	validateCreditPeriodSettings(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition) Validates the credit period settings for an account by a definition.
void	validateTermination(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Validate an account for termination.
void	validateUniqueness(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Validates the uniqueness of an account on save.

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

CRMBOAccountReceivableBean

public CRMBOAccountReceivableBean()

Default constructor.

Method Detail

constructCustomerAccount

public com.crm.dataobject.CRMDO constructCustomerAccount()
                                                  throws java.lang.Exception

Constructs a customer account.

Returns:

a customer account

Throws:

java.lang.Exception

constructCustomerAccount

public com.crm.dataobject.CRMDO constructCustomerAccount(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                  throws java.lang.Exception

Constructs a customer account.

Parameters:

contactInformation - - the contact to construct the account for

Returns:

a customer account for the given contact

Throws:

java.lang.Exception

loadAdditionalInformation

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

Loads additional information of an account.
- sets the contact information
- sets the balance
- sets the outstanding amount
- sets the credit limit status

Parameters:

accountReceivable - - the account to load the additional information for

Returns:

the updated account

Throws:

java.lang.Exception

constructSystemAccount

public com.crm.dataobject.CRMDO constructSystemAccount()
                                                throws java.lang.Exception

Constructs a system account.

Returns:

a system account

Throws:

java.lang.Exception

constructSystemAccount

public com.crm.dataobject.CRMDO constructSystemAccount(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                throws java.lang.Exception

Constructs a system account.

Parameters:

contactInformation - - the contact to construct the account for

Returns:

a system account for the given contact

Throws:

java.lang.Exception

setCreditPeriod

public com.crm.dataobject.accounts.CRMDOAccountReceivable setCreditPeriod(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                 com.crm.dataobject.accounts.CreditPeriodOperator creditPeriodOperator,
                                                                 java.lang.Integer creditPeriodInDays)
                                                                   throws java.lang.Exception

Sets the credit period information for an account.

Parameters:

account - - the account to set the credit period to

creditPeriodOperator - - the credit period operator

creditPeriodInDays - - the number of days to use in the credit period

Returns:

the updated account

Throws:

java.lang.Exception

setCreditLimit

public com.crm.dataobject.accounts.CRMDOAccountReceivable setCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                java.math.BigDecimal creditLimit)
                                                                  throws java.lang.Exception

Sets the credit limit for an account.

Parameters:

accountReceivable - - the account to set the credit limit to

creditLimit - - the credit limit amount

Returns:

the updated account

Throws:

java.lang.Exception

setLifeCycleState

public com.crm.dataobject.CRMDOMasterEntity setLifeCycleState(com.crm.dataobject.CRMDOMasterEntity dto,
                                                     com.crm.dataobject.LifeCycleState lifeCycleState)
                                                       throws java.lang.Exception

Sets the life cycle state for an account.

Overrides:

setLifeCycleState in class CRMBOMasterEntity

Parameters:

dto - - the account to set the life cycle state to

lifeCycleState - - the life cycle state

Returns:

the updated account

Throws:

java.lang.Exception

validateUniqueness

public void validateUniqueness(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                        throws java.lang.Exception

Validates the uniqueness of an account on save.

Parameters:

account - - the account to validate

Throws:

java.lang.Exception

getEntitiesForWhichAddressIsMandatory

public java.util.ArrayList<org.apache.axis.types.Entities> getEntitiesForWhichAddressIsMandatory(com.crm.dataobject.accounts.BillingAddressRules billingAddressRules)

validateCreditPeriodSettings

public void validateCreditPeriodSettings(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition)
                                  throws java.lang.Exception,
                                         com.crm.exception.MandatoryFieldException,
                                         com.crm.exception.InvalidValueException

Validates the credit period settings for an account by a definition.

Parameters:

account - - the account to validate

accountDefinition - - the account definition to use to validate

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

com.crm.exception.InvalidValueException

validateCreditLimitSettings

public void validateCreditLimitSettings(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                               com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition)
                                 throws java.lang.Exception,
                                        com.crm.exception.CannotSaveException

Validates the credit limit settings for an account by a definition.

Parameters:

account - - the account to validate

accountDefinition - - the account definition to use to validate

Throws:

java.lang.Exception

com.crm.exception.CannotSaveException

isUsedByDraftCommunication

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

Checks if the Accounts Receivable is used by a draft communication.

Parameters:

accountReceivable - - the Accounts Receivable to check

Returns:

true if the Accounts Receivable is used by a draft communication, false if not

Throws:

java.lang.Exception

isUsedByRelatedEntities

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

Checks if the Accounts Receivable is used by subscription job or reward participant

Parameters:

accountReceivable - - the Accounts Receivable to check

Returns:

true if the Accounts Receivable is used by a reward participant or subscription or job, false if not

Throws:

java.lang.Exception

isUsedByJob

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

Checks if the Accounts Receivable is used by job

Parameters:

accountReceivable - - the Accounts Receivable to check

Returns:

true if the Accounts Receivable is used by job, false if not

Throws:

java.lang.Exception

isUsedBySubscription

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

Checks if the Accounts Receivable is used by subscription

Parameters:

accountReceivable - - the Accounts Receivable to check

Returns:

true if the Accounts Receivable is used by a subscription false if not

Throws:

java.lang.Exception

isUsedByRewardParticipant

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

Checks if the Accounts Receivable is used by a reward participant

Parameters:

accountReceivable - - the Accounts Receivable to check

Returns:

true if the Accounts Receivable is used by a reward participant, false if not

Throws:

java.lang.Exception

isUsedByServiceRequest

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

Checks if the Accounts Receivable is used by a service request.

Parameters:

accountReceivable - - the Accounts Receivable to check

Returns:

true if the Accounts Receivable is used by a service request, false if not

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of an account.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the account

generateName

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

Throws:

java.lang.Exception

loadPrimary

public com.crm.dataobject.accounts.CRMDOAccountReceivable loadPrimary(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                               throws java.lang.Exception

Loads the primary account of a contact.

Parameters:

contactInformation - - the contact to load the primary account for

Returns:

the primary account of the given contact

Throws:

java.lang.Exception

loadByNumber

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

Loads an account by a number.

Parameters:

number - - the number to load the account for

associations - - a list of associated data objects

Returns:

an account with the given number

Throws:

java.lang.Exception

loadByName

public com.crm.dataobject.accounts.CRMDOAccountReceivable loadByName(java.lang.String name,
                                                            java.util.ArrayList<java.lang.String> associations)
                                                              throws java.lang.Exception

Loads an account by a name.

Parameters:

name - - the name to load the account for

associations - - a list of associated data objects

Returns:

an account with the given name

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                   throws java.lang.Exception

Loads a list of accounts of a contact.

Parameters:

contactInformation - - the contact to load the accounts for

Returns:

a list of accounts of the given contact

Throws:

java.lang.Exception

loadActive

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActive(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                         throws java.lang.Exception

Loads a list of active accounts of a contact.

Parameters:

contactInformation - - the contact to load the active accounts for

Returns:

a list of active accounts of the contact

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of accounts of a contact.

Parameters:

contactInformation - - the contact to load the accounts for

associations - - a list of associated data objects

Returns:

a list of accounts of the given contact

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                 com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference,
                                                 com.crm.dataobject.accounts.CRMDOPresentmentPreference presentmentPreference,
                                                 com.crm.dataobject.accounts.AccountReceivableLifeCycleState lifeCycleState)
                                                   throws java.lang.Exception

Loads a list of accounts by a contact, subscription, payment preference, presentment preference ad lifecycle state.

Parameters:

contactInformation - - the contact to load the account for

subscription - - the subscription to load the account for

paymentPreference - - the payment preference to load the account for

presentmentPreference - - the presentment preference to load the account for

lifeCycleState - the life cycle state to load the account for

Returns:

a list of accounts

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                 com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference,
                                                 com.crm.dataobject.accounts.CRMDOPresentmentPreference presentmentPreference,
                                                 com.crm.dataobject.accounts.AccountReceivableLifeCycleState lifeCycleState,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of accounts by a contact, subscription, payment preference, presentment preference ad lifecycle state.

Parameters:

contactInformation - - the contact to load the account for

subscription - - the subscription to load the account for

paymentPreference - - the payment preference to load the account for

presentmentPreference - - the presentment preference to load the account for

lifeCycleState - the life cycle state to load the account for

associations - - a list of associated data objects

Returns:

a list of accounts

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress contactInfoAddress)
                                                   throws java.lang.Exception

Loads a list of accounts by an address.

Parameters:

contactInfoAddress - - the address to load the accounts for

Returns:

a list of accounts with the given address

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail)
                                                   throws java.lang.Exception

Loads a list of accounts by an email.

Parameters:

contactInfoEmail - - the email to load the accounts for

Returns:

a list of accounts with the given email

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInfoPhone contactInfoPhone)
                                                   throws java.lang.Exception

Loads a list of accounts by a phone.

Parameters:

contactInfoPhone - - the phone to load the accounts for

Returns:

a list of accounts with the given phone

Throws:

java.lang.Exception

reactivate

public com.crm.dataobject.CRMDO reactivate(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                    throws java.lang.Exception,
                                           com.crm.exception.accounts.AccountReactivationException

Reactivates an account.

Parameters:

account - - the account to reactivate

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.accounts.AccountReactivationException

suspend

public com.crm.dataobject.CRMDO suspend(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                 throws java.lang.Exception,
                                        com.crm.exception.accounts.AccountSuspensionException

Suspends an account.

Parameters:

account - - the account to suspend

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.accounts.AccountSuspensionException

terminate

public com.crm.dataobject.CRMDO terminate(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                   throws java.lang.Exception,
                                          com.crm.exception.accounts.AccountTerminationException,
                                          com.crm.exception.accounts.CannotTerminateDueToSubscriptionsException,
                                          com.crm.exception.accounts.CannotTerminateDueToNotificationsException,
                                          com.crm.exception.accounts.CannotTerminateDueToFinancialTransactionsException

Terminates an account.

Parameters:

account - - the account to terminate

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.accounts.AccountTerminationException

com.crm.exception.accounts.CannotTerminateDueToSubscriptionsException

com.crm.exception.accounts.CannotTerminateDueToNotificationsException

com.crm.exception.accounts.CannotTerminateDueToFinancialTransactionsException

validateTermination

public void validateTermination(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                         throws java.lang.Exception,
                                com.crm.exception.accounts.AccountTerminationException,
                                com.crm.exception.accounts.CannotTerminateDueToSubscriptionsException,
                                com.crm.exception.accounts.CannotTerminateDueToJobsException,
                                com.crm.exception.accounts.CannotTerminateDueToWalletsException,
                                com.crm.exception.accounts.CannotTerminateDueToFinancialTransactionsException,
                                com.crm.exception.accounts.CannotTerminateDueToBillsException

Validate an account for termination.

Parameters:

account - - the account to validate

Throws:

java.lang.Exception

com.crm.exception.accounts.AccountTerminationException

com.crm.exception.accounts.CannotTerminateDueToSubscriptionsException

com.crm.exception.accounts.CannotTerminateDueToJobsException

com.crm.exception.accounts.CannotTerminateDueToWalletsException

com.crm.exception.accounts.CannotTerminateDueToFinancialTransactionsException

com.crm.exception.accounts.CannotTerminateDueToBillsException

getTotalDraftTransactions

public java.lang.Integer getTotalDraftTransactions(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                            throws java.lang.Exception

Returns the number of total draft transactions.

Parameters:

account - - the account to return the number of total draft transactions for

Returns:

the number of total draft transactions of the given account

Throws:

java.lang.Exception

validateCreditLimit

public com.crm.dataobject.CRMDO validateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                           java.math.BigDecimal transactionAmount)
                                             throws java.lang.Exception,
                                                    com.crm.exception.accounts.CreditLimitException

Validates the credit limit of an account by a transaction amount.

Parameters:

account - - the account to validate

transactionAmount - - the transaction amount to validate

Returns:

the updated account

Throws:

java.lang.Exception

com.crm.exception.accounts.CreditLimitException

getCreditLimitStatus

public com.crm.dataobject.accounts.CreditLimitStatus getCreditLimitStatus(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                                   throws java.lang.Exception

Returns the credit limit status of an account.

Parameters:

account - - the account to return the credit limit status for

Returns:

the credit limit status of the given account

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOBank bank,
                                                 com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference,
                                                 java.lang.String bankAccountNumber,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of accounts by a bank, payment preference and bank account number.

Parameters:

bank - - the bank to load the accounts for

paymentPreference - - the payment preference to load the accounts for

bankAccountNumber - - the bank account number to load the accounts for

associations - - a list of associated data objects

Returns:

a list of accounts

Throws:

java.lang.Exception

loadUnpaidInvoices

public com.crm.framework.util.ResultSetUtil loadUnpaidInvoices(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                        throws java.lang.Exception

Returns the unpaid invoices of an account.

Parameters:

account - - the account to return the unpaid invoices for

Returns:

the unpaid invoices of the given account

Throws:

java.lang.Exception

loadOverdueInvoices

public com.crm.framework.util.ResultSetUtil loadOverdueInvoices(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                       java.util.Date asOfDate)
                                                         throws java.lang.Exception

Returns the overdue invoices of an account as of a date.

Parameters:

account - - the account to return the overdue invoices for

asOfDate - - the date from which to calculate the overdue invoices

Returns:

the overdue invoices of the account as of the given date

Throws:

java.lang.Exception

getOutstandingAmount

public java.math.BigDecimal getOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                          throws java.lang.Exception

Returns the outstanding amount for an account.

Parameters:

account - - the account to return the outstanding amount for

Returns:

the outstanding amount for the account

Throws:

java.lang.Exception

getOutstandingAmount

public java.math.BigDecimal getOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                        java.util.Date asOfDate)
                                          throws java.lang.Exception

Returns the outstanding amount for an account as of a date.

Parameters:

account - - the account to return the outstanding amount for

asOfDate - - the date from which to calculate the outstanding amount

Returns:

the outstanding amount for the account as of the date

Throws:

java.lang.Exception

getOutstandingAmount

public java.math.BigDecimal getOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                        java.util.Date asOfDate,
                                        java.lang.Integer dueInXDays,
                                        java.lang.Integer dueXDaysAgo)
                                          throws java.lang.Exception

Returns the outstanding amount for an account as of a date.

Parameters:

account - - the account to return the outstanding amount for

asOfDate - - the date from which to calculate the outstanding amount

Returns:

the outstanding amount for the account as of the date

Throws:

java.lang.Exception

getAdjustedOutstandingAmount

public java.math.BigDecimal getAdjustedOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                java.util.Date asOfDate)
                                                  throws java.lang.Exception

Returns the adjusted outstanding amount for an account.
- calculates the outstanding amount and then subtracts the credit amount by executing billing for account in preview mode.

Parameters:

account - - the account to return the adjusted outstanding amount for

asOfDate - - the date from which to calculate the adjusted outstanding amount

Returns:

the adjusted outstanding amount for the account

Throws:

java.lang.Exception

getAdjustedOutstandingAmount

public java.math.BigDecimal getAdjustedOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                java.util.Date asOfDate,
                                                com.crm.dataobject.billing.CRMDONormalBillingRunDefinition normalBillingRunDefinition,
                                                com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition,
                                                java.util.ArrayList<com.crm.dataobject.CRMDO> pricePlans)
                                                  throws java.lang.Exception

Returns the adjusted outstanding amount for an account.
- calculates the outstanding amount and then subtracts the credit amount by executing billing for account in preview mode.

Parameters:

account - - the account to return the adjusted outstanding amount for

asOfDate - - the date from which to calculate the adjusted outstanding amount

normalBillingRunDefinition - - the normal billing run definition to use

billingTermDefinition - - the billing term definition to use

pricePlans - - a list of price plans to use

Returns:

the adjusted outstanding amount for the account as of the date

Throws:

java.lang.Exception

getBalance

public java.math.BigDecimal getBalance(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                              java.util.Date asOfDate)
                                throws java.lang.Exception

Returns the balance of an account as of a date.

Parameters:

account - - the account to return the balance for

asOfDate - - the date from which to calculate the balance

Returns:

the balance of the account as of the date

Throws:

java.lang.Exception

loadNonTerminated

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNonTerminated(com.crm.dataobject.accounts.CRMDOPaymentPreference paymentPreference,
                                                              com.crm.dataobject.accounts.CRMDOPresentmentPreference presentmentPreference,
                                                              com.crm.dataobject.accounts.CRMDOBank bank,
                                                              com.crm.dataobject.accounts.CRMDOBankBranch bankBranch,
                                                              com.crm.dataobject.accounts.CRMDOBankAccountType bankAccountType,
                                                              com.crm.dataobject.accounts.CRMDOAccountClassification accountClassification,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                                throws java.lang.Exception

Loads a list of non terminated accounts by payment preference, presentment preference, bank, bank branch, bank account type and account classification.

Parameters:

paymentPreference - - the payment preference to load the accounts for

presentmentPreference - - the presentment preference to load the accounts for

bank - - the bank to load the accounts for

bankBranch - - the bank branch to load the accounts for

bankAccountType - - the bank account type to load the accounts for

accountClassification - - the account classification to load the accounts for

associations - - a list of associated data objects

Returns:

a list of non terminated accounts

Throws:

java.lang.Exception

getOverdueAmountOfPreviousBills

public java.math.BigDecimal getOverdueAmountOfPreviousBills(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                     throws java.lang.Exception

Returns the total due amount of previous bills.
Total unpaid amount of all previous bills which still have an outstanding amount the overdue amount of an account.

Parameters:

account - - the account to return the overdue amount of

Returns:

the overdue amount of the given account

Throws:

java.lang.Exception

bill

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

Bills an account by a billing run.

Parameters:

billingRun - - the billing run to bill the account with

account - - the account to be billed

Returns:

the updated account

Throws:

java.lang.Exception

getBillingRunTransactions

public java.util.ArrayList<com.crm.dataobject.CRMDO> getBillingRunTransactions(com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                      com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                                        throws java.lang.Exception

Returns a list of billing run transactions of an account.

Parameters:

billingRun -

account - - the account to return the billing run transactions for

Returns:

a list of billing run transactions of the account

Throws:

java.lang.Exception

rateSubscriptions

public java.util.ArrayList<com.crm.dataobject.CRMDO> rateSubscriptions(java.util.ArrayList<com.crm.dataobject.CRMDO> subscriptions,
                                                              com.crm.dataobject.billing.CRMDONormalBillingRun normalBillingRun)
                                                                throws java.lang.Exception

Rates a list of subscriptions by a billing run.

Parameters:

subscriptions - - the list of subscriptions to be rated

normalBillingRun - - the normal billing run to rate the subscriptions with

Returns:

the updated list of subscriptions

Throws:

java.lang.Exception

rateSubscriptions

public java.util.ArrayList<com.crm.dataobject.CRMDO> rateSubscriptions(java.util.ArrayList<com.crm.dataobject.CRMDO> subscriptions,
                                                              com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                              com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                throws java.lang.Exception

Rates a list of subscriptions by a billing run.

Parameters:

subscriptions - - the list of subscriptions to be rated

prepaidBillingRun - - the prepaid billing run to rate the subscriptions with

wallet - - the wallet related with subscriptions

Returns:

the updated list of subscriptions

Throws:

java.lang.Exception

loadByClassification

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByClassification(com.crm.dataobject.accounts.CRMDOAccountClassification accountClassification)
                                                                   throws java.lang.Exception

Loads a list of accounts by an account classification.

Parameters:

accountClassification - - the account classification to use

Returns:

a list of accounts with the given account classification

Throws:

java.lang.Exception

bill

public com.crm.dataobject.accounts.CRMDOAccountReceivable bill(com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                      com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                        throws java.lang.Exception

Bills an account by a prepaid billing run.
- Start services Step (if is configured on Prepaid Definition).
- Rate subscription services. Stop services (if is configured on Prepaid Definition).
- Create wallet transaction based on rated billing items
- Calculate consumption dates (if is configured on Prepaid Definition).

Parameters:

prepaidBillingRun - - the prepaid billing run to bill the account with

account - - the account to be billed

Returns:

the updated account

Throws:

java.lang.Exception

bill

public com.crm.dataobject.accounts.CRMDOAccountReceivable bill(com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                      com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                      com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                        throws java.lang.Exception

Bills an account by a prepaid billing run.
- Start services Step (if is configured on Prepaid Definition).
- Rate subscription services. Stop services (if is configured on Prepaid Definition).
- Create wallet transaction based on rated billing items
- Calculate consumption dates (if is configured on Prepaid Definition).

Parameters:

prepaidBillingRun - - the prepaid billing run to bill the account with

account - - the account to be billed

wallet - - the related wallet

Returns:

the updated account

Throws:

java.lang.Exception

getLastBillToDate

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

Returns the Last Bill To Date

Parameters:

accountReceivable - - the account to return the Last Bill To Date for

Returns:

the Last Bill To Date

Throws:

java.lang.Exception

loadBillable

public com.crm.dataobject.accounts.CRMDOAccountReceivable loadBillable(java.lang.String accRecID,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

calculateUnsettledAmount

public java.math.BigDecimal calculateUnsettledAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

load

public com.crm.dataobject.CRMDO load(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                              throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                     java.lang.Exception

Loads an Accounts Receivable based on an access token.

Parameters:

accessToken - - the related access token

Returns:

the loaded Accounts Receivable

Throws:

java.lang.Exception

com.crm.exception.businessnetwork.CannotViewRecordException

setAccessTokenRestrictions

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

Throws:

java.lang.Exception