com.crm.businessobject.subscriptions

Class CRMBOSubscriptionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOMasterEntity

com.crm.businessobject.subscriptions.CRMBOSubscriptionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOSubscriptionBean
extends CRMBOMasterEntity

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	SUBSCRIPTION_ENTITY_ID
java.lang.String	SUBSCRIPTION_MAINTAIN_FEATURE_ID
java.lang.String	SUBSCRIPTION_MODULE_ID

Constructor Summary

Constructors

Constructor and Description
CRMBOSubscriptionBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.subscriptions.CRMDOSubscription	activate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Activates a subscription using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	bill(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingRun billingRun) Bills a subscription based on a billing run.
com.crm.dataobject.subscriptions.CRMDOSubscription	bill(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingRunDefinition activeBRDefinition) Bills a subscription based on a billing run and billing run definition.
java.math.BigDecimal	calculateUnsettledAmount(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
com.crm.dataobject.subscriptions.CRMDOSubscription	cancel(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction) Cancels a subscription using a subscription action.
com.crm.dataobject.subscriptions.CRMDOSubscription	deactivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Deactivates a subscription using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	endShortTermActivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Ends the short term activation of a subscription using a subscription action and a scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	endShortTermDeactivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Ends the short term deactivation of a subscription using a subscription action and a scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	extendGracePeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate, java.util.Date endPeriodDate) Extends the grace period of a subscription using a subscription action and a scheduled date.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a subscription.
java.util.Date	getEffectiveDate(java.lang.String subID) Returns the effective date of a subscription.
java.util.Date	getExpirationDate(java.lang.String subID) Returns the Expiration date of a subscription.
java.util.Date	getGracePeriodEndDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the grace period end date of a subscription.
java.util.Date	getLatestDeactivationDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the latest deactivation date of a subscription.
java.util.Date	getLatestRatedToDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the latest rated to date of a subscription.
com.crm.dataobject.subscriptions.SubscriptionLifeCycleState	getLifeCycleState(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date date) Returns the life cycle state of a subscription on a given date.
com.crm.dataobject.subscriptions.CRMDOSubLifeCycleStateHistory	getLifeCycleStateHistory(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date date) Returns the life cycle state history of a subscription on a given date.
java.lang.Integer	getMaturityDays(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate)
java.lang.Integer	getNumberOfDaysInGrace(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of days a subscription was in grace between two dates.
java.lang.Integer	getNumberOfDaysInResting(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of days a subscription was in resting between two dates.
java.lang.Integer	getNumberOfDaysInShortTermActivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of days a subscription was in short term activation between two dates.
java.lang.Integer	getNumberOfDaysInShortTermDeactivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of days a subscription was in short term deactivation between two dates.
java.lang.Integer	getNumberOfSubscriberPerAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.subscriptions.CRMDOSubscription excludeSubscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, com.crm.dataobject.subscriptions.SubscriptionLifeCycleState subLifeCycleState, java.util.ArrayList<com.crm.dataobject.subscriptions.SubscriptionLifeCycleState> excludeLifeCycleStates, java.util.Date scheduledDate, java.lang.Boolean isPrepaid) Returns the number of subscriptions per account excluding a subscription and life cycle state, based on a subscription type, life cycle state, scheduled date and if the subscription is prepaid.
java.lang.Integer	getNumberOfSubscriberPerAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.subscriptions.CRMDOSubscription excludeSubscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, com.crm.dataobject.subscriptions.SubscriptionLifeCycleState subLifeCycleState, com.crm.dataobject.subscriptions.SubscriptionLifeCycleState excludeLifeCycleState, java.util.Date scheduledDate, java.lang.Boolean isPrepaid) Returns the number of subscriptions per account excluding a subscription and life cycle state, based on a subscription type, life cycle state, scheduled date and if the subscription is prepaid.
java.lang.Integer	getNumberOfTimesInGrace(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of times a subscription was in grace between two dates.
java.lang.Integer	getNumberOfTimesInResting(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of times a subscription was in resting between two dates.
java.lang.Integer	getNumberOfTimesInShortTermActivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of times a subscription was in short term activation between two dates.
java.lang.Integer	getNumberOfTimesInShortTermDeactivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date fromDate, java.util.Date toDate) Returns the number of times a subscription was in short term deactivation between two dates.
java.util.Date	getSubscriptionLatestEffectiveDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date scheduledDate) Returns the latest effective date of a subscription.
java.util.Date	getSubscriptionLatestNotEffectiveDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date scheduledDate) Returns the latest not effective date of a subscription.
java.lang.Boolean	hasScheduledAction(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
java.lang.Boolean	isBillingAddressRuleCriterionValid(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.accounts.BillingAddressRules billingAddressRules) Checks if the Accounts Receivable is used by a subscription of a specific type and billing term scheme
java.lang.Boolean	isInGracePeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
java.lang.Boolean	isInGracePeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date asOfDate)
java.lang.Boolean	isNeverActivated(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Checks if a subscription has never been activated.
java.lang.Boolean	isNonBilledServicesExists(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date scheduledDate)
java.lang.Boolean	isPrepaid(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns true if the subscription billing term is prepaid.
java.lang.Boolean	isUsedByDraftCommunication(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Checks if the subscription is used by a draft communication.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Loads a list of subscriptions of an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.ArrayList<java.lang.String> associations) Loads a list of subscriptions of an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.subscriptions.CRMDOSubscription excludeSubscription) Loads a list of subscriptions of an account excluding a subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, java.util.ArrayList<java.lang.String> associations) Loads a list of subscriptions of an account and subscription type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType, com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.ArrayList<java.lang.String> associations) Loads a list of subscriptions of an account and subscription type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress contactInfoAddress) Loads a list of subscriptions of an address.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a list of subscriptions of a contact.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadAccountReceivable(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the account of a subscription.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadAdditionalInformation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Loads additional information of a subscription.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Loads a list of subscriptions of an account for billing.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.BillType billType) Loads a list of subscriptions of an account for billing by a bill type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.BillType billType, java.util.ArrayList<java.lang.String> associations) Loads a list of subscriptions of an account for billing by a bill type.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadByNumber(java.lang.String number) Loads a subscription by a number.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a subscription by a number.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadEffectiveDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the effective date of a subscription.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadExpirationDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the expiration date of a subscription.
com.crm.dataobject.subscriptions.CRMDOSubscription	loadLifecycleState(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Returns the life cycle state of a subscription.
java.lang.Boolean	preRatedServiceExists(com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Checks if a subscription service of Pre Rate billing type exists for the given subscription
com.crm.dataobject.subscriptions.CRMDOSubscription	rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDONormalBillingRun normalBillingRun) Rates a subscription using a normal billing run.
com.crm.dataobject.subscriptions.CRMDOSubscription	rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDONormalBillingRun normalBillingRun, com.crm.dataobject.billing.CRMDONormalBillingRunDefinition normalBRDefinition, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, com.crm.dataobject.billing.CRMDOUsageServiceCatalogDefinition serviceCatalogDefinition, java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageServiceCatalog> usageServiceCatalogs) Rates a subscription using a normal billing run, normal billing run definition, a billing term definition and a list of price plans.
com.crm.dataobject.subscriptions.CRMDOSubscription	rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, com.crm.dataobject.wallets.CRMDOWallet wallet, java.util.ArrayList<com.crm.dataobject.billing.CRMDOUdr> udrs) Rates a subscription using a prepaid billing run.
com.crm.dataobject.subscriptions.CRMDOSubscription	rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun) Rates a subscription using a prepaid billing run.
com.crm.dataobject.subscriptions.CRMDOSubscription	rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun, com.crm.dataobject.billing.CRMDOPrepaidBillingRunDefinition prepaidBRDefinition, com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition, com.crm.dataobject.subscriptions.CRMDOSubscriptionDefinition subscriptionDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans, com.crm.dataobject.billing.CRMDOUsageServiceCatalogDefinition serviceCatalogDefinition) Rate a subscription by prepaid billing run - load and rate udrs and subtract the amount from wallet - load all subscription services with order (based on tiers) - rate service and subtract the amount from wallet - if its configure to stop service and wallet amount is not enough then create deactivate subscription action
com.crm.dataobject.subscriptions.CRMDOSubscription	reactivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Reactivates a subscription using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	regret(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction) Regrets a subscription using a subscription action.
com.crm.dataobject.subscriptions.CRMDOSubscription	rest(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Rests a subscription using a subscription action and a scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	setAsActive(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Activate a subscription using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	setLifeCycleState(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, com.crm.dataobject.subscriptions.SubscriptionLifeCycleState lifeCycleState, java.util.Date scheduledDate) Sets the life cycle state of a subscription using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	shortTermActivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Activates a subscription for a short and predefined period of time using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	shortTermDeactivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Deactivates a subscription for a short and predefined period of time using a subscription action and scheduled date.
com.crm.dataobject.subscriptions.CRMDOSubscription	unRest(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date scheduledDate) Ends the resting of a subscription using a subscription action and a scheduled date.

Methods inherited from class com.crm.businessobject.CRMBOMasterEntity

setLifeCycleState

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, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, 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

Field Detail

SUBSCRIPTION_MODULE_ID

public final java.lang.String SUBSCRIPTION_MODULE_ID

See Also:

Constant Field Values

SUBSCRIPTION_MAINTAIN_FEATURE_ID

public final java.lang.String SUBSCRIPTION_MAINTAIN_FEATURE_ID

See Also:

Constant Field Values

SUBSCRIPTION_ENTITY_ID

public final java.lang.String SUBSCRIPTION_ENTITY_ID

See Also:

Constant Field Values

Constructor Detail

CRMBOSubscriptionBean

public CRMBOSubscriptionBean()

Default constructor.

Method Detail

isBillingAddressRuleCriterionValid

public java.lang.Boolean isBillingAddressRuleCriterionValid(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                            com.crm.dataobject.accounts.BillingAddressRules billingAddressRules)
                                                     throws java.lang.Exception

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

Parameters:

subscription - - the Accounts Receivable to check

billingAddressRules - - the billing address rule object that will define the types and schemes to be checked

Returns:

true if the Accounts Receivable is used by a job of a specific type and scheme, false if not

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a subscription.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the subscription

loadByNumber

public com.crm.dataobject.subscriptions.CRMDOSubscription loadByNumber(java.lang.String number)
                                                                throws java.lang.Exception

Loads a subscription by a number.

Parameters:

number - - the number to load by

Returns:

a subscription with the given number

Throws:

java.lang.Exception

load

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

Loads a list of subscriptions of an address.

Parameters:

contactInfoAddress - - the address to load the subscriptions for

Returns:

a list of subscriptions of the given address

Throws:

java.lang.Exception

load

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

Loads a list of subscriptions of a contact.

Parameters:

contactInformation - - the contact to load the subscriptions for

Returns:

a list of subscriptions of the given contact

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                   throws java.lang.Exception

Loads a list of subscriptions of an account.

Parameters:

accountReceivable - - the account to load the subscriptions for

Returns:

a list of subscriptions of the given account

Throws:

java.lang.Exception

load

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

Loads a list of subscriptions of an account and subscription type.

Parameters:

accountReceivable - - the account to load the subscriptions for

subscriptionType - - the subscription type

associations - - a list of associated data objects

Returns:

a list of subscriptions of the given account and subscription type

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType,
                                                          com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of subscriptions of an account and subscription type.

Parameters:

accountReceivable - - the account to load the subscriptions for

subscriptionType - - the subscription type

wallet - - the wallet

associations - - a list of associated data objects

Returns:

a list of subscriptions of the given account and subscription type

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                          com.crm.dataobject.subscriptions.CRMDOSubscription excludeSubscription)
                                                   throws java.lang.Exception

Loads a list of subscriptions of an account excluding a subscription.

Parameters:

account - - the account to load the subscriptions for

excludeSubscription - - the subscription to exclude

Returns:

a list of subscriptions of the given account excluding the given subscription

Throws:

java.lang.Exception

cancel

public com.crm.dataobject.subscriptions.CRMDOSubscription cancel(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
                                                          throws java.lang.Exception

Cancels a subscription using a subscription action.

Parameters:

subscription - - the subscription to cancel

subscriptionAction - - the subscription action to use

Returns:

the cancelled subscription

Throws:

java.lang.Exception

regret

public com.crm.dataobject.subscriptions.CRMDOSubscription regret(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
                                                          throws java.lang.Exception

Regrets a subscription using a subscription action.

Parameters:

subscription - - the subscription to regret

subscriptionAction - - the subscription action to use

Returns:

the regretted subscription

Throws:

java.lang.Exception

reactivate

public com.crm.dataobject.subscriptions.CRMDOSubscription reactivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                     com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                     java.util.Date scheduledDate)
                                                              throws java.lang.Exception

Reactivates a subscription using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to reactivate

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the reactivation

Returns:

the reactivated subscription

Throws:

java.lang.Exception

setAsActive

public com.crm.dataobject.subscriptions.CRMDOSubscription setAsActive(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                      com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                      java.util.Date scheduledDate)
                                                               throws java.lang.Exception

Activate a subscription using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to activate

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the activation

Returns:

the activated subscription

Throws:

java.lang.Exception

getSubscriptionLatestNotEffectiveDate

public java.util.Date getSubscriptionLatestNotEffectiveDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                            java.util.Date scheduledDate)
                                                     throws java.lang.Exception

Returns the latest not effective date of a subscription.

Parameters:

subscription - - the subscription to retrieve the date

scheduledDate - - the scheduled date to retrieve the date

Returns:

the latest not effective date of the given subscription

Throws:

java.lang.Exception

getSubscriptionLatestEffectiveDate

public java.util.Date getSubscriptionLatestEffectiveDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                         java.util.Date scheduledDate)
                                                  throws java.lang.Exception

Returns the latest effective date of a subscription.

Parameters:

subscription - - the subscription to retrieve the date

scheduledDate - - the performed date to retrieve the date

Returns:

the latest effective date of the given subscription

Throws:

java.lang.Exception

activate

public com.crm.dataobject.subscriptions.CRMDOSubscription activate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                   com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                   java.util.Date scheduledDate)
                                                            throws java.lang.Exception

Activates a subscription using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to activate

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the activation

Returns:

the activated subscription

Throws:

java.lang.Exception

deactivate

public com.crm.dataobject.subscriptions.CRMDOSubscription deactivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                     com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                     java.util.Date scheduledDate)
                                                              throws java.lang.Exception

Deactivates a subscription using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to deactivate

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the deactivation

Returns:

the deactivated subscription

Throws:

java.lang.Exception

shortTermDeactivate

public com.crm.dataobject.subscriptions.CRMDOSubscription shortTermDeactivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                              com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                              java.util.Date scheduledDate)
                                                                       throws java.lang.Exception

Deactivates a subscription for a short and predefined period of time using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to deactivate

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the short term deactivation

Returns:

the deactivated subscription

Throws:

java.lang.Exception

setLifeCycleState

public com.crm.dataobject.subscriptions.CRMDOSubscription setLifeCycleState(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                            com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                            com.crm.dataobject.subscriptions.SubscriptionLifeCycleState lifeCycleState,
                                                                            java.util.Date scheduledDate)
                                                                     throws java.lang.Exception

Sets the life cycle state of a subscription using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to set the life cycle state

subscriptionAction - - the subscription action to use

lifeCycleState - - the life cycle state to set

scheduledDate - - the date to schedule the life cycle state change

Returns:

the updated subscription

Throws:

java.lang.Exception

getLifeCycleState

public com.crm.dataobject.subscriptions.SubscriptionLifeCycleState getLifeCycleState(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                     java.util.Date date)
                                                                              throws java.lang.Exception

Returns the life cycle state of a subscription on a given date.

Parameters:

subscription - - the subscription to return the life cycle state from

date - - the date on which to return the subscription's life cycle state

Returns:

the life cycle state of a subscription on the given date

Throws:

java.lang.Exception

getLifeCycleStateHistory

public com.crm.dataobject.subscriptions.CRMDOSubLifeCycleStateHistory getLifeCycleStateHistory(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                               java.util.Date date)
                                                                                        throws java.lang.Exception

Returns the life cycle state history of a subscription on a given date.

Parameters:

subscription - - the subscription to return the life cycle state history from

date - - the date on which to return the subscription's life cycle state history

Returns:

the life cycle state history of a subscription on the given date

Throws:

java.lang.Exception

getNumberOfDaysInResting

public java.lang.Integer getNumberOfDaysInResting(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                  java.util.Date fromDate,
                                                  java.util.Date toDate)
                                           throws java.lang.Exception

Returns the number of days a subscription was in resting between two dates.

Parameters:

subscription - - the subscription to return the number of days in resting for

fromDate - - the from date

toDate - - the to date

Returns:

the number of days a subscription was in resting between the two given dates

Throws:

java.lang.Exception

getNumberOfTimesInResting

public java.lang.Integer getNumberOfTimesInResting(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                   java.util.Date fromDate,
                                                   java.util.Date toDate)
                                            throws java.lang.Exception

Returns the number of times a subscription was in resting between two dates.

Parameters:

subscription - - the subscription to return the number of times in resting for

fromDate - - the from date

toDate - - the to date

Returns:

the number of times a subscription was in resting between the two given dates

Throws:

java.lang.Exception

getNumberOfTimesInGrace

public java.lang.Integer getNumberOfTimesInGrace(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 java.util.Date fromDate,
                                                 java.util.Date toDate)
                                          throws java.lang.Exception

Returns the number of times a subscription was in grace between two dates.

Parameters:

subscription - - the subscription to return the number of times in grace for

fromDate - - the from date

toDate - - the to date

Returns:

the number of times a subscription was in grace between the two given dates

Throws:

java.lang.Exception

getNumberOfDaysInGrace

public java.lang.Integer getNumberOfDaysInGrace(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                java.util.Date fromDate,
                                                java.util.Date toDate)
                                         throws java.lang.Exception

Returns the number of days a subscription was in grace between two dates.

Parameters:

subscription - - the subscription to return the number of days in grace for

fromDate - - the from date

toDate - - the to date

Returns:

the number of days a subscription was in grace between the two given dates

Throws:

java.lang.Exception

isInGracePeriod

public java.lang.Boolean isInGracePeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isInGracePeriod

public java.lang.Boolean isInGracePeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                         java.util.Date asOfDate)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

hasScheduledAction

public java.lang.Boolean hasScheduledAction(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getNumberOfDaysInShortTermActivation

public java.lang.Integer getNumberOfDaysInShortTermActivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                              java.util.Date fromDate,
                                                              java.util.Date toDate)
                                                       throws java.lang.Exception

Returns the number of days a subscription was in short term activation between two dates.

Parameters:

subscription - - the subscription to return the number of days in short term activation for

fromDate - - the from date

toDate - - the to date

Returns:

the number of days a subscription was in short term activation between the two given dates

Throws:

java.lang.Exception

getNumberOfTimesInShortTermActivation

public java.lang.Integer getNumberOfTimesInShortTermActivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               java.util.Date fromDate,
                                                               java.util.Date toDate)
                                                        throws java.lang.Exception

Returns the number of times a subscription was in short term activation between two dates.

Parameters:

subscription - - the subscription to return the number of times in short term activation for

fromDate - - the from date

toDate - - the to date

Returns:

the number of times a subscription was in short term activation between the two given dates

Throws:

java.lang.Exception

getNumberOfDaysInShortTermDeactivation

public java.lang.Integer getNumberOfDaysInShortTermDeactivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                java.util.Date fromDate,
                                                                java.util.Date toDate)
                                                         throws java.lang.Exception

Returns the number of days a subscription was in short term deactivation between two dates.

Parameters:

subscription - - the subscription to return the number of days in short term deactivation for

fromDate - - the from date

toDate - - the to date

Returns:

the number of days a subscription was in short term deactivation between the two given dates

Throws:

java.lang.Exception

getNumberOfTimesInShortTermDeactivation

public java.lang.Integer getNumberOfTimesInShortTermDeactivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 java.util.Date fromDate,
                                                                 java.util.Date toDate)
                                                          throws java.lang.Exception

Returns the number of times a subscription was in short term deactivation between two dates.

Parameters:

subscription - - the subscription to return the number of times in short term deactivation for

fromDate - - the from date

toDate - - the to date

Returns:

the number of times a subscription was in short term deactivation between the two given dates

Throws:

java.lang.Exception

getNumberOfSubscriberPerAccount

public java.lang.Integer getNumberOfSubscriberPerAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         com.crm.dataobject.subscriptions.CRMDOSubscription excludeSubscription,
                                                         com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType,
                                                         com.crm.dataobject.subscriptions.SubscriptionLifeCycleState subLifeCycleState,
                                                         com.crm.dataobject.subscriptions.SubscriptionLifeCycleState excludeLifeCycleState,
                                                         java.util.Date scheduledDate,
                                                         java.lang.Boolean isPrepaid)
                                                  throws java.lang.Exception

Returns the number of subscriptions per account excluding a subscription and life cycle state, based on a subscription type, life cycle state, scheduled date and if the subscription is prepaid.

Parameters:

account - - the account to return the number of subscriptions for

excludeSubscription - - the subscription to exclude

subscriptionType - - the subscription type to use

subLifeCycleState - - the subscription life cycle state to use

excludeLifeCycleState - - the subscription life cycle state to exclude

scheduledDate - - the scheduled date

isPrepaid - - a boolean indicating if the subscription is prepaid or not

Returns:

the number of subscriptions per account based on the given parameters

Throws:

java.lang.Exception

getNumberOfSubscriberPerAccount

public java.lang.Integer getNumberOfSubscriberPerAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         com.crm.dataobject.subscriptions.CRMDOSubscription excludeSubscription,
                                                         com.crm.dataobject.subscriptions.CRMDOSubscriptionType subscriptionType,
                                                         com.crm.dataobject.subscriptions.SubscriptionLifeCycleState subLifeCycleState,
                                                         java.util.ArrayList<com.crm.dataobject.subscriptions.SubscriptionLifeCycleState> excludeLifeCycleStates,
                                                         java.util.Date scheduledDate,
                                                         java.lang.Boolean isPrepaid)
                                                  throws java.lang.Exception

