com.crm.businessobject.billing

Class CRMBOAdHocDiscountBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.billing.CRMBOAdHocDiscountBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOAdHocDiscountBean
extends CRMBO

Session Bean implementation class CRMBOAdHocDiscountBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOAdHocDiscountBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.billing.CRMDOAdHocDiscount	approve(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount) Sets the life cycle state of an ad hoc discount to approved
com.crm.dataobject.billing.CRMDOAdHocDiscount	approve(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount, java.util.Date approvedOn, com.crm.dataobject.users.CRMDOUser approvedByUser) Sets the life cycle state of an ad hoc discount to approved
com.crm.dataobject.billing.CRMDOAdHocDiscount	calculateApplied(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount) Calculates the ad hoc discount applied fields
com.crm.dataobject.billing.CRMDOAdHocDiscount	cancel(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount, java.util.Date cancelledOn, com.crm.dataobject.users.CRMDOUser cancelledByUser) Sets the life cycle state of an ad hoc discount to cancelled
com.crm.dataobject.billing.CRMDOAdHocDiscount	copyDefaultInformationFromDefinition(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount, com.crm.dataobject.billing.CRMDOAdditiveDiscountDefinition definition) Copies the default information of the additive discount definition to the ad hoc discount
java.util.ArrayList<com.crm.dataobject.billing.AdditiveDiscountPeriod>	getAdHocDiscountPeriods(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, java.util.Date asOfDate)
java.util.ArrayList<com.crm.dataobject.billing.AdditiveDiscountPeriod>	getAdHocDiscountPeriods(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, com.crm.dataobject.billing.CRMDOBuyInAdvanceRequest buyInAdvanceRequest, java.util.Date asOfDate)
java.util.ArrayList<com.crm.dataobject.billing.AdditiveDiscountPeriod>	getAdHocDiscountPeriods(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService, com.crm.dataobject.billing.CRMDOBillingTerm billingTerm, java.util.Date asOfDate)
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of an additive discount definition.
java.lang.Boolean	isApplied(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount) Checks if the ad hoc discount has been applied.
java.lang.Boolean	isIncludedInApprovalAuthorizations(java.util.Set<com.crm.dataobject.networkmanagement.UserUnitCriterion> userUnitCriteria, com.crm.dataobject.users.CRMDOUser user, com.crm.dataobject.networkmanagement.CRMDOUnit unit) Returns if the user or unit is included in the user unit criteria
java.lang.Boolean	isRated(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount) Returns whether the ad hoc discount is rated or not
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.billing.CRMDOAdditiveDiscountDefinition additiveDiscountDefinition, com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.products.CRMDOProduct product, com.crm.dataobject.users.CRMDOUser providedByUser, com.crm.dataobject.users.CRMDOUser approvedByUser, com.crm.dataobject.users.CRMDOUser cancelledByUser, com.crm.dataobject.billing.AdHocDiscountLifeCycleState lifeCycleState, java.lang.Boolean applyOnAllServices, java.util.ArrayList<java.lang.String> associations) Loads a list of ad hoc discounts based on a number of criteria.
com.crm.dataobject.billing.CRMDOAdHocDiscount	loadAdditionalInformation(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount) Loads additional information of an ad hoc discount.
com.crm.dataobject.billing.CRMDOAdHocDiscount	loadByNumber(java.lang.String number) Loads an ad hoc discount by a number.
com.crm.dataobject.billing.CRMDOAdHocDiscount	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads an ad hoc discount by a number.
com.crm.dataobject.billing.CRMDOAdHocDiscount	validateOnApproval(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount, com.crm.dataobject.users.CRMDOUser approvedByUser, com.crm.dataobject.networkmanagement.CRMDOUnit approvedByUnit) Validates the ad hoc discount on approval
com.crm.dataobject.billing.CRMDOAdHocDiscount	validateOnCancellation(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount) Validates the ad hoc discount on cancellation

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMBOAdHocDiscountBean

public CRMBOAdHocDiscountBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Returns the default associated data objects of an additive discount definition.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the additive discount definition

validateOnCancellation

public com.crm.dataobject.billing.CRMDOAdHocDiscount validateOnCancellation(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount)
                                                                     throws java.lang.Exception

Validates the ad hoc discount on cancellation

Parameters:

adHocDiscount - - the ad hoc discount to validate on cancellation

Returns:

the ad hoc discount

Throws:

java.lang.Exception

isRated

public java.lang.Boolean isRated(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount)
                          throws java.lang.Exception

Returns whether the ad hoc discount is rated or not

Parameters:

adHocDiscount - - the ad hoc discount to validate

Returns:

true if the ad hoc discount is rated, false if the ad hoc discount is not rated

Throws:

java.lang.Exception

cancel

public com.crm.dataobject.billing.CRMDOAdHocDiscount cancel(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount,
                                                   java.util.Date cancelledOn,
                                                   com.crm.dataobject.users.CRMDOUser cancelledByUser)

Sets the life cycle state of an ad hoc discount to cancelled

Parameters:

adHocDiscount - - the ad hoc discount to cancel

cancelledOn - - the date to cancel

cancelledByUser - - the user to cancel

Returns:

the ad hoc discount

validateOnApproval

public com.crm.dataobject.billing.CRMDOAdHocDiscount validateOnApproval(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount,
                                                               com.crm.dataobject.users.CRMDOUser approvedByUser,
                                                               com.crm.dataobject.networkmanagement.CRMDOUnit approvedByUnit)
                                                                 throws java.lang.Exception

Validates the ad hoc discount on approval

Parameters:

adHocDiscount - - the ad hoc discount to validate on approval

approvedByUser - - the user to approve

approvedByUnit - - the unit to approve

Returns:

the ad hoc discount

Throws:

java.lang.Exception

isIncludedInApprovalAuthorizations

public java.lang.Boolean isIncludedInApprovalAuthorizations(java.util.Set<com.crm.dataobject.networkmanagement.UserUnitCriterion> userUnitCriteria,
                                                   com.crm.dataobject.users.CRMDOUser user,
                                                   com.crm.dataobject.networkmanagement.CRMDOUnit unit)

Returns if the user or unit is included in the user unit criteria

Parameters:

userUnitCriteria - - the given user unit criteria to search

user - - the user to search for

unit - - the unit to search for

Returns:

true if the user or unit is included in the given user unit criteria, false if none of them is included

approve

public com.crm.dataobject.billing.CRMDOAdHocDiscount approve(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount)
                                                      throws java.lang.Exception

Sets the life cycle state of an ad hoc discount to approved

Parameters:

adHocDiscount - - the ad hoc discount to approve

Returns:

the ad hoc discount

Throws:

java.lang.Exception

approve

public com.crm.dataobject.billing.CRMDOAdHocDiscount approve(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount,
                                                    java.util.Date approvedOn,
                                                    com.crm.dataobject.users.CRMDOUser approvedByUser)
                                                      throws java.lang.Exception

Sets the life cycle state of an ad hoc discount to approved

Parameters:

adHocDiscount - - the ad hoc discount to approve

approvedOn - - the date to approve

approvedByUser - - the user to approve

Returns:

the ad hoc discount

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.billing.CRMDOAdHocDiscount loadByNumber(java.lang.String number)
                                                           throws java.lang.Exception

Loads an ad hoc discount by a number.

Parameters:

number - - the number of the ad hoc discount to load

Returns:

an ad hoc discount with the given number

Throws:

java.lang.Exception

loadByNumber

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

Loads an ad hoc discount by a number.

Parameters:

number - - the number of the ad hoc discount to load

associations - - a list of associated data objects

Returns:

an ad hoc discount with the given number

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.billing.CRMDOAdditiveDiscountDefinition additiveDiscountDefinition,
                                                 com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.jobs.CRMDOJob job,
                                                 com.crm.dataobject.products.CRMDOProduct product,
                                                 com.crm.dataobject.users.CRMDOUser providedByUser,
                                                 com.crm.dataobject.users.CRMDOUser approvedByUser,
                                                 com.crm.dataobject.users.CRMDOUser cancelledByUser,
                                                 com.crm.dataobject.billing.AdHocDiscountLifeCycleState lifeCycleState,
                                                 java.lang.Boolean applyOnAllServices,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of ad hoc discounts based on a number of criteria.

Parameters:

additiveDiscountDefinition - - the additive discount definition of the ad hoc discount

subscription - - the subscription of the ad hoc discount

job - - the job of the ad hoc discount

product - - the product of the ad hoc discount

providedByUser - - the user that provided the ad hoc discount

approvedByUser - - the user that approved the ad hoc discount.

cancelledByUser - - the user that cancelled the ad hoc discount.

lifeCycleState - - the life cycle state of the ad hoc discount

associations - - the associations related to the ad hoc discounts

Returns:

a list of ad hoc discounts

Throws:

java.lang.Exception

copyDefaultInformationFromDefinition

public com.crm.dataobject.billing.CRMDOAdHocDiscount copyDefaultInformationFromDefinition(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount,
                                                                                 com.crm.dataobject.billing.CRMDOAdditiveDiscountDefinition definition)

Copies the default information of the additive discount definition to the ad hoc discount

Parameters:

adHocDiscount - - the ad hoc discount to set the default information.

definition - - the additive discount definition

Returns:

the updated ad hoc discount

Throws:

java.lang.Exception

calculateApplied

public com.crm.dataobject.billing.CRMDOAdHocDiscount calculateApplied(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount)
                                                               throws java.lang.Exception

Calculates the ad hoc discount applied fields

Parameters:

adHocDiscount - - the ad hoc discount to calculate the applied fields for

Returns:

the ad hoc discount

Throws:

java.lang.Exception

isApplied

public java.lang.Boolean isApplied(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount)
                            throws java.lang.Exception

Checks if the ad hoc discount has been applied.

Parameters:

adHocDiscount - - the ad hoc discount to check

Returns:

true if the ad hoc discount has been applied, false if not

Throws:

java.lang.Exception

getAdHocDiscountPeriods

public java.util.ArrayList<com.crm.dataobject.billing.AdditiveDiscountPeriod> getAdHocDiscountPeriods(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService,
                                                                                             com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                             java.util.Date asOfDate)
                                                                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAdHocDiscountPeriods

public java.util.ArrayList<com.crm.dataobject.billing.AdditiveDiscountPeriod> getAdHocDiscountPeriods(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subService,
                                                                                             com.crm.dataobject.billing.CRMDOBillingTerm billingTerm,
                                                                                             com.crm.dataobject.billing.CRMDOBuyInAdvanceRequest buyInAdvanceRequest,
                                                                                             java.util.Date asOfDate)
                                                                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAdHocDiscountPeriods

public java.util.ArrayList<com.crm.dataobject.billing.AdditiveDiscountPeriod> getAdHocDiscountPeriods(com.crm.dataobject.jobs.CRMDOJob job,
                                                                                             com.crm.dataobject.products.CRMDOProduct product,
                                                                                             java.util.Date asOfDate)
                                                                                               throws java.lang.Exception

Throws:

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.billing.CRMDOAdHocDiscount loadAdditionalInformation(com.crm.dataobject.billing.CRMDOAdHocDiscount adHocDiscount)
                                                                        throws java.lang.Exception

Loads additional information of an ad hoc discount.

Parameters:

adHocDiscount - - ad hoc discount to load the additional information for

Returns:

the updated ad hoc discount

Throws:

java.lang.Exception