CRMBOBillingTermBean

java.lang.Object
- com.crm.businessobject.CRMBase
- - com.crm.businessobject.CRMBO
  - - com.crm.businessobject.billing.CRMBOBillingTermBean

All Implemented Interfaces:

java.io.Serializable
```
public class CRMBOBillingTermBean
extends CRMBO
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CRMBOBillingTermBean()
Default constructor.

Constructors
Constructor and Description
`CRMBOBillingTermBean()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Date`	`addBillFrequency(java.util.Date date, com.crm.dataobject.billing.BillingFrequency billingFrequency)` Adds a billing frequency to a date.
`java.util.Date`	`addBillFrequency(java.util.Date date, com.crm.dataobject.billing.BillingFrequency billingFrequency, com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition)` Adds a billing frequency to a date by a billing term definition.
`java.util.Date`	`addBindingPeriod(java.util.Date date, com.crm.dataobject.billing.BindingPeriod bindingPeriod)` Calculates the binding end date by a binding period.
`java.util.Date`	`addBindingPeriod(java.util.Date date, com.crm.dataobject.billing.BindingPeriod bindingPeriod, com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition)` Calculates the binding end date by a binding period and a billing term definition.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`amend(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)` Amends a billing term.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`amend(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, java.util.Date scheduledDate)` Amends a billing term.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`construct(com.crm.dataobject.jobs.CRMDOJob job, java.lang.String billingTermSchemeCode, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan, java.util.Date agreementDate)` Constructs a billing term by a job, a billing term scheme, a price plan, an agreement date and a scheduled date.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`construct(com.crm.dataobject.jobs.CRMDOJob job, java.lang.String billingTermSchemeCode, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan, java.util.Date agreementDate, java.util.Date scheduledDate)` Constructs a billing term by a job, a billing term scheme, a price plan, an agreement date and a scheduled date.
`com.crm.dataobject.billing.CRMDOBillingTerm`	construct(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan, com.crm.dataobject.billing.BillingFrequency billingFrequency, com.crm.dataobject.billing.BindingPeriod bindingPeriod, java.util.Date bindingStartDate, java.util.Date bindingEndDate, java.util.Date agreementDate, java.math.BigDecimal concurrentUsage, java.math.BigDecimal ratePercentage, java.util.Date scheduledDate) Constructs a billing term by a subscription, a billing term scheme, a price plan, a billing frequency, a binding period, a binding start date, a binding end date, an agreement date, a concurrent usage, a rate percentage and a scheduled date.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`construct(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan, java.util.Date scheduledDate)` Constructs a billing term by a subscription, a billing term scheme, a price plan and a scheduled date.
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType) Get the valid billing term period based on job product and date billing term period - - -
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Get the valid billing term period based on job product and date billing term period - - -
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, com.crm.dataobject.jobs.CRMDOJobProduct jobProduct) Get the valid billing term period based on job product and date billing term period - - -
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, com.crm.dataobject.jobs.CRMDOJobProduct jobProduct, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Get the valid billing term period based on job product and date billing term period - - -
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, com.crm.dataobject.jobs.CRMDOJobRequestedProduct jobRequestedProduct) Get the valid billing term period based on job product and date billing term period - - -
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, com.crm.dataobject.jobs.CRMDOJobRequestedProduct jobRequestedProduct, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Get the valid billing term period based on job product and date billing term period - - -
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService, com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory subServicePeriod, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.BindingState bindingState, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, java.lang.Integer consumptionEstimationStep, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Get billing term period based on subscription product and from date
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService, com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory subServicePeriod, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, java.util.Date rateToDate, com.crm.dataobject.billing.BindingState bindingState, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, java.lang.Integer consumptionEstimationStep, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Get billing term periods based on subscription product and from date range (rateFromDate - rateToDate)
`java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod>`	getBillingTermPeriods(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOUdr udr, com.crm.dataobject.products.CRMDOProduct product, java.util.Date rateFromDate, com.crm.dataobject.billing.BindingState bindingState, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment, com.crm.dataobject.billing.BillType billType, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Get billing term period based on subscription product and from date
`com.crm.dataobject.billing.BindingState`	`getBindingState(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, java.util.Date date)` Returns the binding state of a billing term.
`java.util.ArrayList<java.lang.String>`	`getDefaultAssociations()` Returns the default associated data objects of a billing term.
`java.util.Date`	getNewBindingStartDateForBillingTermAmendment(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, java.util.Date agreementDate, java.util.Date scheduledDate, java.util.Date bindingStartDate, com.crm.dataobject.billing.BindingPeriod bindingPeriod) Gets the binding start date for a billing term based on given parameters when a billing term is amended
`java.util.Date`	`getNewBindingStartDateForJob(com.crm.dataobject.jobs.CRMDOJobRequestedBillingTerm jobRequestedBillingTerm, com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, java.util.Date agreementDate, java.util.Date susbcriptionCreatedDate)` Gets the binding start date for a billing term based on given parameters
`java.util.Date`	`getNewBindingStartDateForSubscriptionActivation(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition)` Gets the binding start date for a billing term based on given parameters when a subscription is activated
`java.util.Date`	`getNewBindingStartDateForSubscriptionCreation(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, java.util.Date effectiveDate, java.util.Date susbcriptionCreatedDate, java.util.Date scheduledDate)` Gets the binding start date for a billing term based on given parameters when a subscription is created
`java.util.Date`	`getNewBindingStartDateForSubscriptionServiceActivation(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition)` Gets the binding start date for a billing term based on given parameters when activating a subscription service
`java.util.Date`	`getNextBillingCycleDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)`
`java.lang.Boolean`	`isPricingFlexible(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)`
`java.util.ArrayList<com.crm.dataobject.CRMDO>`	`load(com.crm.dataobject.jobs.CRMDOJob job)` Loads a list of billing terms for a job.
`java.util.ArrayList<com.crm.dataobject.CRMDO>`	`load(com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan)` Loads a list of billing terms of a price plan.
`java.util.ArrayList<com.crm.dataobject.CRMDO>`	`load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.ArrayList<java.lang.String> associations)` Loads a list of billing terms for a subscription.
`java.util.ArrayList<com.crm.dataobject.CRMDO>`	`loadByPeriod(com.crm.dataobject.jobs.CRMDOJob job, java.util.Date fromDate, java.util.Date toDate)` Loads a list of billing terms for a job for a period of time.
`java.util.ArrayList<com.crm.dataobject.CRMDO>`	`loadByPeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.jobs.CRMDOJob job, java.util.Date fromDate, java.util.Date toDate, java.util.ArrayList<java.lang.String> associations)` Loads a list of billing terms for a (subscription or job) for a period of time.
`java.util.ArrayList<com.crm.dataobject.CRMDO>`	`loadByPeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate)` Loads a list of billing terms for a subscription for a period of time.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.jobs.CRMDOJob job)` Loads the effective billing term of a subscription.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.jobs.CRMDOJob job, java.util.Date effectiveDate)`
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)` Loads the effective billing term of a subscription.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingRun billingRun, java.util.Date effectiveDate)`
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingRun billingRun, java.util.Date effectiveDate, java.util.ArrayList<java.lang.String> associations)`
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date effectiveDate)` Loads the effective billing term of a subscription.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date effectiveDate, java.util.ArrayList<java.lang.String> associations)` Loads the effective billing term of a subscription.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadInitial(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)` Loads the initial version of a billing term.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadLatest(com.crm.dataobject.jobs.CRMDOJob job)` Loads the latest billing term version of a job.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadLatest(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)` Loads the latest billing term version of a subscription.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadNext(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)` Loads the next billing term version of the current billing term.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`loadPrevious(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)` Loads the previous billing term version of the current billing term.
`com.crm.dataobject.billing.CRMDOBillingTerm`	`setBillingCycleDayLastMonthDay(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, java.util.Date scheduledDate)`
`com.crm.dataobject.billing.CRMDOBillingTerm`	`setBindingDates(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, java.util.Date agreementDate, java.util.Date effectiveDate, java.util.Date susbcriptionCreatedDate, java.util.Date scheduledDate)` Sets the binding dates on a billing term based on given parameters
`com.crm.dataobject.billing.CRMDOBillingTerm`	`setDefaultValues(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)` Copies the default attributes of a billing term by a billing term scheme.
`void`	`validateBindingPeriod(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)` Validates the binding period of a billing term.

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
- CRMBOBillingTermBean
```
public CRMBOBillingTermBean()
```
  Default constructor.

Method Detail

construct

public com.crm.dataobject.billing.CRMDOBillingTerm construct(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                             com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                             com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan,
                                                             com.crm.dataobject.billing.BillingFrequency billingFrequency,
                                                             com.crm.dataobject.billing.BindingPeriod bindingPeriod,
                                                             java.util.Date bindingStartDate,
                                                             java.util.Date bindingEndDate,
                                                             java.util.Date agreementDate,
                                                             java.math.BigDecimal concurrentUsage,
                                                             java.math.BigDecimal ratePercentage,
                                                             java.util.Date scheduledDate)
                                                      throws java.lang.Exception

Constructs a billing term by a subscription, a billing term scheme, a price plan, a billing frequency, a binding period, a binding start date, a binding end date, an agreement date, a concurrent usage, a rate percentage and a scheduled date.

Parameters:: subscription - - the subscription to use; billingTermScheme - - the billing term scheme to use; pricePlan - - the price plan to use; billingFrequency - - the billing frequency to use; bindingPeriod - - the binding period to use; bindingStartDate - - the binding start date to use; bindingEndDate - - the binding end date to use; agreementDate - - the agreement date to use; concurrentUsage - - the concurrent usage to use; ratePercentage - - the rate percentage to use; scheduledDate - - the scheduled date to use
Returns:: a billing term
Throws:: java.lang.Exception

