com.crm.businessobject.billing

Class CRMBOBillingTermSchemeBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOCacheableEntity

com.crm.businessobject.CRMBOConfigurationEntity

com.crm.businessobject.billing.CRMBOBillingTermSchemeBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOBillingTermSchemeBean
extends CRMBOConfigurationEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOBillingTermSchemeBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.billing.CRMDOBillingTermScheme	amend(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Amends a billing term scheme.
java.lang.Boolean	anniversaryDateCanChange(com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
com.crm.dataobject.billing.CRMDOBillingTermSchemeAllowedService	getBillingTermSchemeAllowedService(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct product) Returns the billing term scheme allowed service billing by a billing term scheme and a product.
com.crm.dataobject.billing.BillType	getBillingType(java.lang.String billingTermSchemeCode) Get billing type of scheme
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a billing term scheme.
com.crm.dataobject.billing.ServiceBillingType	getSubscriptionServiceBillingType(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct product) Returns the subscription service billing type by a billing term scheme and a product.
com.crm.dataobject.billing.BillingPolicy	getValidBillingPolicies(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct product)
java.lang.Boolean	isBillingFrequencyAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.lang.String billingFrequencyName) Checks if a billing frequency is allowed by a billing term scheme.
java.lang.Boolean	isBillingFrequencyValid(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.billing.BillingFrequency billingFrequency) Checks if a billing term scheme lookup is valid based on a billing term scheme and a billing frequency.
java.lang.Boolean	isBindingPeriodAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.lang.String bindingPeriodName) Checks if a binding period is allowed by a billing term scheme.
java.lang.Boolean	isBindingPeriodExtensionAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct service) Checks if a binding period end can be extended.
java.lang.Boolean	isBindingPeriodValid(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.billing.BindingPeriod bindingPeriod) Checks if a billing term scheme lookup is valid based on a billing term scheme and a binding period.
java.lang.Boolean	isCancellationExtensionAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct service) Checks if an allowed cancel date can be extended.
java.lang.Boolean	isPricePlanAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan) Checks if the price plan is allowed based on a billing term scheme.
java.lang.Boolean	isPricePlanAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.lang.String billingTermSchemeCode, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan) Checks if the price plan is allowed based on a billing term scheme.
java.lang.Boolean	isPricingFlexible(java.lang.String billingTermSchemeCode) Checks if the pricing is flexible based on a billing term scheme code.
java.lang.Boolean	isServiceAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct product) Checks if the service is allowed based on a billing term scheme.
java.lang.Boolean	isServicePostBilled(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.products.CRMDOProduct product) Checks if the billing type of a product is post-bill
java.lang.Boolean	isServicePostBilled(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct product) Checks if the billing type of a product is post-bill
java.lang.Boolean	isServicePreBilled(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.products.CRMDOProduct product) Checks if the billing type of a product is pre-bill
java.lang.Boolean	isServicePreBilled(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.products.CRMDOProduct product) Checks if the billing type of a product is pre-bill
java.lang.Boolean	isUsedByBillingTerms(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Checks if a billing term scheme is used by a billing term.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.products.CRMDOProduct product)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedBillingFrequencies(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads the allowed billing frequencies of a billing term scheme.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedBindingPeriods(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads the allowed binding periods of a billing term scheme.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedForPackagePricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads a list of allowed price plans by a billing term scheme code and for package subscription types.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedForPackagePricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.util.ArrayList<java.lang.String> pricePlanAssociations) Loads a list of allowed price plans by a billing term scheme code and for package subscription types.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads a list of allowed price plans by a billing term scheme code.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.util.ArrayList<java.lang.String> pricePlanAssociations) Loads a list of allowed price plans by a billing term scheme code.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.util.ArrayList<java.lang.String> pricePlanAssociations, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType) Loads a list of allowed price plans by a billing term scheme code.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType) Loads a list of allowed price plans by a billing term scheme code.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByClassification(com.crm.dataobject.billing.BillingTermSchemeClassification billingTermSchemeClassification) Loads billing term schemes by a classification.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByClassification(com.crm.dataobject.billing.BillingTermSchemeClassification billingTermSchemeClassification, java.util.ArrayList<java.lang.String> associations) Loads billing term schemes by a classification.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadByCode(java.util.ArrayList<com.crm.dataobject.billing.CRMDOBillingTermScheme> billingTermSchemes, java.lang.String billingTermSchemeCode, java.util.Date fromDate) Loads a billing term scheme by a code.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadByCode(java.lang.String code) Loads a billing term scheme by a code.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadByCode(java.lang.String code, java.util.ArrayList<java.lang.String> associations) Loads a billing term scheme by a code.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadByCode(java.lang.String code, java.util.Date fromDate, java.util.ArrayList<java.lang.String> associations) Loads a billing term scheme from a date and by a code.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes() Loads a list of effective billing term schemes.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(com.crm.dataobject.billing.BillingTermSchemeClassification classification) Loads a list of effective billing term schemes by a classification.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(com.crm.dataobject.billing.BillType billType) Loads a list of effective billing term schemes by bill type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(com.crm.dataobject.jobs.CRMDOJobType jobType) Loads a list of effective billing term schemes by job type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType) Loads a list of effective billing term schemes by subscription type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, java.util.ArrayList<java.lang.String> associations) Loads a list of effective billing term schemes by subscription type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(java.util.Date fromDate, com.crm.dataobject.jobs.CRMDOJobType jobType) Loads a list of effective billing term schemes from a date and by a job type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemes(java.util.Date fromDate, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, java.util.ArrayList<java.lang.String> associations) Loads a list of effective billing term schemes from a date and by a subscription type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffectiveSchemesNotOnSubscriptionType(com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, java.util.ArrayList<java.lang.String> associations) Loads the effective billing term schemes with classification SUBSCRIPTIONS which are not already added on the given subscription type.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadInitial(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads the initial version of a billing term scheme.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadLatest(com.crm.dataobject.billing.BillingTermSchemeClassification classification) Loads a list of billing term schemes filtered by the given criteria and having the latest version.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadLatest(com.crm.dataobject.billing.BillingTermSchemeClassification classification, com.crm.dataobject.billing.BillType billType) Loads a list of billing term schemes filtered by the given criteria and having the latest version.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadLatest(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads the latest billing term scheme.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadNext(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads the next billing term scheme of the current billing term scheme.
com.crm.dataobject.billing.CRMDOBillingTermScheme	loadPrevious(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads the billing term scheme that was replaced by the current billing term scheme.
java.util.ArrayList<com.crm.dataobject.billing.CRMDOBillingTermSchemeAllowedService>	loadSupportedServices(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Loads a list of supported services of a billing term scheme.
java.util.ArrayList<com.crm.dataobject.billing.CRMDOBillingTermSchemeAllowedService>	loadSupportedServices(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.billing.ServiceBillingType billingType) Loads a list of supported services of a billing term scheme.
java.lang.Boolean	preRatedServiceExists(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
com.crm.dataobject.billing.CRMDOBillingTermScheme	setBillingTermSchemePrepaidInformation(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme) Sets the prepaid information on a billing term scheme.

Methods inherited from class com.crm.businessobject.CRMBOConfigurationEntity

isDefault, loadDefault, setDefault

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CRMBOBillingTermSchemeBean

public CRMBOBillingTermSchemeBean()

Default constructor.

Method Detail

isUsedByBillingTerms

public java.lang.Boolean isUsedByBillingTerms(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                       throws java.lang.Exception

Checks if a billing term scheme is used by a billing term.

Parameters:

billingTermScheme - - the billing term scheme to check

Returns:

true if a billing term scheme is used by a billing term, false if not

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a billing term scheme.

Overrides:

getDefaultAssociations in class CRMBOConfigurationEntity

Returns:

the default associated data objects of the billing term scheme

amend

public com.crm.dataobject.billing.CRMDOBillingTermScheme amend(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                        throws java.lang.Exception,
                                                               com.crm.exception.billing.CannotAmendBillingTermSchemeException

Amends a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to amend

Returns:

the amended billing term scheme

Throws:

java.lang.Exception

com.crm.exception.billing.CannotAmendBillingTermSchemeException

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes()
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes.

Returns:

a list of effective billing term schemes

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(com.crm.dataobject.billing.BillingTermSchemeClassification classification)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes by a classification.

Parameters:

classification - - the classification to load the effective billing term schemes for

Returns:

a list of effective billing term schemes by the given classification

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(com.crm.dataobject.billing.BillType billType)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes by bill type.

Parameters:

billType - - the bill type to load the effective billing term schemes for

Returns:

a list of effective billing term schemes by the given bill type

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes by subscription type.

Parameters:

subscriptionType - - the subscription type to load the effective billing term schemes for

Returns:

a list of effective billing term schemes by the given subscription type

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType,
                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes by subscription type.

Parameters:

subscriptionType - - the subscription type to load the effective billing term schemes for

associations - - a list of associated objects

Returns:

a list of effective billing term schemes by the given subscription type

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(java.util.Date fromDate,
                                                                          com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType,
                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes from a date and by a subscription type.

Parameters:

fromDate - - the date to load the effective billing term schemes from

subscriptionType - - the subscription type to load the effective billing term scheme for

associations - - a list of associated objects

Returns:

a list of effective billing term schemes from the given date and by subscription type

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(com.crm.dataobject.jobs.CRMDOJobType jobType)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes by job type.

Parameters:

jobType - - the job type to load the effective billing term schemes for

Returns:

a list of effective billing term schemes by the given job type

Throws:

java.lang.Exception

loadEffectiveSchemes

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemes(java.util.Date fromDate,
                                                                          com.crm.dataobject.jobs.CRMDOJobType jobType)
                                                                   throws java.lang.Exception

Loads a list of effective billing term schemes from a date and by a job type.

Parameters:

fromDate - - the date to load the effective billing term schemes from

jobType - - the job type to load the effective billing term scheme for

Returns:

a list of effective billing term schemes from the given date and by job type

Throws:

java.lang.Exception

loadLatest

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadLatest(com.crm.dataobject.billing.BillingTermSchemeClassification classification)
                                                         throws java.lang.Exception

Loads a list of billing term schemes filtered by the given criteria and having the latest version.

Parameters:

classification - - the billing term scheme classification to load for

Returns:

a list of billing term schemes

Throws:

java.lang.Exception

loadLatest

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadLatest(com.crm.dataobject.billing.BillingTermSchemeClassification classification,
                                                                com.crm.dataobject.billing.BillType billType)
                                                         throws java.lang.Exception

Loads a list of billing term schemes filtered by the given criteria and having the latest version.

Parameters:

classification - - the billing term scheme classification to load for

billType - - the bill type to load for

Returns:

a list of billing term schemes

Throws:

java.lang.Exception

loadByCode

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadByCode(java.util.ArrayList<com.crm.dataobject.billing.CRMDOBillingTermScheme> billingTermSchemes,
                                                                    java.lang.String billingTermSchemeCode,
                                                                    java.util.Date fromDate)

Loads a billing term scheme by a code.

Parameters:

billingTermSchemes - - all billing term schemes on the system

billingTermSchemeCode - - the billing term scheme with the given code

fromDate - - a date to load from

Returns:

the billing term scheme with the given code

loadByCode

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadByCode(java.lang.String code)
                                                             throws java.lang.Exception

Loads a billing term scheme by a code.

Parameters:

code - - a billing term scheme code

Returns:

the billing term scheme with the given code

Throws:

java.lang.Exception

loadByCode

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadByCode(java.lang.String code,
                                                                    java.util.ArrayList<java.lang.String> associations)
                                                             throws java.lang.Exception

Loads a billing term scheme by a code.

Parameters:

code - - a billing term scheme code

associations - - a list of associated data objects

Returns:

the billing term scheme with the given code

Throws:

java.lang.Exception

loadByCode

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadByCode(java.lang.String code,
                                                                    java.util.Date fromDate,
                                                                    java.util.ArrayList<java.lang.String> associations)
                                                             throws java.lang.Exception

Loads a billing term scheme from a date and by a code.

Parameters:

code - - a billing term scheme code

fromDate - - a date to load from

associations - - a list of associated data objects

Returns:

the billing term scheme with the given code

Throws:

java.lang.Exception

loadPrevious

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadPrevious(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                               throws java.lang.Exception

Loads the billing term scheme that was replaced by the current billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the replaced billing term scheme from

Returns:

the billing term scheme that was replaced by the current billing term scheme

Throws:

java.lang.Exception

loadNext

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadNext(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                           throws java.lang.Exception

Loads the next billing term scheme of the current billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the next billing term scheme for

Returns:

the next billing term scheme of the current billing term scheme

Throws:

java.lang.Exception

loadInitial

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadInitial(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                              throws java.lang.Exception

Loads the initial version of a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the initial version of

Returns:

the initial version of the given billing term scheme

Throws:

java.lang.Exception

loadLatest

public com.crm.dataobject.billing.CRMDOBillingTermScheme loadLatest(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                             throws java.lang.Exception

Loads the latest billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the latest version of

Returns:

the latest billing term scheme

Throws:

java.lang.Exception

loadAllowedBillingFrequencies

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedBillingFrequencies(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                                            throws java.lang.Exception

Loads the allowed billing frequencies of a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the allowed billing frequencies for

Returns:

the allowed billing frequencies of the given billing term scheme

Throws:

java.lang.Exception

isBillingFrequencyAllowed

public java.lang.Boolean isBillingFrequencyAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                   java.lang.String billingFrequencyName)
                                            throws java.lang.Exception

Checks if a billing frequency is allowed by a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to check

billingFrequencyName - - the billing frequency to check

Returns:

true if the given billing frequency is allowed by the given billing term scheme

Throws:

java.lang.Exception

loadAllowedPricePlans

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                                    throws java.lang.Exception

Loads a list of allowed price plans by a billing term scheme code.

Parameters:

billingTermScheme - - the billing term scheme code to load the allowed price plans for

Returns:

a list of allowed price plans by the given billing term scheme code

Throws:

java.lang.Exception

loadAllowedPricePlans

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                           com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                           com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType)
                                                                    throws java.lang.Exception

Loads a list of allowed price plans by a billing term scheme code.

Parameters:

billingTermScheme - - the billing term scheme code to load the allowed price plans for

accountReceivable - - the account receivable to load the allowed price plans for

subscriptionType - - the subscription type to load the allowed price plans for

Returns:

a list of allowed price plans by the given billing term scheme code

Throws:

java.lang.Exception

loadAllowedPricePlans

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                           java.util.ArrayList<java.lang.String> pricePlanAssociations)
                                                                    throws java.lang.Exception

Loads a list of allowed price plans by a billing term scheme code.

Parameters:

billingTermScheme - - the billing term scheme code to load the allowed price plans for

pricePlanAssociations - - the price plan associated objects

Returns:

a list of allowed price plans by the given billing term scheme code

Throws:

java.lang.Exception

loadAllowedPricePlans

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedPricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                           java.util.ArrayList<java.lang.String> pricePlanAssociations,
                                                                           com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                           com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType)
                                                                    throws java.lang.Exception

Loads a list of allowed price plans by a billing term scheme code.

Parameters:

billingTermScheme - - the billing term scheme code to load the allowed price plans for

pricePlanAssociations - - the price plan associated objects

accountReceivable - - the account receivable to load the allowed price plans for

subscriptionType - - the subscription type to load the allowed price plans for

Returns:

a list of allowed price plans by the given billing term scheme code

Throws:

java.lang.Exception

loadAllowedForPackagePricePlans

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedForPackagePricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                                              throws java.lang.Exception

Loads a list of allowed price plans by a billing term scheme code and for package subscription types.

Parameters:

billingTermScheme - - the billing term scheme code to load the allowed price plans for

Returns:

a list of allowed price plans for package subscription types by the given billing term scheme code

Throws:

java.lang.Exception

loadAllowedForPackagePricePlans

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedForPackagePricePlans(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                                     java.util.ArrayList<java.lang.String> pricePlanAssociations)
                                                                              throws java.lang.Exception

Loads a list of allowed price plans by a billing term scheme code and for package subscription types.

Parameters:

billingTermScheme - - the billing term scheme code to load the allowed price plans for

pricePlanAssociations - - the price plan associated objects

Returns:

a list of allowed price plans for package subscription types by the given billing term scheme code

Throws:

java.lang.Exception

loadAllowedBindingPeriods

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedBindingPeriods(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                                        throws java.lang.Exception

Loads the allowed binding periods of a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the allowed binding periods for

Returns:

the allowed binding periods of the given billing term scheme

Throws:

java.lang.Exception

isBindingPeriodAllowed

public java.lang.Boolean isBindingPeriodAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                java.lang.String bindingPeriodName)
                                         throws java.lang.Exception

Checks if a binding period is allowed by a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to check

bindingPeriodName - - the binding period name to check

Returns:

true if the given binding period is allowed by the given billing term scheme

Throws:

java.lang.Exception

loadSupportedServices

public java.util.ArrayList<com.crm.dataobject.billing.CRMDOBillingTermSchemeAllowedService> loadSupportedServices(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                                                                           throws java.lang.Exception

Loads a list of supported services of a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the supported services for

Returns:

a list of supported services of the given billing term scheme

Throws:

java.lang.Exception

loadSupportedServices

public java.util.ArrayList<com.crm.dataobject.billing.CRMDOBillingTermSchemeAllowedService> loadSupportedServices(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                                                                  com.crm.dataobject.billing.ServiceBillingType billingType)
                                                                                                           throws java.lang.Exception

Loads a list of supported services of a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to load the supported services for

billingType - - the services billing type

Returns:

a list of supported services of the given billing term scheme

Throws:

java.lang.Exception

isBindingPeriodExtensionAllowed

public java.lang.Boolean isBindingPeriodExtensionAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                         com.crm.dataobject.products.CRMDOProduct service)
                                                  throws java.lang.Exception

Checks if a binding period end can be extended.

Parameters:

billingTermScheme - - the billing term scheme to check

service - - the service to check

Returns:

true if the binding period can be extended, false if not

Throws:

java.lang.Exception

isCancellationExtensionAllowed

public java.lang.Boolean isCancellationExtensionAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                        com.crm.dataobject.products.CRMDOProduct service)
                                                 throws java.lang.Exception

Checks if an allowed cancel date can be extended.

Parameters:

billingTermScheme - - the billing term scheme to check

service - - the service to check

Returns:

true if the allowed cancel date can be extended, false if not

Throws:

java.lang.Exception

getSubscriptionServiceBillingType

public com.crm.dataobject.billing.ServiceBillingType getSubscriptionServiceBillingType(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                                       com.crm.dataobject.products.CRMDOProduct product)
                                                                                throws java.lang.Exception

Returns the subscription service billing type by a billing term scheme and a product.

Parameters:

billingTermScheme - - the billing term scheme to use

product - - the product to use

Returns:

the subscription service billing type by the given billing term scheme and product

Throws:

java.lang.Exception

getBillingTermSchemeAllowedService

public com.crm.dataobject.billing.CRMDOBillingTermSchemeAllowedService getBillingTermSchemeAllowedService(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                                                          com.crm.dataobject.products.CRMDOProduct product)
                                                                                                   throws java.lang.Exception

Returns the billing term scheme allowed service billing by a billing term scheme and a product.

Parameters:

billingTermScheme - - the billing term scheme to use

product - - the product to use

Returns:

the billing term scheme allowed service billing

Throws:

java.lang.Exception

isServicePostBilled

public java.lang.Boolean isServicePostBilled(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                             com.crm.dataobject.products.CRMDOProduct product)
                                      throws java.lang.Exception

Checks if the billing type of a product is post-bill

Parameters:

billingTerm - - the billing term to check

product - - the product to check

Returns:

true if the billing type of the given product is post-bill, false if not

Throws:

java.lang.Exception

isServicePostBilled

public java.lang.Boolean isServicePostBilled(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                             com.crm.dataobject.products.CRMDOProduct product)
                                      throws java.lang.Exception

Checks if the billing type of a product is post-bill

Parameters:

billingTermScheme - - the billing term scheme to check

product - - the product to check

Returns:

true if the billing type of the given product is post-bill, false if not

Throws:

java.lang.Exception

isServicePreBilled

public java.lang.Boolean isServicePreBilled(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                            com.crm.dataobject.products.CRMDOProduct product)
                                     throws java.lang.Exception

Checks if the billing type of a product is pre-bill

Parameters:

billingTerm - - the billing term to check

product - - the product to check

Returns:

true if the billing type of the given product is pre-bill, false if not

Throws:

java.lang.Exception

isServicePreBilled

public java.lang.Boolean isServicePreBilled(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                            com.crm.dataobject.products.CRMDOProduct product)
                                     throws java.lang.Exception

Checks if the billing type of a product is pre-bill

Parameters:

billingTermScheme - - the billing term scheme to check

product - - the product to check

Returns:

true if the billing type of the given product is pre-bill, false if not

Throws:

java.lang.Exception

isBillingFrequencyValid

public java.lang.Boolean isBillingFrequencyValid(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                 com.crm.dataobject.billing.BillingFrequency billingFrequency)
                                          throws java.lang.Exception

Checks if a billing term scheme lookup is valid based on a billing term scheme and a billing frequency.

Parameters:

billingTermScheme - - the billing term scheme to check

billingFrequency - - the billing frequency to check

Returns:

true if a billing term scheme lookup is valid based on a billing term scheme and a billing frequency, false if not

Throws:

java.lang.Exception

isBindingPeriodValid

public java.lang.Boolean isBindingPeriodValid(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                              com.crm.dataobject.billing.BindingPeriod bindingPeriod)
                                       throws java.lang.Exception

Checks if a billing term scheme lookup is valid based on a billing term scheme and a binding period.

Parameters:

billingTermScheme - - the billing term scheme to check

bindingPeriod - - the binding period to check

Returns:

true if a billing term scheme lookup is valid based on a billing term scheme and a binding period, false if not

Throws:

java.lang.Exception

isServiceAllowed

public java.lang.Boolean isServiceAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                          com.crm.dataobject.products.CRMDOProduct product)
                                   throws java.lang.Exception

Checks if the service is allowed based on a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to check

product - - the product to check

Returns:

true if the service is allowed based on a billing term scheme, false if not

Throws:

java.lang.Exception

isPricePlanAllowed

public java.lang.Boolean isPricePlanAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                            com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan)
                                     throws java.lang.Exception

Checks if the price plan is allowed based on a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to check

pricePlan - - the price plan to check

Returns:

true if the price plan is allowed based on a billing term scheme, false if not

Throws:

java.lang.Exception

isPricePlanAllowed

public java.lang.Boolean isPricePlanAllowed(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                            java.lang.String billingTermSchemeCode,
                                            com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan)
                                     throws java.lang.Exception

Checks if the price plan is allowed based on a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to check

pricePlan - - the price plan to check

Returns:

true if the price plan is allowed based on a billing term scheme, false if not

Throws:

java.lang.Exception

isPricingFlexible

public java.lang.Boolean isPricingFlexible(java.lang.String billingTermSchemeCode)
                                    throws java.lang.Exception

Checks if the pricing is flexible based on a billing term scheme code.

Parameters:

billingTermSchemeCode - - the billing term scheme code to check

Returns:

true if the pricing is flexible based on the billing term scheme code, false if not

Throws:

java.lang.Exception

getBillingType

public com.crm.dataobject.billing.BillType getBillingType(java.lang.String billingTermSchemeCode)
                                                   throws java.lang.Exception

Get billing type of scheme

Parameters:

billingTermSchemeCode - - the billing term scheme

Returns:

Get billing type of scheme

Throws:

java.lang.Exception

loadByClassification

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByClassification(com.crm.dataobject.billing.BillingTermSchemeClassification billingTermSchemeClassification)
                                                                   throws java.lang.Exception

Loads billing term schemes by a classification.

Parameters:

billingTermSchemeClassification - - a billing term scheme classification

Returns:

the billing term schemes with the given classification

Throws:

java.lang.Exception

loadByClassification

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByClassification(com.crm.dataobject.billing.BillingTermSchemeClassification billingTermSchemeClassification,
                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                   throws java.lang.Exception

Loads billing term schemes by a classification.

Parameters:

billingTermSchemeClassification - - a billing term scheme classification

associations -

Returns:

the billing term schemes with the given classification

Throws:

java.lang.Exception

preRatedServiceExists

public java.lang.Boolean preRatedServiceExists(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                        throws com.crm.exception.CRMException,
                                               java.lang.Exception

Throws:

com.crm.exception.CRMException

java.lang.Exception

loadEffectiveSchemesNotOnSubscriptionType

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffectiveSchemesNotOnSubscriptionType(com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType,
                                                                                               java.util.ArrayList<java.lang.String> associations)
                                                                                        throws java.lang.Exception

Loads the effective billing term schemes with classification SUBSCRIPTIONS which are not already added on the given subscription type.

Parameters:

subscriptionType - - a subscription type to load the billing term schemes for

associations -

Returns:

a list of effective applicable billing term schemes

Throws:

java.lang.Exception

load

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

Throws:

java.lang.Exception

setBillingTermSchemePrepaidInformation

public com.crm.dataobject.billing.CRMDOBillingTermScheme setBillingTermSchemePrepaidInformation(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                                                         throws java.lang.Exception

Sets the prepaid information on a billing term scheme.

Parameters:

billingTermScheme - - the billing term scheme to set the prepaid information

Returns:

the updated billing term scheme

Throws:

java.lang.Exception

anniversaryDateCanChange

public java.lang.Boolean anniversaryDateCanChange(com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode,
                                                  com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getValidBillingPolicies

public com.crm.dataobject.billing.BillingPolicy getValidBillingPolicies(com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                                        com.crm.dataobject.products.CRMDOProduct product)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception