com.crm.businessobject.billing

Class CRMBOBillingTermDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOConfigurationEntity

com.crm.businessobject.CRMBODefinition

com.crm.businessobject.billing.CRMBOBillingTermDefinitionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOBillingTermDefinitionBean
extends CRMBODefinition

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOBillingTermDefinitionBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a billing term definition.
com.crm.dataobject.subscriptions.BillingDirectiveState	getSubServiceLifeCycleStateBillingDirective(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService, java.util.Date date, com.crm.dataobject.subscriptions.SubscriptionServiceLifeCycleState lifeCycleState) Returns the subscription service life cycle state.
com.crm.dataobject.billing.UsageServiceProcessingMethod	getUsageServiceBillingProcessingMethod(com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm) Checks if the rule is valid to set to effective.
java.lang.Boolean	isNegativeBalanceAllowed(com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm) Checks if wallet debitting is allowed when resulting to a negative wallet balance based on a billing term definition, billing term.
java.lang.Boolean	isPriceChangeAllowed(com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.BindingState serviceBindingState) Checks if a price change is allowed based on a billing term definition, billing term and binding state.
java.lang.Boolean	isValidToSetEffective(com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.accounts.CRMDOAccountClassification accountClassification, com.crm.dataobject.accounts.CreditRating creditRatingCode, java.util.Date asOfDate) Checks if the rule is valid to set to effective.
com.crm.dataobject.CRMDODefinition	loadActiveDefinition() Deprecated.
com.crm.dataobject.CRMDODefinition	loadActiveDefinition(com.crm.dataobject.billing.BillingTermDefinitionClassification classification) Loads the active definition based on classification.
com.crm.dataobject.CRMDOConfigurationEntity	loadDefault() Loads the default configuration entity data object.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadInactiveDefinitions(com.crm.dataobject.billing.BillingTermDefinitionClassification classification) Loads a list of inactive definitions based on classification.
java.util.ArrayList<com.crm.dataobject.CRMDO>	setDefault(com.crm.dataobject.CRMDOConfigurationEntity configurationEntity) Sets a configuration entity data object as default.

Methods inherited from class com.crm.businessobject.CRMBODefinition

loadInactiveDefinitions, save, setActiveDefinition, validateOnDelete

Methods inherited from class com.crm.businessobject.CRMBOConfigurationEntity

isDefault

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, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, 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

CRMBOBillingTermDefinitionBean

public CRMBOBillingTermDefinitionBean()

Default constructor.

Method Detail

loadActiveDefinition

@Deprecated
public com.crm.dataobject.CRMDODefinition loadActiveDefinition()
                                                        throws java.lang.Exception,
                                                               com.crm.exception.MandatoryFieldException

Deprecated.

Description copied from class: CRMBODefinition

Loads the active definition.

Overrides:

loadActiveDefinition in class CRMBODefinition

Returns:

the loaded active definition

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

loadActiveDefinition

public com.crm.dataobject.CRMDODefinition loadActiveDefinition(com.crm.dataobject.billing.BillingTermDefinitionClassification classification)
                                                        throws java.lang.Exception

Loads the active definition based on classification.

Parameters:

classification - - the classification of billing term definition

Returns:

the loaded active definition

Throws:

java.lang.Exception

loadInactiveDefinitions

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

Loads a list of inactive definitions based on classification.

Parameters:

classification - - the classification of billing term definition

Returns:

a list of inactive definitions

Throws:

java.lang.Exception

getDefaultAssociations

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

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

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the billing term definition

loadDefault

public com.crm.dataobject.CRMDOConfigurationEntity loadDefault()
                                                        throws java.lang.Exception

Loads the default configuration entity data object.

Overrides:

loadDefault in class CRMBOConfigurationEntity

Returns:

the default configuration entity

Throws:

java.lang.Exception

setDefault

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

Sets a configuration entity data object as default.

Overrides:

setDefault in class CRMBOConfigurationEntity

Parameters:

configurationEntity - - the configuration entity to set as default

Returns:

a list of configuration entities

Throws:

java.lang.Exception

getSubServiceLifeCycleStateBillingDirective

public com.crm.dataobject.subscriptions.BillingDirectiveState getSubServiceLifeCycleStateBillingDirective(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                                 com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService,
                                                                                                 java.util.Date date,
                                                                                                 com.crm.dataobject.subscriptions.SubscriptionServiceLifeCycleState lifeCycleState)
                                                                                                   throws java.lang.Exception

Returns the subscription service life cycle state.

Parameters:

billingTerm - - the billing term to use to check

subscriptionService - - the subscription service to check

date - - the as of date to check

lifeCycleState - - the life cycle state to check

Returns:

the subscription service life cycle state

Throws:

java.lang.Exception

isValidToSetEffective

public java.lang.Boolean isValidToSetEffective(com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode,
                                      com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode,
                                      com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                      com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                      com.crm.dataobject.accounts.CRMDOAccountClassification accountClassification,
                                      com.crm.dataobject.accounts.CreditRating creditRatingCode,
                                      java.util.Date asOfDate)
                                        throws java.lang.Exception

Checks if the rule is valid to set to effective.

Parameters:

behaviorCode - - the behaviour code to check

classificationCode - - the classification code to check

billingTermScheme - - the billing term scheme to check

account - - the account to check

accountClassification - - the account classification to check

creditRatingCode - - the credit rating code to check

asOfDate - - the as of date to check

Returns:

true if the rule is valid to set to effective, false if not

Throws:

java.lang.Exception

isPriceChangeAllowed

public java.lang.Boolean isPriceChangeAllowed(com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition,
                                     com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                     com.crm.dataobject.billing.BindingState serviceBindingState)
                                       throws java.lang.Exception

Checks if a price change is allowed based on a billing term definition, billing term and binding state.

Parameters:

billingTermDefinition - - the billing term definition to check

billingTerm - - the billing term to check

serviceBindingState - - the service binding state to check

Returns:

true if a price change is allowed based on the given billing term definition, billing term and binding state, false if not

Throws:

java.lang.Exception

isNegativeBalanceAllowed

public java.lang.Boolean isNegativeBalanceAllowed(com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition,
                                         com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                           throws java.lang.Exception

Checks if wallet debitting is allowed when resulting to a negative wallet balance based on a billing term definition, billing term.

Parameters:

billingTermDefinition - - the billing term definition to check

billingTerm - - the billing term to check

Returns:

true if wallet debitting is allowed based on the given billing term definition, billing term, false if not

Throws:

java.lang.Exception

getUsageServiceBillingProcessingMethod

public com.crm.dataobject.billing.UsageServiceProcessingMethod getUsageServiceBillingProcessingMethod(com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition,
                                                                                             com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                                                                               throws java.lang.Exception

Checks if the rule is valid to set to effective.

Parameters:

behaviorCode - - the behaviour code to check

classificationCode - - the classification code to check

billingTermScheme - - the billing term scheme to check

account - - the account to check

accountClassification - - the account classification to check

creditRatingCode - - the credit rating code to check

asOfDate - - the as of date to check

Returns:

true if the rule is valid to set to effective, false if not

Throws:

java.lang.Exception