Returns the number of subscriptions per account excluding a subscription and life cycle state, based on a subscription type, life cycle state, scheduled date and if the subscription is prepaid.

Parameters:

account - - the account to return the number of subscriptions for

excludeSubscription - - the subscription to exclude

subscriptionType - - the subscription type to use

subLifeCycleState - - the subscription life cycle state to use

excludeLifeCycleStates - - the subscription life cycle states to exclude

scheduledDate - - the scheduled date

isPrepaid - - a boolean indicating if the subscription is prepaid or not

Returns:

the number of subscriptions per account based on the given parameters

Throws:

java.lang.Exception

rate

public com.crm.dataobject.subscriptions.CRMDOSubscription rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.billing.CRMDONormalBillingRun normalBillingRun)
                                                        throws java.lang.Exception

Rates a subscription using a normal billing run.

Parameters:

subscription - - the subscription to rate

normalBillingRun - - the normal billing run to use

Returns:

the updated subscription

Throws:

java.lang.Exception

rate

public com.crm.dataobject.subscriptions.CRMDOSubscription rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.billing.CRMDONormalBillingRun normalBillingRun,
                                                               com.crm.dataobject.billing.CRMDONormalBillingRunDefinition normalBRDefinition,
                                                               com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition,
                                                               java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans,
                                                               com.crm.dataobject.billing.CRMDOUsageServiceCatalogDefinition serviceCatalogDefinition,
                                                               java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageServiceCatalog> usageServiceCatalogs)
                                                        throws java.lang.Exception

Rates a subscription using a normal billing run, normal billing run definition, a billing term definition and a list of price plans.

Parameters:

subscription - - the subscription to rate

normalBillingRun - - the normal billing run to use

normalBRDefinition - - the normal billing run definition to use

billTermDefinition - - the billing term definition to use

pricePlans - - a list of price plans to use

Returns:

the updated subscription

Throws:

java.lang.Exception

bill

public com.crm.dataobject.subscriptions.CRMDOSubscription bill(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.billing.CRMDOBillingRun billingRun)
                                                        throws java.lang.Exception

Bills a subscription based on a billing run.

Parameters:

subscription - - the subscription to bill

billingRun - - the billing run to use

Returns:

the updated subscription

Throws:

java.lang.Exception

bill

public com.crm.dataobject.subscriptions.CRMDOSubscription bill(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                               com.crm.dataobject.billing.CRMDOBillingRunDefinition activeBRDefinition)
                                                        throws java.lang.Exception

Bills a subscription based on a billing run and billing run definition.

Parameters:

subscription - - the subscription to bill

billingRun - - the billing run to use

activeBRDefinition - - the active billing run definition to use

Returns:

the updated subscription

Throws:

java.lang.Exception

getLatestDeactivationDate

public java.util.Date getLatestDeactivationDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                         throws java.lang.Exception

Returns the latest deactivation date of a subscription.

Parameters:

subscription - - the subscription to check

Returns:

the latest deactivation date of the given subscription

Throws:

java.lang.Exception

isNeverActivated