construct

public com.crm.dataobject.billing.CRMDOBillingTerm construct(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                             com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                             com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan,
                                                             java.util.Date scheduledDate)
                                                      throws java.lang.Exception

Constructs a billing term by a subscription, a billing term scheme, a price plan and a scheduled date.

Parameters:: subscription - - the subscription to use; billingTermScheme - - the billing term scheme to use; pricePlan - - the price plan to use; scheduledDate - - the scheduled date to use
Returns:: a billing term
Throws:: java.lang.Exception

setDefaultValues

public com.crm.dataobject.billing.CRMDOBillingTerm setDefaultValues(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                    com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme)
                                                             throws java.lang.Exception

Copies the default attributes of a billing term by a billing term scheme.

Parameters:: billingTerm - - the billing term to copy the default attributes to; billingTermScheme - - the billing term scheme to use
Returns:: the updated billing term
Throws:: java.lang.Exception

construct

public com.crm.dataobject.billing.CRMDOBillingTerm construct(com.crm.dataobject.jobs.CRMDOJob job,
                                                             java.lang.String billingTermSchemeCode,
                                                             com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan,
                                                             java.util.Date agreementDate)
                                                      throws java.lang.Exception

Constructs a billing term by a job, a billing term scheme, a price plan, an agreement date and a scheduled date.

Parameters:: job - - the job to use; billingTermSchemeCode - - the code of the billing term scheme to use; pricePlan - - the price plan to use; agreementDate - - the agreement date to use
Returns:: a billing term
Throws:: java.lang.Exception

construct

public com.crm.dataobject.billing.CRMDOBillingTerm construct(com.crm.dataobject.jobs.CRMDOJob job,
                                                             java.lang.String billingTermSchemeCode,
                                                             com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan,
                                                             java.util.Date agreementDate,
                                                             java.util.Date scheduledDate)
                                                      throws java.lang.Exception

Constructs a billing term by a job, a billing term scheme, a price plan, an agreement date and a scheduled date.

Parameters:: job - - the job to use; billingTermSchemeCode - - the code of the billing term scheme to use; pricePlan - - the price plan to use; agreementDate - - the agreement date to use; scheduledDate - - the scheduled date to use
Returns:: a billing term
Throws:: java.lang.Exception

validateBindingPeriod

public void validateBindingPeriod(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                           throws java.lang.Exception,
                                  com.crm.exception.MandatoryFieldException

Validates the binding period of a billing term.

Parameters:: billingTerm - - the billing term to validate
Throws:: java.lang.Exception; com.crm.exception.MandatoryFieldException

getDefaultAssociations
```
public java.util.ArrayList<java.lang.String> getDefaultAssociations()
```
Returns the default associated data objects of a billing term.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the billing term

amend

public com.crm.dataobject.billing.CRMDOBillingTerm amend(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                                  throws java.lang.Exception

Amends a billing term.

Parameters:: billingTerm - - the billing term to amend
Returns:: the updated billing term
Throws:: java.lang.Exception

amend

public com.crm.dataobject.billing.CRMDOBillingTerm amend(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                         java.util.Date scheduledDate)
                                                  throws java.lang.Exception

Amends a billing term.

Parameters:: billingTerm - - the billing term to amend; scheduledDate - - the scheduled date to amend the billing term for
Returns:: the updated billing term
Throws:: java.lang.Exception

loadEffective
```
public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                          throws java.lang.Exception
```
Loads the effective billing term of a subscription.

Parameters:

subscription - - the subscription to load the effective billing term for

Returns:

the effective billing term of the given subscription

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 java.util.Date effectiveDate)
                                                          throws java.lang.Exception

Loads the effective billing term of a subscription.

Parameters:: subscription - - the subscription to load the effective billing term for; effectiveDate - - the effective Date to load the billing term
Returns:: the effective billing term of the given subscription
Throws:: java.lang.Exception

loadEffective

public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 java.util.Date effectiveDate,
                                                                 java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Loads the effective billing term of a subscription.

Parameters:: subscription - - the subscription to load the effective billing term for; effectiveDate - - the effective Date to load the billing term
Returns:: the effective billing term of the given subscription
Throws:: java.lang.Exception

loadEffective

public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                 java.util.Date effectiveDate)
                                                          throws java.lang.Exception

Throws:: java.lang.Exception

loadEffective

public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                 java.util.Date effectiveDate,
                                                                 java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Throws:: java.lang.Exception

loadEffective
```
public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.jobs.CRMDOJob job)
                                                          throws java.lang.Exception
```
Loads the effective billing term of a subscription.

Parameters:

job - - the job to load the effective billing term for

Returns:

the effective billing term of the given subscription

Throws:

java.lang.Exception

loadEffective

public com.crm.dataobject.billing.CRMDOBillingTerm loadEffective(com.crm.dataobject.jobs.CRMDOJob job,
                                                                 java.util.Date effectiveDate)
                                                          throws java.lang.Exception

Throws:: java.lang.Exception

load
```
public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan)
                                                   throws java.lang.Exception
```
Loads a list of billing terms of a price plan.

Parameters:

pricePlan - - the price plan to load the billing terms for

Returns:

a list of billing terms of the given price plan

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of billing terms for a subscription.

Parameters:: subscription - - the subscription to load the billing term for
Returns:: a list of billing terms for the given subscription
Throws:: java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.jobs.CRMDOJob job)
                                                   throws java.lang.Exception

Loads a list of billing terms for a job.

Parameters:: job - - the job to load the billing term for
Returns:: a list of billing terms for the given job
Throws:: java.lang.Exception

loadByPeriod

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByPeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                  java.util.Date fromDate,
                                                                  java.util.Date toDate)
                                                           throws java.lang.Exception

