com.crm.businessobject.billing

Class CRMBOBillingTermDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOCacheableEntity

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

Modifier and Type	Method and Description
java.lang.Boolean	activeDefinitionExists() Checks whether an active billing term definition exists
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.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, com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition) 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) Deprecated.
java.lang.Boolean	isJobActionValidAgainstCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.lang.Boolean planAJob, java.lang.Boolean startProgressJob, java.lang.Boolean completeJob) Checks if the rule is valid against credit limit.
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	isSubscriptionActionValidAgainstCreditLimit(com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, com.crm.dataobject.accounts.CRMDOAccountReceivable account) Checks if the rule is valid against credit limit.
java.lang.Boolean	isSubscriptionAddressRuleCriterionValid(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.SubscriptionAddressRule subscriptionAddressRule) Checks if the subscription is used by a subscription of a specific type and billing term scheme
com.crm.dataobject.CRMDODefinition	loadActiveDefinition(com.crm.dataobject.billing.BillingTermDefinitionClassification classification) Deprecated.
com.crm.dataobject.CRMDODefinition	loadActiveDefinition(com.crm.dataobject.billing.BillingTermDefinitionClassification classification, java.util.ArrayList<java.lang.String> associations) Deprecated.
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) Deprecated.
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

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

CRMBOBillingTermDefinitionBean

public CRMBOBillingTermDefinitionBean()

Default constructor.

Method Detail

loadActiveDefinition

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

Deprecated.

Deprecated. Replaced by CRMBODefinition.loadActiveDefinition() Loads the active definition based on classification.

Parameters:

classification - - the classification of billing term definition

Returns:

the loaded active definition

Throws:

java.lang.Exception

loadActiveDefinition

@Deprecated
public com.crm.dataobject.CRMDODefinition loadActiveDefinition(com.crm.dataobject.billing.BillingTermDefinitionClassification classification,
                                                                           java.util.ArrayList<java.lang.String> associations)
                                                                    throws java.lang.Exception

Deprecated.

Deprecated. Replaced by CRMBODefinition.loadActiveDefinition(ArrayList) Loads the active definition based on classification.

Parameters:

classification - - the classification of billing term definition

associations -

Returns:

the loaded active definition

Throws:

java.lang.Exception

loadInactiveDefinitions

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

Deprecated.

Deprecated. 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.

Overrides:

getDefaultAssociations in class CRMBOConfigurationEntity

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

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,
                                                                                                          com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition)
                                                                                                   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

billingTermDefinition -

Returns:

the subscription service life cycle state

Throws:

java.lang.Exception

isSubscriptionActionValidAgainstCreditLimit

public java.lang.Boolean isSubscriptionActionValidAgainstCreditLimit(com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode,
                                                                     com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode,
                                                                     com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                              throws java.lang.Exception

Checks if the rule is valid against credit limit.

Parameters:

behaviorCode - - the behaviour code to check

classificationCode - - the classification code to check

account - - the account to check

Returns:

true if the rule is valid to execute action, false if not

Throws:

java.lang.Exception

isJobActionValidAgainstCreditLimit

public java.lang.Boolean isJobActionValidAgainstCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                            java.lang.Boolean planAJob,
                                                            java.lang.Boolean startProgressJob,
                                                            java.lang.Boolean completeJob)
                                                     throws java.lang.Exception

Checks if the rule is valid against credit limit.

Parameters:

account - - the account to check

planAJob - - a boolean regarding a job creation

startProgressJob - - a boolean regarding starting progress of a job

completeJob - - a boolean regarding completion of ajob

Returns:

true if the rule is valid to execute action, 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

getUsageServiceBillingProcessingMethod

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

Deprecated.

Checks if the rule is valid to set to effective.

Parameters:

billingTermDefinition -

billingTerm -

Returns:

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

Throws:

java.lang.Exception

activeDefinitionExists

public java.lang.Boolean activeDefinitionExists()
                                         throws java.lang.Exception

Checks whether an active billing term definition exists

Overrides:

activeDefinitionExists in class CRMBODefinition

Returns:

true if exists, false if not

Throws:

java.lang.Exception

isSubscriptionAddressRuleCriterionValid

public java.lang.Boolean isSubscriptionAddressRuleCriterionValid(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 com.crm.dataobject.subscriptions.SubscriptionAddressRule subscriptionAddressRule)
                                                          throws java.lang.Exception

Checks if the subscription is used by a subscription of a specific type and billing term scheme

Parameters:

subscription - - the subscription to check

subscriptionAddressRule - - the subscription address rule object that will define the types and schemes to be checked

Returns:

true if the subscription is used by a subscription of a specific type and scheme, false if not

Throws:

java.lang.Exception