public java.lang.Boolean isNeverActivated(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                   throws java.lang.Exception

Checks if a subscription has never been activated.

Parameters:

subscription - - the subscription to check

Returns:

true if a subscription has never been activated, false if not

Throws:

java.lang.Exception

loadByNumber

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

Loads a subscription by a number.

Parameters:

number - - the subscription number

associations - - a list of associated data objects

Returns:

a subscription with the given number

Throws:

java.lang.Exception

load

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

Loads a list of subscriptions of an account.

Parameters:

account - - the accout to load the subscriptions for

associations - - a list of associated data objects

Returns:

a list of subscriptions of the given account

Throws:

java.lang.Exception

getLatestRatedToDate

public java.util.Date getLatestRatedToDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                    throws java.lang.Exception

Returns the latest rated to date of a subscription.

Parameters:

subscription - - the subscription to return the latest rated to date for

Returns:

the latest rated to date of the given subscription

Throws:

java.lang.Exception

getGracePeriodEndDate

public java.util.Date getGracePeriodEndDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                     throws java.lang.Exception

Returns the grace period end date of a subscription.

Parameters:

subscription - - the subscription to return the grace period end date for

Returns:

the grace period end date of the given subscription

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                           throws java.lang.Exception

Loads a list of subscriptions of an account for billing.

Parameters:

account - - the account to load the subscriptions for

Returns:

a list of subscriptions of the given account

Throws:

java.lang.Exception

loadBillable

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

Loads a list of subscriptions of an account for billing by a bill type.

Parameters:

account - - the account to load the subscriptions for

billingRun - - the billingRun to bill subscription

billType - - the billType to use

Returns:

a list of subscriptions of the given account and bill type

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                  com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                                                  com.crm.dataobject.billing.BillType billType,
                                                                  java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads a list of subscriptions of an account for billing by a bill type.

Parameters:

account - - the account to load the subscriptions for

billingRun - - the billingRun to bill subscription

billType - - the bill type to use

associations - - a list of associated data objects

Returns:

a list of subscriptions of the given account and bill type

Throws:

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.subscriptions.CRMDOSubscription loadAdditionalInformation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                                             throws java.lang.Exception

Loads additional information of a subscription.
- loads the life cycle state
- loads the effective date
- loads the Accounts Receivable

Parameters:

subscription - - the subscription to load the additional information for

Returns:

the updated subscription

Throws:

java.lang.Exception

loadAccountReceivable

public com.crm.dataobject.subscriptions.CRMDOSubscription loadAccountReceivable(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                                         throws java.lang.Exception

Returns the account of a subscription.

Parameters:

subscription - - the subscription to return the account for

Returns:

the account of the given subscription

Throws:

java.lang.Exception

loadEffectiveDate

public com.crm.dataobject.subscriptions.CRMDOSubscription loadEffectiveDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                                     throws java.lang.Exception

Returns the effective date of a subscription.

Parameters:

subscription - - the subscription to return the effective date for

Returns:

the effective date of the given subscription

Throws:

java.lang.Exception

loadExpirationDate

public com.crm.dataobject.subscriptions.CRMDOSubscription loadExpirationDate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                                      throws java.lang.Exception

Returns the expiration date of a subscription.

Parameters:

subscription - - the subscription to return the expiration date for

Returns:

the expiration date of the given subscription

Throws:

java.lang.Exception

loadLifecycleState

public com.crm.dataobject.subscriptions.CRMDOSubscription loadLifecycleState(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                                                      throws java.lang.Exception

Returns the life cycle state of a subscription.

Parameters:

subscription - - the subscription to return the life cycle state for

Returns:

the life cycle state of the given subscription

Throws:

java.lang.Exception

getEffectiveDate

public java.util.Date getEffectiveDate(java.lang.String subID)
                                throws java.lang.Exception

Returns the effective date of a subscription.

Parameters:

subID - - the subscription id to return the effective date for

Returns:

the effective date of the given subscription

Throws:

java.lang.Exception

getExpirationDate

public java.util.Date getExpirationDate(java.lang.String subID)
                                 throws java.lang.Exception

Returns the Expiration date of a subscription.

Parameters:

subID - - the subscription id to return the Expiration date for

Returns:

the Expiration date of the given subscription

Throws:

java.lang.Exception

isPrepaid

public java.lang.Boolean isPrepaid(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                            throws java.lang.Exception

Returns true if the subscription billing term is prepaid.

Parameters:

subscription - - the subscription to use

Returns:

true if the subscription billing term is prepaid, false if not

Throws:

java.lang.Exception

rate

public com.crm.dataobject.subscriptions.CRMDOSubscription rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                               com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                               java.util.ArrayList<com.crm.dataobject.billing.CRMDOUdr> udrs)
                                                        throws java.lang.Exception

Rates a subscription using a prepaid billing run.
- loads all subscription services in order (based on tiers)
- rates services and subtracts the amount from the wallet
- if it's configured to stop the service and the wallet amount is not enough then create a deactivate subscription action

Parameters:

subscription - - the subscription to rate

wallet - - the related subscription wallet

Returns:

the updated subscription

Throws:

java.lang.Exception

rate

public com.crm.dataobject.subscriptions.CRMDOSubscription rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                               com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun)
                                                        throws java.lang.Exception

Rates a subscription using a prepaid billing run.
- loads all subscription services in order (based on tiers)
- rates services and subtracts the amount from the wallet
- if it's configured to stop the service and the wallet amount is not enough then create a deactivate subscription action

Parameters:

subscription - - the subscription to rate

wallet - - the related subscription wallet

prepaidBillingRun - - the billing run to rate the subscription with

Returns:

the updated subscription

Throws:

java.lang.Exception

rate

public com.crm.dataobject.subscriptions.CRMDOSubscription rate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                               com.crm.dataobject.billing.CRMDOPrepaidBillingRun prepaidBillingRun,
                                                               com.crm.dataobject.billing.CRMDOPrepaidBillingRunDefinition prepaidBRDefinition,
                                                               com.crm.dataobject.billing.CRMDOBillingTermDefinition billTermDefinition,
                                                               com.crm.dataobject.subscriptions.CRMDOSubscriptionDefinition subscriptionDefinition,
                                                               java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans,
                                                               com.crm.dataobject.billing.CRMDOUsageServiceCatalogDefinition serviceCatalogDefinition)
                                                        throws java.lang.Exception

Rate a subscription by prepaid billing run - load and rate udrs and subtract the amount from wallet - load all subscription services with order (based on tiers) - rate service and subtract the amount from wallet - if its configure to stop service and wallet amount is not enough then create deactivate subscription action

Parameters:

subscription - - the subscription to rate

wallet - - the related subscription wallet

prepaidBillingRun - - the billing run to rate the subscription with

prepaidBRDefinition - - the active prepaid billing run definition

billTermDefinition - - the active billing term definition

pricePlans - - a list of all priceplans configure in the system

Returns:

a subscription

Throws:

java.lang.Exception

preRatedServiceExists

public java.lang.Boolean preRatedServiceExists(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)

Checks if a subscription service of Pre Rate billing type exists for the given subscription

Parameters:

subscription - - the subscription to check

Returns:

true if exists, false if not

isUsedByDraftCommunication

public java.lang.Boolean isUsedByDraftCommunication(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                             throws java.lang.Exception

Checks if the subscription is used by a draft communication.

Parameters:

subscription - - the subscription to check

Returns:

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

Throws:

java.lang.Exception

rest

public com.crm.dataobject.subscriptions.CRMDOSubscription rest(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                               com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                               java.util.Date scheduledDate)
                                                        throws java.lang.Exception

Rests a subscription using a subscription action and a scheduled date.

Parameters:

subscription - - the subscription to rest

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the action

Returns:

the subscription in resting

Throws:

java.lang.Exception

unRest

public com.crm.dataobject.subscriptions.CRMDOSubscription unRest(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                 com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                 java.util.Date scheduledDate)
                                                          throws java.lang.Exception

Ends the resting of a subscription using a subscription action and a scheduled date.

Parameters:

subscription - - the subscription to unrest

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the action

Returns:

the updated subscription

Throws:

java.lang.Exception

endShortTermDeactivation

public com.crm.dataobject.subscriptions.CRMDOSubscription endShortTermDeactivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                   com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                                   java.util.Date scheduledDate)
                                                                            throws java.lang.Exception

Ends the short term deactivation of a subscription using a subscription action and a scheduled date.

Parameters:

subscription - - the subscription to end short term deactivation

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the action

Returns:

the updated subscription

Throws:

java.lang.Exception

extendGracePeriod

public com.crm.dataobject.subscriptions.CRMDOSubscription extendGracePeriod(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                            com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                            java.util.Date scheduledDate,
                                                                            java.util.Date endPeriodDate)
                                                                     throws java.lang.Exception

Extends the grace period of a subscription using a subscription action and a scheduled date.

Parameters:

subscription - - the subscription to extend grace period

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the action

Returns:

the updated subscription

Throws:

java.lang.Exception

getMaturityDays

public java.lang.Integer getMaturityDays(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                         java.util.Date fromDate,
                                         java.util.Date toDate)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

shortTermActivate

public com.crm.dataobject.subscriptions.CRMDOSubscription shortTermActivate(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                            com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                            java.util.Date scheduledDate)
                                                                     throws java.lang.Exception

Activates a subscription for a short and predefined period of time using a subscription action and scheduled date.

Parameters:

subscription - - the subscription to activate

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the short term activation

Returns:

the deactivated subscription

Throws:

java.lang.Exception

endShortTermActivation

public com.crm.dataobject.subscriptions.CRMDOSubscription endShortTermActivation(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                                                 com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                                 java.util.Date scheduledDate)
                                                                          throws java.lang.Exception

Ends the short term activation of a subscription using a subscription action and a scheduled date.

Parameters:

subscription - - the subscription to end short term activation

subscriptionAction - - the subscription action to use

scheduledDate - - the scheduled date of the action

Returns:

the updated subscription

Throws:

java.lang.Exception

isNonBilledServicesExists

public java.lang.Boolean isNonBilledServicesExists(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                   java.util.Date scheduledDate)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

calculateUnsettledAmount

public java.math.BigDecimal calculateUnsettledAmount(com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                              throws java.lang.Exception

Throws:

java.lang.Exception