com.crm.businessobject.rewards

Class CRMBORewardParticipantBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOCacheableEntity

com.crm.businessobject.rewards.CRMBORewardParticipantBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBORewardParticipantBean
extends CRMBOCacheableEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBORewardParticipantBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a Rewards Participant.
java.lang.Boolean	isMerchantAuthorised(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.rewards.CRMDORewardsParticipatingMerchant rewardsParticipatingMerchant)
java.lang.Boolean	isParticipating(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme, java.util.Date asOfDate)
com.crm.dataobject.rewards.CRMDORewardParticipant	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Loads a Rewards Participant based on an Accounts Receivable.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState) Loads a Rewards Participant based on an Accounts Receivable and a list of Life Cycle States.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a Rewards Participant based on an Accounts Receivable.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a list of Rewards Participants based on a number of criteria.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState) Loads a list of Rewards Participants based on a number of criteria.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of Rewards Participants based on a number of criteria.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(com.crm.dataobject.wallets.CRMDOWallet wallet) Loads a Rewards Participant based on an wallet.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState) Loads a list of Rewards Participants based on a number of criteria.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of Rewards Participants based on a number of criteria.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a Rewards Participant based on an Accounts Receivable.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of Rewards Participants based on a number of criteria.
com.crm.dataobject.rewards.CRMDORewardParticipant	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of Rewards Participants based on a number of criteria.
com.crm.dataobject.rewards.CRMDORewardParticipant	loadByAccessTokenAuthenticationCode(java.lang.String authenticationCode, java.util.ArrayList<java.lang.String> associations) Loads a Rewards Participant based on the related access token authentication code
com.crm.dataobject.rewards.CRMDORewardParticipant	loadByNumber(java.lang.String value) Loads a Rewards Participant based on a number.
com.crm.dataobject.rewards.CRMDORewardParticipant	loadByNumber(java.lang.String value, java.util.ArrayList<java.lang.String> associations) Loads a Rewards Participant based on a number.
com.crm.dataobject.rewards.CRMDORewardParticipant	terminate(com.crm.dataobject.rewards.CRMDORewardParticipant participant, com.crm.dataobject.rewards.CRMDORewardParticipant replacement, com.crm.dataobject.rewards.RewardsParticipantTerminationReason terminationReason) Terminate a Rewards Participant
void	validateAccessTokenSettingsOnSave(java.util.ArrayList<com.crm.dataobject.CRMDO> accessTokens, int numOfAccessTokens, java.util.LinkedHashMap<java.lang.String,java.lang.Integer> accessTokensPerClassification) Validates access tokens settings before save

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMBORewardParticipantBean

public CRMBORewardParticipantBean()

Default constructor.

Method Detail

validateAccessTokenSettingsOnSave

public void validateAccessTokenSettingsOnSave(java.util.ArrayList<com.crm.dataobject.CRMDO> accessTokens,
                                              int numOfAccessTokens,
                                              java.util.LinkedHashMap<java.lang.String,java.lang.Integer> accessTokensPerClassification)
                                       throws java.lang.Exception,
                                              com.crm.exception.MandatoryFieldException

Validates access tokens settings before save

Parameters:

accessTokens - - the access tokens to validate.

numOfAccessTokens - - the number of access tokens

accessTokensPerClassification -

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

getDefaultAssociations

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

Returns the default associated data objects of a Rewards Participant.

Overrides:

getDefaultAssociations in class CRMBOCacheableEntity

Returns:

the default associated data objects of the Rewards Participant

loadByNumber

public com.crm.dataobject.rewards.CRMDORewardParticipant loadByNumber(java.lang.String value)
                                                               throws java.lang.Exception

Loads a Rewards Participant based on a number.

Parameters:

value - - the Rewards Participant number

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

loadByNumber

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

Loads a Rewards Participant based on a number.

Parameters:

value - - the Rewards Participant number

associations - - a list of related Rewards Participant's association objects

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                       throws java.lang.Exception

Loads a Rewards Participant based on an Accounts Receivable.

Parameters:

accountReceivable - - the Rewards Participant Accounts Receivable

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                              com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState)
                                                       throws java.lang.Exception

Loads a Rewards Participant based on an Accounts Receivable and a list of Life Cycle States.

Parameters:

accountReceivable - - the Rewards Participant Accounts Receivable

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                              com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                       throws java.lang.Exception

Loads a Rewards Participant based on an Accounts Receivable.

Parameters:

accountReceivable - - the Rewards Participant Accounts Receivable