Loads a list of billing terms for a subscription for a period of time.

Parameters:: subscription - - the subscription to load the billing term for; fromDate - - the from date to load the billing term for; toDate - - the to date to load the billing term for
Returns:: a list of billing terms for the given subscription for the given period of time
Throws:: java.lang.Exception

loadByPeriod

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByPeriod(com.crm.dataobject.jobs.CRMDOJob job,
                                                                  java.util.Date fromDate,
                                                                  java.util.Date toDate)
                                                           throws java.lang.Exception

Loads a list of billing terms for a job for a period of time.

Parameters:: job - - the job to load the billing term for; fromDate - - the from date to load the billing term for; toDate - - the to date to load the billing term for
Returns:: a list of billing terms for the given job for the given period of time
Throws:: java.lang.Exception

loadByPeriod

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByPeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                  com.crm.dataobject.jobs.CRMDOJob job,
                                                                  java.util.Date fromDate,
                                                                  java.util.Date toDate,
                                                                  java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads a list of billing terms for a (subscription or job) for a period of time.

Parameters:: subscription - - the subscription to load the billing term for; job - - the job to load the billing term for; fromDate - - the from date to load the billing term for; toDate - - the to date to load the billing term for; associations -
Returns:: a list of billing terms for the given (subscription or job) for the given period of time
Throws:: java.lang.Exception

loadPrevious
```
public com.crm.dataobject.billing.CRMDOBillingTerm loadPrevious(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                                         throws java.lang.Exception
```
Loads the previous billing term version of the current billing term.

Parameters:

billingTerm - - the billing term to load the previous billing term from

Returns:

the previous billing term of the current billing term

Throws:

java.lang.Exception

loadNext
```
public com.crm.dataobject.billing.CRMDOBillingTerm loadNext(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                                     throws java.lang.Exception
```
Loads the next billing term version of the current billing term.

Parameters:

billingTerm - - the billing term to load the next billing term for

Returns:

the next billing term of the current billing term

Throws:

java.lang.Exception

loadInitial

public com.crm.dataobject.billing.CRMDOBillingTerm loadInitial(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm)
                                                        throws java.lang.Exception

Loads the initial version of a billing term.

Parameters:: billingTerm - - the billing term to load the initial version of
Returns:: the initial version of a billing term
Throws:: java.lang.Exception

loadLatest
```
public com.crm.dataobject.billing.CRMDOBillingTerm loadLatest(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                       throws java.lang.Exception
```
Loads the latest billing term version of a subscription.

Parameters:

subscription - - the subscription to load the latest billing term for

Returns:

the latest billing term of a subscription

Throws:

java.lang.Exception

loadLatest

public com.crm.dataobject.billing.CRMDOBillingTerm loadLatest(com.crm.dataobject.jobs.CRMDOJob job)
                                                       throws java.lang.Exception

Loads the latest billing term version of a job.

Parameters:: job - - the job to load the latest billing term for
Returns:: the latest billing term of a job
Throws:: java.lang.Exception

addBindingPeriod
```
public java.util.Date addBindingPeriod(java.util.Date date,
                                       com.crm.dataobject.billing.BindingPeriod bindingPeriod)
                                throws java.lang.Exception
```
Calculates the binding end date by a binding period.

Parameters:

date - - the date to calculate from

bindingPeriod - - the binding period to calculate with

Returns:

the binding end date by the given binding period

Throws:

java.lang.Exception

addBindingPeriod
```
public java.util.Date addBindingPeriod(java.util.Date date,
                                       com.crm.dataobject.billing.BindingPeriod bindingPeriod,
                                       com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition)
                                throws java.lang.Exception
```
Calculates the binding end date by a binding period and a billing term definition.

Parameters:

date - - the date to calculate from

bindingPeriod - - the binding period to calculate with

billingTermDefinition - - the billing term definition to calculate with

Returns:

