com.crm.businessobject.rewards

Class CRMBORewardOfferBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.rewards.CRMBORewardOfferBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBORewardOfferBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBORewardOfferBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.rewards.CRMDORewardOffer	activate(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer) Activates a reward offer.
java.math.BigDecimal	adjustAwardedAmount(java.math.BigDecimal awardAmount, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.math.BigDecimal quantity)
java.lang.Boolean	canApply(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, java.util.Date eventDate, java.math.BigDecimal totalAmount, java.math.BigDecimal intendedTotalAmount, java.lang.Integer numberOfTransactions, java.lang.String profile, java.lang.String website, com.crm.dataobject.rewards.CRMDOCustomerEventClassification customerEventClassification, java.util.HashMap<java.lang.String,java.math.BigDecimal> amountPerProduct, java.util.HashMap<java.lang.String,java.math.BigDecimal> amountPerProductType, java.util.HashMap<java.lang.String,java.math.BigDecimal> amountPerProductFamily, com.crm.dataobject.accounts.CRMDOPaymentMediumType paymentMediumType, com.crm.dataobject.accounts.CRMDOPaymentMediumBrand paymentMediumBrand, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.networkmanagement.CRMDOUnitGroup unitGroup, java.lang.Boolean evaluatePaymentMediumCriteria, java.lang.Boolean evaluateReferralCriteria)
java.lang.Boolean	canApply(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer, com.crm.dataobject.rewards.CRMDOCustomerEvent customerEvent) Checks if the offer can be apply for the specified customer event
com.crm.dataobject.rewards.CRMDORewardOffer	deactivate(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer) Deactivates a reward offer.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a reward offer.
com.crm.dataobject.rewards.CRMDORewardOffer	initialize(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer, com.crm.dataobject.rewards.CRMDORewardOfferTemplate rewardOfferTemplate)
java.lang.Boolean	isUsedByAwardTransaction(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer) Checks if the offer is used by a non cancelled award transaction
java.lang.Boolean	isValid(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer, com.crm.dataobject.rewards.CRMDOCustomerEvent customerEvent) Checks if the given reward offer is valid for the given customer event based on the reward offer's validity settings
java.lang.Boolean	isValid(java.lang.String rewardOfferId, com.crm.dataobject.rewards.RewardOfferValidityPeriodType validityPeriodType, java.util.Date latestEffectiveDate, java.lang.Integer validDaysAfter, java.lang.Integer validDaysBefore, java.util.Date eventDate, java.lang.Integer dayOfBirth, java.lang.Integer monthOfBirth, java.lang.Integer namedayDay, java.lang.Integer namedayMonth) Checks if the given reward offer is valid for the given customer event based on the reward offer's validity settings
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.rewards.CRMDORewardOfferCategory category) Loads a list of reward offers of a specific category.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.rewards.CRMDORewardOfferType type) Loads a list of reward offers of a specific type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.rewards.CRMDORewardScheme scheme) Loads a list of reward offers of a specific scheme.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.util.Date eventDate, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.util.Date eventDate, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications, com.crm.dataobject.rewards.CRMDORewardOfferType offerType, com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.util.Date eventDate, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications, com.crm.dataobject.rewards.CRMDORewardOfferType offerType, com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme, com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.util.Date eventDate, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications, com.crm.dataobject.rewards.CRMDORewardOfferType offerType, com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme, com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod, com.crm.dataobject.rewards.AwardScope awardScope, com.crm.dataobject.rewards.SpendMethod spendMethod, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.util.Date eventDate, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications, com.crm.dataobject.rewards.CRMDORewardOfferType offerType, com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme, com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod, com.crm.dataobject.rewards.AwardScope awardScope, com.crm.dataobject.rewards.SpendMethod spendMethod, com.crm.dataobject.networkmanagement.CRMDOUnit unit, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.util.Date eventDate, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications, com.crm.dataobject.rewards.CRMDORewardOfferType offerType, com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme, com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod, com.crm.dataobject.networkmanagement.CRMDOUnit unit, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllIncludeDeleted() Loads a list of all reward offers, including deleted.
com.crm.dataobject.rewards.CRMDORewardOffer	loadByName(java.lang.String value, java.util.ArrayList<java.lang.String> rewardOfferAPIAssociations)
com.crm.dataobject.rewards.CRMDORewardOffer	loadByNumber(java.lang.String value, java.util.ArrayList<java.lang.String> rewardOfferAPIAssociations)

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

Constructor Detail

CRMBORewardOfferBean

public CRMBORewardOfferBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Returns the default associated data objects of a reward offer.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the reward offer

activate

public com.crm.dataobject.rewards.CRMDORewardOffer activate(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer)
                                                     throws java.lang.Exception,
                                                            com.crm.exception.InvalidStateException

Activates a reward offer.

Parameters:

rewardOffer - - the reward offer to activate

Returns:

the updated reward offer

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

deactivate

public com.crm.dataobject.rewards.CRMDORewardOffer deactivate(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer)
                                                       throws java.lang.Exception,
                                                              com.crm.exception.InvalidStateException

Deactivates a reward offer.

Parameters:

rewardOffer - - the reward offer to deactivate

Returns:

the updated reward offer

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.rewards.CRMDORewardOfferType type)
                                                   throws java.lang.Exception

Loads a list of reward offers of a specific type.

Parameters:

type - - the reward offer type to load the offers for

Returns:

a list of reward offers of the given type

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.rewards.CRMDORewardOfferCategory category)
                                                   throws java.lang.Exception

Loads a list of reward offers of a specific category.

Parameters:

category - - the reward offer category to load the offers for

Returns:

a list of reward offers of the given category

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.rewards.CRMDORewardScheme scheme)
                                                   throws java.lang.Exception

Loads a list of reward offers of a specific scheme.

Parameters:

scheme - - the reward scheme to load the offers for

Returns:

a list of reward offers of the given scheme

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.util.Date eventDate,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.util.Date eventDate,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications,
                                                          com.crm.dataobject.rewards.CRMDORewardOfferType offerType,
                                                          com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.util.Date eventDate,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications,
                                                          com.crm.dataobject.rewards.CRMDORewardOfferType offerType,
                                                          com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme,
                                                          com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.util.Date eventDate,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications,
                                                          com.crm.dataobject.rewards.CRMDORewardOfferType offerType,
                                                          com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme,
                                                          com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.util.Date eventDate,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications,
                                                          com.crm.dataobject.rewards.CRMDORewardOfferType offerType,
                                                          com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme,
                                                          com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod,
                                                          com.crm.dataobject.rewards.AwardScope awardScope,
                                                          com.crm.dataobject.rewards.SpendMethod spendMethod,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.util.Date eventDate,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.util.ArrayList<com.crm.dataobject.rewards.RewardOfferTypeClassification> rewardOfferTypeClassifications,
                                                          com.crm.dataobject.rewards.CRMDORewardOfferType offerType,
                                                          com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme,
                                                          com.crm.dataobject.rewards.RewardOfferEvaluationMethod evaluationMethod,
                                                          com.crm.dataobject.rewards.AwardScope awardScope,
                                                          com.crm.dataobject.rewards.SpendMethod spendMethod,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

isUsedByAwardTransaction

public java.lang.Boolean isUsedByAwardTransaction(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer)
                                           throws java.lang.Exception

Checks if the offer is used by a non cancelled award transaction

Parameters:

rewardOffer - - the rewardOffer to check

Returns:

true if the rewardOffer is used by award transaction, false if not

Throws:

java.lang.Exception

canApply

public java.lang.Boolean canApply(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer,
                                  com.crm.dataobject.rewards.CRMDOCustomerEvent customerEvent)
                           throws java.lang.Exception

Checks if the offer can be apply for the specified customer event

Parameters:

rewardOffer - - the rewardOffer to check if can be apply

customerEvent - - the purchaseCustomerEvent to check if meet the conditions of the reward offer

Returns:

true if the rewardOffer is can be apply false otherwise

Throws:

java.lang.Exception

canApply

public java.lang.Boolean canApply(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer,
                                  com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                  com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                  java.util.Date eventDate,
                                  java.math.BigDecimal totalAmount,
                                  java.math.BigDecimal intendedTotalAmount,
                                  java.lang.Integer numberOfTransactions,
                                  java.lang.String profile,
                                  java.lang.String website,
                                  com.crm.dataobject.rewards.CRMDOCustomerEventClassification customerEventClassification,
                                  java.util.HashMap<java.lang.String,java.math.BigDecimal> amountPerProduct,
                                  java.util.HashMap<java.lang.String,java.math.BigDecimal> amountPerProductType,
                                  java.util.HashMap<java.lang.String,java.math.BigDecimal> amountPerProductFamily,
                                  com.crm.dataobject.accounts.CRMDOPaymentMediumType paymentMediumType,
                                  com.crm.dataobject.accounts.CRMDOPaymentMediumBrand paymentMediumBrand,
                                  com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                  com.crm.dataobject.networkmanagement.CRMDOUnitGroup unitGroup,
                                  java.lang.Boolean evaluatePaymentMediumCriteria,
                                  java.lang.Boolean evaluateReferralCriteria)
                           throws java.lang.Exception

Throws:

java.lang.Exception

loadAllIncludeDeleted

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

Loads a list of all reward offers, including deleted.

Returns:

a list of all reward offers

Throws:

java.lang.Exception

initialize

public com.crm.dataobject.rewards.CRMDORewardOffer initialize(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer,
                                                              com.crm.dataobject.rewards.CRMDORewardOfferTemplate rewardOfferTemplate)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.rewards.CRMDORewardOffer loadByNumber(java.lang.String value,
                                                                java.util.ArrayList<java.lang.String> rewardOfferAPIAssociations)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

loadByName

public com.crm.dataobject.rewards.CRMDORewardOffer loadByName(java.lang.String value,
                                                              java.util.ArrayList<java.lang.String> rewardOfferAPIAssociations)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

adjustAwardedAmount

public java.math.BigDecimal adjustAwardedAmount(java.math.BigDecimal awardAmount,
                                                com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                java.math.BigDecimal quantity)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

isValid

public java.lang.Boolean isValid(com.crm.dataobject.rewards.CRMDORewardOffer rewardOffer,
                                 com.crm.dataobject.rewards.CRMDOCustomerEvent customerEvent)
                          throws com.crm.exception.CRMException,
                                 java.lang.Exception

Checks if the given reward offer is valid for the given customer event based on the reward offer's validity settings

Parameters:

rewardOffer - - the reward offer to check

customerEvent - - the customer event to check

Returns:

true if the reward offer is valid, false if not

Throws:

com.crm.exception.CRMException

java.lang.Exception

isValid

public java.lang.Boolean isValid(java.lang.String rewardOfferId,
                                 com.crm.dataobject.rewards.RewardOfferValidityPeriodType validityPeriodType,
                                 java.util.Date latestEffectiveDate,
                                 java.lang.Integer validDaysAfter,
                                 java.lang.Integer validDaysBefore,
                                 java.util.Date eventDate,
                                 java.lang.Integer dayOfBirth,
                                 java.lang.Integer monthOfBirth,
                                 java.lang.Integer namedayDay,
                                 java.lang.Integer namedayMonth)
                          throws com.crm.exception.CRMException,
                                 java.lang.Exception

Checks if the given reward offer is valid for the given customer event based on the reward offer's validity settings

Parameters:

rewardOfferId - - the reward offer id

validityPeriodType - - the reward offer validity period type

latestEffectiveDate - - the reward offer latest effective date

validDaysAfter - - the number of days a reward offer is valid after the rewards participant's birthday or nameday

validDaysBefore - - the number of days a reward offer is valid before the reward participant's birthday or nameday

eventDate - - the customer event performed date

dayOfBirth - - the rewards participant's day of birth

monthOfBirth - - the rewards participant's month of birth

namedayDay - - the rewards participant's nameday

namedayMonth - - the rewards participant's nameday month

Returns:

true id the reward offer is valid, false if not

Throws:

com.crm.exception.CRMException

java.lang.Exception