lifeCycleState - - the Rewards Participant life Cycle State

associations - - a list of related Rewards Participant's association objects

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(java.lang.String orderBy,
                                                              java.lang.Integer numberOfResults,
                                                              java.lang.Integer offset,
                                                              com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                              com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                       throws java.lang.Exception

Loads a Rewards Participant based on an Accounts Receivable.

Parameters:

numberOfResults - - The number of results that can be retrieved

orderBy - - the ordering field

offset - - It defines the number of entities that should be skipped from the results

accountReceivable - - the Rewards Participant Accounts Receivable

lifeCycleState - - the Rewards Participant life Cycle State

associations - - a list of related Rewards Participant's association objects

Returns:

the loaded Rewards Participant

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 Rewards Participants based on a number of criteria.

Parameters:

contactInformation - - the contact information of the Rewards Participant

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

load

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

Loads a list of Rewards Participants based on a number of criteria.

Parameters:

contactInformation - - the contact information of the Rewards Participant

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                          com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of Rewards Participants based on a number of criteria.

Parameters:

contactInformation - - the contact information of the Rewards Participant

associations - - a list of related Rewards Participant's association objects

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String orderBy,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offset,
                                                          com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                          com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of Rewards Participants based on a number of criteria.

Parameters:

numberOfResults - - The number of results that can be retrieved

orderBy - - the ordering field

offset - - It defines the number of entities that should be skipped from the results

contactInformation - - the contact information of the Rewards Participant

associations - - a list of related Rewards Participant's association objects

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                       throws java.lang.Exception

Loads a Rewards Participant based on an wallet.

Parameters:

wallet - - the Rewards Participant of wallet

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                              com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState)
                                                       throws java.lang.Exception

Loads a list of Rewards Participants based on a number of criteria.

Parameters:

wallet - - the wallet of the Rewards Participant

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                              com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                       throws java.lang.Exception

Loads a list of Rewards Participants based on a number of criteria.

Parameters:

wallet - - the wallet of the Rewards Participant

associations - - a list of related Rewards Participant's association objects

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

load

public com.crm.dataobject.rewards.CRMDORewardParticipant load(java.lang.String orderBy,
                                                              java.lang.Integer numberOfResults,
                                                              java.lang.Integer offset,
                                                              com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                              com.crm.dataobject.rewards.RewardsParticipantLifeCycleState lifeCycleState,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                       throws java.lang.Exception

Loads a list of Rewards Participants based on a number of criteria.

Parameters:

numberOfResults - - The number of results that can be retrieved

orderBy - - the ordering field

offset - - It defines the number of entities that should be skipped from the results

wallet - - the wallet of the Rewards Participant

associations - - a list of related Rewards Participant's association objects

lifeCycleState - - the Rewards Participant life Cycle State

Returns:

a list of Rewards Participants based on the given criteria

Throws:

java.lang.Exception

isParticipating

public java.lang.Boolean isParticipating(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                         com.crm.dataobject.rewards.CRMDORewardScheme rewardScheme,
                                         java.util.Date asOfDate)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

loadByAccessTokenAuthenticationCode

public com.crm.dataobject.rewards.CRMDORewardParticipant loadByAccessTokenAuthenticationCode(java.lang.String authenticationCode,
                                                                                             java.util.ArrayList<java.lang.String> associations)
                                                                                      throws java.lang.Exception

Loads a Rewards Participant based on the related access token authentication code

Parameters:

authenticationCode - - the authentication code of the rewards participant related access token

Returns:

the loaded Rewards Participant

Throws:

java.lang.Exception

terminate

public com.crm.dataobject.rewards.CRMDORewardParticipant terminate(com.crm.dataobject.rewards.CRMDORewardParticipant participant,
                                                                   com.crm.dataobject.rewards.CRMDORewardParticipant replacement,
                                                                   com.crm.dataobject.rewards.RewardsParticipantTerminationReason terminationReason)
                                                            throws java.lang.Exception

Terminate a Rewards Participant

Parameters:

participant - - the Rewards Participant to terminate

replacement - - the Rewards Participant to replace the Terminated Participant

terminationReason - - the termination reason of the participant

Returns:

the terminated participant

Throws:

java.lang.Exception

isMerchantAuthorised

public java.lang.Boolean isMerchantAuthorised(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                              com.crm.dataobject.rewards.CRMDORewardsParticipatingMerchant rewardsParticipatingMerchant)
                                       throws java.lang.Exception

Throws:

java.lang.Exception