the binding end date by the given binding period and billing term definition

Throws:

java.lang.Exception

addBillFrequency

public java.util.Date addBillFrequency(java.util.Date date,
                                       com.crm.dataobject.billing.BillingFrequency billingFrequency)
                                throws java.lang.Exception

Adds a billing frequency to a date.

Parameters:: date - - the date to add a billing frequency to; billingFrequency - - the billing frequency to add
Returns:: the calculated date
Throws:: java.lang.Exception

addBillFrequency

public java.util.Date addBillFrequency(java.util.Date date,
                                       com.crm.dataobject.billing.BillingFrequency billingFrequency,
                                       com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition)
                                throws java.lang.Exception

Adds a billing frequency to a date by a billing term definition.

Parameters:: date - - the date to add a billing frequency to; billingFrequency - - the billing frequency to add; billingTermDefinition - - the billing term definition to use
Returns:: the calculated date
Throws:: java.lang.Exception

getBindingState

public com.crm.dataobject.billing.BindingState getBindingState(com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                               java.util.Date date)
                                                        throws java.lang.Exception

Returns the binding state of a billing term.

Parameters:: billingTerm - - the billing term to get the binding state for; date - - the date to check the binding start date with
Returns:: the binding state of the given billing term
Throws:: java.lang.Exception

getBillingTermPeriods

public java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod> getBillingTermPeriods(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory subServicePeriod,
                                                                                               com.crm.dataobject.products.CRMDOProduct product,
                                                                                               java.util.Date rateFromDate,
                                                                                               com.crm.dataobject.billing.BindingState bindingState,
                                                                                               com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition,
                                                                                               java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans,
                                                                                               java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions,
                                                                                               java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment,
                                                                                               com.crm.dataobject.billing.BillType billType,
                                                                                               java.lang.Integer consumptionEstimationStep,
                                                                                               com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                        throws java.lang.Exception

Get billing term period based on subscription product and from date

Parameters:: subscription - - the subscription to get the billing term periods for; product - - the product to get the billing term periods for; rateFromDate - - the date to get the billing term periods for; bindingState - - the binding state of subscription service; billTermDefinition - - the active billing term definition; pricePlans - - the price plan configured in the system; autoApplyDiscountDefinitions - - the auto Apply Discount Definitions configured in the system; entityIDsPerSegment - - all entity id's of all segments
Returns:: the billing term periods
Throws:: java.lang.Exception

getBillingTermPeriods

public java.util.ArrayList<com.crm.dataobject.billing.BillingTermPeriod> getBillingTermPeriods(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService,
                                                                                               com.crm.dataobject.subscriptions.CRMDOSubServiceLifeCycleStateHistory subServicePeriod,
                                                                                               com.crm.dataobject.products.CRMDOProduct product,
                                                                                               java.util.Date rateFromDate,
                                                                                               java.util.Date rateToDate,
                                                                                               com.crm.dataobject.billing.BindingState bindingState,
                                                                                               com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition,
                                                                                               java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans,
                                                                                               java.util.ArrayList<com.crm.dataobject.CRMDO> autoApplyDiscountDefinitions,
                                                                                               java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> entityIDsPerSegment,
                                                                                               com.crm.dataobject.billing.BillType billType,
                                                                                               java.lang.Integer consumptionEstimationStep,
                                                                                               com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                        throws java.lang.Exception

Get billing term periods based on subscription product and from date range (rateFromDate - rateToDate)

Parameters:: subscription - - the subscription to get the billing term periods for; product - - the product to get the billing term periods for; rateFromDate - - the date to get the billing term periods for; bindingState - - the binding state of subscription service; billTermDefinition - - the active billing term definition; pricePlans - - the price plan configured in the system; autoApplyDiscountDefinitions - - the auto Apply Discount Definitions configured in the system; entityIDsPerSegment - - all entity id's of all segments
Returns:: the billing term periods
Throws:: java.lang.Exception