com.crm.businessobject.accesstokens

Class CRMBOAccessTokenBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.accesstokens.CRMBOAccessTokenBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOAccessTokenBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOAccessTokenBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	accountAccessTokenRequiresVerification(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Checks if an access token related with an account requires verification based on active access tokens definition.
void	anonymizeContactAccessTokens(java.util.ArrayList<java.lang.String> accessTokens) Anonymizes the given contact information access tokens
com.crm.dataobject.accesstokens.CRMDOAccessToken	applyAutomationSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Applies the Automation Settings on an access token as defined on the Access Token Definition and Access Token Classification Definition
java.lang.Boolean	canBeUsed(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Checks if a access token is in lock out period.
java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken>	createAccessTokensBasedOnEmailAddresses(java.util.ArrayList<com.crm.dataobject.CRMDO> emails, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, java.util.ArrayList<com.crm.dataobject.CRMDO> existingAccessTokens) Creates an access token for each unique email address, using the email address as authentication code or/and identifier based on the global automation settings of the access token definition.
java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken>	createAccessTokensBasedOnPhoneNumbers(java.util.ArrayList<com.crm.dataobject.CRMDO> phones, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, java.util.ArrayList<com.crm.dataobject.CRMDO> existingAccessTokens) Creates an access token for each unique phone number, using the number as authentication code or/and identifier based on the global automation settings of the access token definition.
java.lang.String	decryptPasscode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
com.crm.dataobject.accesstokens.CRMDOAccessToken	deleteRelatedAccessToken(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail) Deletes an access token that is related to the given contact information email
com.crm.dataobject.accesstokens.CRMDOAccessToken	deleteRelatedAccessToken(com.crm.dataobject.contactinfo.CRMDOContactInfoPhone contactInfoPhone) Deletes an access token that is related to the given contact information phone
com.crm.dataobject.accesstokens.CRMDOAccessToken	generateOTP(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Generates a one-time password (OTP) for an access token
java.lang.String	generateVerificationCode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Generates the access token verification code
com.crm.dataobject.accesstokens.AuthenticationCodeSettings	getAccessTokenAuthenticationCodeSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Retrieve the authentication code settings that will be applied on access tokens.
com.crm.dataobject.accesstokens.AutomationSettings	getAccessTokenAutomationSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Retrieve the automation settings that will be applied on access tokens.
com.crm.dataobject.accesstokens.IdentifierSettings	getAccessTokenIdentifierSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Retrieve the identifier settings that will be applied on access tokens.
com.crm.dataobject.accesstokens.PasscodeSettings	getAccessTokenPasscodeSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Retrieve the pass code settings that will be applied on access tokens.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of an access token.
java.util.Date	getLockOutTimeStartDate(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Returns the lock out start date period.
java.lang.Integer	getMaxNumberOfAccessTokensForAccountReceivable(com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Returns the maximum number of access tokens that can be created for the given account receivable, based on the access token definition and classification settings
java.lang.Integer	getMaxNumberOfAccessTokensForRewardParticipant(com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant) Returns the maximum number of access tokens that can be created for the given reward participant, based on the access token definition and classification settings
java.lang.Boolean	isExistingEntity(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Checks if an access token exists in the database
java.lang.Boolean	isInLockOutPeriod(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Checks if a access token is in lock out period.
java.lang.Boolean	isOTPExpired(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Checks whether an OTP is expired
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Loads a list of access tokens
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations) Loads a list of access tokens
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accesstokens.CRMDOAccessToken excludeAccesToken) Loads a list of access tokens
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accesstokens.CRMDOAccessToken excludeAccesToken, java.util.ArrayList<java.lang.String> associations) Loads a list of access tokens
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant) Loads an access token based on a rewards participant.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.accesstokens.CRMDOAccessToken excludeAccesToken) Loads a list of access tokens
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.accesstokens.CRMDOAccessToken excludeAccesToken, java.util.ArrayList<java.lang.String> associations) Loads a list of access tokens
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant, com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification, java.util.ArrayList<java.lang.String> associations)
com.crm.dataobject.accesstokens.CRMDOAccessToken	load(java.lang.String authCode, java.lang.String identifier, com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification classification) Loads an access token based on a number of criteria.
com.crm.dataobject.accesstokens.CRMDOAccessToken	load(java.lang.String authCode, java.lang.String identifier, com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification classification, java.util.ArrayList<java.lang.String> associations) Loads an access token based on a number of criteria.
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadAdditionalInformation(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByAuthenticationCode(java.lang.String authCode) Loads an access token based on an authentication code.
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByAuthenticationCode(java.lang.String authCode, java.util.ArrayList<java.lang.String> associations)
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByIdentifier(java.lang.String identifier) Loads an access token based on an identifier and pass code.
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByIdentifier(java.lang.String identifier, java.util.ArrayList<java.lang.String> associations)
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByNumber(java.lang.String value) Loads an access token based on a number.
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByNumber(java.lang.String value, java.util.ArrayList<java.lang.String> associations) Loads an access token based on a number.
com.crm.dataobject.accesstokens.CRMDOAccessToken	loadByOTP(java.lang.String authCode, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<java.lang.String>	loadContactAccessTokensToAnonymize(com.crm.dataobject.contactinfo.CRMDOContactInformation contact) Loads the given contact information access tokens to anonymize
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNotAssociated(com.crm.dataobject.accesstokens.AccessTokenLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations, java.lang.Integer maxSize) Loads a list of access tokens which are not associated with objects.
com.crm.dataobject.accesstokens.CRMDOAccessToken	resetPassCode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
com.crm.dataobject.accesstokens.CRMDOAccessToken	resetVerificationCode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Resets an access token verification code to a random 6 digit number
java.lang.Boolean	rewardsParticipantAccessTokenRequiresVerification(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition) Checks if an access token related with a rewards participant requires verification based on active access tokens definition.
com.crm.dataobject.accesstokens.CRMDOAccessToken	setAuthenticationCodeBasedOnSettings(com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Sets the authentication code of the access token if the settings specify that it should be auto generated
com.crm.dataobject.accesstokens.CRMDOAccessToken	setIdentifierBasedOnSettings(com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Sets the identifier of the access token if the settings specify that it should be auto generated
com.crm.dataobject.accesstokens.CRMDOAccessToken	setPassCodeBasedOnSettings(com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition, com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, java.lang.Boolean considerSuperUser) Sets the pass code of the access token if the settings specify that it should be auto generated
com.crm.dataobject.accesstokens.CRMDOAccessToken	updateAccessTokenBasedOnEmailAddress(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail) Updates an access token if the contact information email address related to it was updated
com.crm.dataobject.accesstokens.CRMDOAccessToken	updateAccessTokenBasedOnPhoneNumber(com.crm.dataobject.contactinfo.CRMDOContactInfoPhone contactInfoPhone) Updates an access token if the contact information phone number related to it was updated
com.crm.dataobject.accesstokens.CRMDOAccessToken	usedOTP(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Once an OTP is used it is validate
com.crm.dataobject.accesstokens.CRMDOAccessToken	validateOTP(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken) Once an OTP is used it is validate
void	verify(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken, java.lang.String verificationCode) Verifies the access token against the given verification code
void	verifyPassCode(java.lang.String passCode, com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)

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

CRMBOAccessTokenBean

public CRMBOAccessTokenBean()

Default constructor.

Method Detail

generateVerificationCode

public java.lang.String generateVerificationCode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)

Generates the access token verification code

Parameters:

accessToken - - the access token to generate the verification code for

Returns:

the access token verification code

verify

public void verify(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                   java.lang.String verificationCode)
            throws com.crm.exception.InvalidValueException,
                   java.lang.Exception

Verifies the access token against the given verification code

Parameters:

accessToken - - the access token to verify

verificationCode - - the verification code to use to verify the access token

Throws:

com.crm.exception.InvalidValueException

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of an access token.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the access token

loadByNumber

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadByNumber(java.lang.String value)
                                                              throws java.lang.Exception

Loads an access token based on a number.

Parameters:

value - - the access token number

Returns:

the loaded access token

Throws:

java.lang.Exception

loadByNumber

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

Loads an access token based on a number.

Parameters:

value - - the access token number

associations - - a list of related access token's association objects

Returns:

the loaded access token

Throws:

java.lang.Exception

loadByIdentifier

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadByIdentifier(java.lang.String identifier)
                                                                  throws java.lang.Exception

Loads an access token based on an identifier and pass code.

Parameters:

identifier - - the access token identifier

Returns:

the loaded access token

Throws:

java.lang.Exception

loadByIdentifier

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadByIdentifier(java.lang.String identifier,
                                                                         java.util.ArrayList<java.lang.String> associations)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

loadByAuthenticationCode

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadByAuthenticationCode(java.lang.String authCode)
                                                                          throws java.lang.Exception

Loads an access token based on an authentication code.

Parameters:

authCode - - the access token authentication code

Returns:

the loaded access token

Throws:

java.lang.Exception

loadByAuthenticationCode

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadByAuthenticationCode(java.lang.String authCode,
                                                                                 java.util.ArrayList<java.lang.String> associations)
                                                                          throws java.lang.Exception

Throws:

java.lang.Exception

load

public com.crm.dataobject.accesstokens.CRMDOAccessToken load(java.lang.String authCode,
                                                             java.lang.String identifier,
                                                             com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification classification)
                                                      throws java.lang.Exception

Loads an access token based on a number of criteria.

Parameters:

authCode - the access token authentication code

identifier - the access token identifier

classification - the access token classification

Returns:

the loaded access token

Throws:

java.lang.Exception

load

public com.crm.dataobject.accesstokens.CRMDOAccessToken load(java.lang.String authCode,
                                                             java.lang.String identifier,
                                                             com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification classification,
                                                             java.util.ArrayList<java.lang.String> associations)
                                                      throws java.lang.Exception

Loads an access token based on a number of criteria.

Parameters:

authCode - the access token authentication code

identifier - the access token identifier

classification - the access token classification

associations - a list of related access token's association objects

Returns:

the loaded access token

Throws:

java.lang.Exception

loadByOTP

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadByOTP(java.lang.String authCode,
                                                                  java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

loadNotAssociated

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNotAssociated(com.crm.dataobject.accesstokens.AccessTokenLifeCycleState lifeCycleState,
                                                                       java.util.ArrayList<java.lang.String> associations,
                                                                       java.lang.Integer maxSize)
                                                                throws java.lang.Exception

Loads a list of access tokens which are not associated with objects.

Parameters:

lifeCycleState - - the access token life cycle state to search for

associations - - a list of related access token's association objects

maxSize - - number of access tokens to return

Returns:

the loaded list

Throws:

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.accesstokens.CRMDOAccessToken loadAdditionalInformation(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                  com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                           throws java.lang.Exception

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 access tokens

Parameters:

accountReceivable - - the account Receivable to load the access token of

Returns:

a list of access tokens

Throws:

java.lang.Exception

load

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

Loads a list of access tokens

Parameters:

accountReceivable - - the account Receivable to load the access token of

associations -

Returns:

a list of access tokens

Throws:

java.lang.Exception

load

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

Loads a list of access tokens

Parameters:

accountReceivable - - the account Receivable to load the access token of

excludeAccesToken - - the access token to exclude

Returns:

a list of access tokens

Throws:

java.lang.Exception

load

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

Loads a list of access tokens

Parameters:

accountReceivable - - the account Receivable to load the access token of

excludeAccesToken - - the access token to exclude

associations -

Returns:

a list of access tokens

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                          com.crm.dataobject.accesstokens.CRMDOAccessToken excludeAccesToken)
                                                   throws java.lang.Exception

Loads a list of access tokens

Parameters:

rewardParticipant - - the related rewards participant to load the access tokens of

excludeAccesToken - - the access token to exclude

Returns:

a list of access tokens

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                          com.crm.dataobject.accesstokens.CRMDOAccessToken excludeAccesToken,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of access tokens

Parameters:

rewardParticipant - - the related rewards participant to load the access tokens of

excludeAccesToken - - the access token to exclude

associations -

Returns:

a list of access tokens

Throws:

java.lang.Exception

load

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

Loads an access token based on a rewards participant.

Parameters:

rewardParticipant - - the related rewards participant

Returns:

the loaded access token

Throws:

java.lang.Exception

load

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

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                          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(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                          com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification,
                                                          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.lang.String orderBy,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offset,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                          com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

decryptPasscode

public java.lang.String decryptPasscode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                 throws java.lang.Exception,
                                        com.crm.exception.CannotDecryptException

Throws:

java.lang.Exception

com.crm.exception.CannotDecryptException

resetPassCode

public com.crm.dataobject.accesstokens.CRMDOAccessToken resetPassCode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                               throws java.lang.Exception,
                                                                      com.crm.exception.InvalidStateException,
                                                                      com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

verifyPassCode

public void verifyPassCode(java.lang.String passCode,
                           com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                    throws java.lang.Exception,
                           com.crm.exception.accesstokens.InvalidAccessTokenAuthenticationFailedException

Throws:

java.lang.Exception

com.crm.exception.accesstokens.InvalidAccessTokenAuthenticationFailedException

resetVerificationCode

public com.crm.dataobject.accesstokens.CRMDOAccessToken resetVerificationCode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                                       throws java.lang.Exception,
                                                                              com.crm.exception.InvalidStateException,
                                                                              com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

Resets an access token verification code to a random 6 digit number

Parameters:

accessToken - - the access token to reset

Returns:

the updated access token

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

getAccessTokenIdentifierSettings

public com.crm.dataobject.accesstokens.IdentifierSettings getAccessTokenIdentifierSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                           com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                                    throws java.lang.Exception

Retrieve the identifier settings that will be applied on access tokens.

Parameters:

accessToken - - the access token on which the settings will be applied

accessTokenDefinition - - the access token definition from which settings will be retrieved

Returns:

the retrieved settings

Throws:

java.lang.Exception

getAccessTokenAuthenticationCodeSettings

public com.crm.dataobject.accesstokens.AuthenticationCodeSettings getAccessTokenAuthenticationCodeSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                                           com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                                                    throws java.lang.Exception

Retrieve the authentication code settings that will be applied on access tokens.

Parameters:

accessToken - - the access token on which the settings will be applied

accessTokenDefinition - - the access token definition from which settings will be retrieved

Returns:

the retrieved settings

Throws:

java.lang.Exception

getAccessTokenPasscodeSettings

public com.crm.dataobject.accesstokens.PasscodeSettings getAccessTokenPasscodeSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                       com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                                throws java.lang.Exception

Retrieve the pass code settings that will be applied on access tokens.

Parameters:

accessToken - - the access token on which the settings will be applied

accessTokenDefinition - - the access token definition from which settings will be retrieved

Returns:

the retrieved settings

Throws:

java.lang.Exception

getAccessTokenAutomationSettings

public com.crm.dataobject.accesstokens.AutomationSettings getAccessTokenAutomationSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                           com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                                    throws java.lang.Exception

Retrieve the automation settings that will be applied on access tokens.

Parameters:

accessToken - - the access token on which the settings will be applied

accessTokenDefinition - - the access token definition from which settings will be retrieved

Returns:

the retrieved settings

Throws:

java.lang.Exception

accountAccessTokenRequiresVerification

public java.lang.Boolean accountAccessTokenRequiresVerification(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                         throws java.lang.Exception

Checks if an access token related with an account requires verification based on active access tokens definition.

Parameters:

accessToken - - the access token to check

accessTokenDefinition - - the active access token definition

Returns:

true if the given access token requires verification, otherwise false

Throws:

java.lang.Exception

rewardsParticipantAccessTokenRequiresVerification

public java.lang.Boolean rewardsParticipantAccessTokenRequiresVerification(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                           com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                    throws java.lang.Exception

Checks if an access token related with a rewards participant requires verification based on active access tokens definition.

Parameters:

accessToken - - the access token to check

accessTokenDefinition - - the active access token definition

Returns:

true if the given access token requires verification, otherwise false

Throws:

java.lang.Exception

applyAutomationSettings

public com.crm.dataobject.accesstokens.CRMDOAccessToken applyAutomationSettings(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition)
                                                                         throws java.lang.Exception

Applies the Automation Settings on an access token as defined on the Access Token Definition and Access Token Classification Definition

Parameters:

accessToken - - the Access Token to apply the automation settings on

accessTokenDefinition - - the access token active definition

Returns:

the access Token

Throws:

java.lang.Exception

generateOTP

public com.crm.dataobject.accesstokens.CRMDOAccessToken generateOTP(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                             throws java.lang.Exception,
                                                                    com.crm.exception.InvalidStateException,
                                                                    com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

Generates a one-time password (OTP) for an access token

Parameters:

accessToken - - the access token to generate the OTP for

Returns:

the updated access token

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

validateOTP

public com.crm.dataobject.accesstokens.CRMDOAccessToken validateOTP(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                             throws java.lang.Exception,
                                                                    com.crm.exception.InvalidStateException,
                                                                    com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

Once an OTP is used it is validate

Parameters:

accessToken - - the access token to validate the OTP for

Returns:

the updated access token

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

usedOTP

public com.crm.dataobject.accesstokens.CRMDOAccessToken usedOTP(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                         throws java.lang.Exception,
                                                                com.crm.exception.InvalidStateException,
                                                                com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

Once an OTP is used it is validate

Parameters:

accessToken - - the access token to validate the OTP for

Returns:

the updated access token

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

isOTPExpired

public java.lang.Boolean isOTPExpired(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                               throws java.lang.Exception,
                                      com.crm.exception.InvalidStateException,
                                      com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

Checks whether an OTP is expired

Parameters:

accessToken - - the access token to validate the OTP for

Returns:

the updated access token

Throws:

java.lang.Exception

com.crm.exception.InvalidStateException

com.crm.exception.accesstokens.InvalidAccessTokenIdentifierException

isExistingEntity

public java.lang.Boolean isExistingEntity(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                   throws java.lang.Exception

Checks if an access token exists in the database

Parameters:

accessToken - - the access token to check if it exists in the database

Throws:

java.lang.Exception

createAccessTokensBasedOnEmailAddresses

public java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken> createAccessTokensBasedOnEmailAddresses(java.util.ArrayList<com.crm.dataobject.CRMDO> emails,
                                                                                                                     com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                     com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                                                                                     com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                                                                     java.util.ArrayList<com.crm.dataobject.CRMDO> existingAccessTokens)
                                                                                                              throws java.lang.Exception

Creates an access token for each unique email address, using the email address as authentication code or/and identifier based on the global automation settings of the access token definition.

Parameters:

emails - the emails to use to create the access tokens

accountReceivable - the account receivable to set on the access tokens

rewardParticipant - if given, the reward participant to set on the access tokens

accessTokenDefinition - the access token definition

Returns:

the created access tokens

Throws:

java.lang.Exception

createAccessTokensBasedOnPhoneNumbers

public java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken> createAccessTokensBasedOnPhoneNumbers(java.util.ArrayList<com.crm.dataobject.CRMDO> phones,
                                                                                                                   com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                   com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant,
                                                                                                                   com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                                                                   java.util.ArrayList<com.crm.dataobject.CRMDO> existingAccessTokens)
                                                                                                            throws java.lang.Exception

Creates an access token for each unique phone number, using the number as authentication code or/and identifier based on the global automation settings of the access token definition.

Parameters:

phones - the phones to use to create the access tokens

accountReceivable - the account receivable to set on the access tokens

rewardParticipant - if given, the reward participant to set on the access tokens

accessTokenDefinition - the access token definition

Returns:

the created access tokens

Throws:

java.lang.Exception

getMaxNumberOfAccessTokensForAccountReceivable

public java.lang.Integer getMaxNumberOfAccessTokensForAccountReceivable(com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification,
                                                                        com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                        com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                 throws java.lang.Exception

Returns the maximum number of access tokens that can be created for the given account receivable, based on the access token definition and classification settings

Parameters:

accessTokenClassification - the access token classification

accessTokenDefinition - the access token definition

accountReceivable - the account receivable

Returns:

an integer value that represents the maximum number of access tokens that can be created, or null, if no limitations exist

Throws:

java.lang.Exception

getMaxNumberOfAccessTokensForRewardParticipant

public java.lang.Integer getMaxNumberOfAccessTokensForRewardParticipant(com.crm.dataobject.accesstokens.CRMDOAccessTokenClassification accessTokenClassification,
                                                                        com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                        com.crm.dataobject.rewards.CRMDORewardParticipant rewardParticipant)
                                                                 throws java.lang.Exception

Returns the maximum number of access tokens that can be created for the given reward participant, based on the access token definition and classification settings

Parameters:

accessTokenClassification - the access token classification

accessTokenDefinition - the access token definition

rewardParticipant - the reward participant

Returns:

an integer value that represents the maximum number of access tokens that can be created, or null, if no limitations exist

Throws:

java.lang.Exception

updateAccessTokenBasedOnEmailAddress

public com.crm.dataobject.accesstokens.CRMDOAccessToken updateAccessTokenBasedOnEmailAddress(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail)
                                                                                      throws java.lang.Exception

Updates an access token if the contact information email address related to it was updated

Parameters:

contactInfoEmail - the contact information email address that was updated

Returns:

the updated access token

Throws:

java.lang.Exception

updateAccessTokenBasedOnPhoneNumber

public com.crm.dataobject.accesstokens.CRMDOAccessToken updateAccessTokenBasedOnPhoneNumber(com.crm.dataobject.contactinfo.CRMDOContactInfoPhone contactInfoPhone)
                                                                                     throws java.lang.Exception

Updates an access token if the contact information phone number related to it was updated

Parameters:

contactInfoPhone - the contact information phone number that was updated

Returns:

the updated access token

Throws:

java.lang.Exception

deleteRelatedAccessToken

public com.crm.dataobject.accesstokens.CRMDOAccessToken deleteRelatedAccessToken(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail)
                                                                          throws java.lang.Exception

Deletes an access token that is related to the given contact information email

Parameters:

contactInfoEmail - the contact information email

Returns:

the deleted access token

Throws:

java.lang.Exception

deleteRelatedAccessToken

public com.crm.dataobject.accesstokens.CRMDOAccessToken deleteRelatedAccessToken(com.crm.dataobject.contactinfo.CRMDOContactInfoPhone contactInfoPhone)
                                                                          throws java.lang.Exception

Deletes an access token that is related to the given contact information phone

Parameters:

contactInfoPhone - the contact information phone

Returns:

the deleted access token

Throws:

java.lang.Exception

setAuthenticationCodeBasedOnSettings

public com.crm.dataobject.accesstokens.CRMDOAccessToken setAuthenticationCodeBasedOnSettings(com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                                             com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                                                      throws java.lang.Exception

Sets the authentication code of the access token if the settings specify that it should be auto generated

Parameters:

accessTokenDefinition - the active access token definition

accessToken - the access token to set the authentication code for

Returns:

the updated access token

Throws:

java.lang.Exception

setIdentifierBasedOnSettings

public com.crm.dataobject.accesstokens.CRMDOAccessToken setIdentifierBasedOnSettings(com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                                     com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                                                              throws java.lang.Exception

Sets the identifier of the access token if the settings specify that it should be auto generated

Parameters:

accessTokenDefinition - the active access token definition

accessToken - the access token to set the identifier for

Returns:

the updated access token

Throws:

java.lang.Exception

setPassCodeBasedOnSettings

public com.crm.dataobject.accesstokens.CRMDOAccessToken setPassCodeBasedOnSettings(com.crm.dataobject.accesstokens.CRMDOAccessTokenDefinition accessTokenDefinition,
                                                                                   com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken,
                                                                                   java.lang.Boolean considerSuperUser)
                                                                            throws java.lang.Exception

Sets the pass code of the access token if the settings specify that it should be auto generated

Parameters:

accessTokenDefinition - the active access token definition

accessToken - the access token to set the pass code for

considerSuperUser - a boolean value. if true, the process will validate that the logged user is not a super user before auto generating the pass code. if false, the pass code will be auto generated regardless

Returns:

the updated access token

Throws:

java.lang.Exception

getLockOutTimeStartDate

public java.util.Date getLockOutTimeStartDate(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                       throws java.lang.Exception

Returns the lock out start date period.

Parameters:

accessToken - - the access token to get the date

Returns:

the lock out time start date

Throws:

java.lang.Exception

canBeUsed

public java.lang.Boolean canBeUsed(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                            throws java.lang.Exception

Checks if a access token is in lock out period.

Parameters:

accessToken - - the access token to check

Returns:

true if the access token is in lockout period, false if not

Throws:

java.lang.Exception

isInLockOutPeriod

public java.lang.Boolean isInLockOutPeriod(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
                                    throws java.lang.Exception

Checks if a access token is in lock out period.

Parameters:

accessToken - - the access token to check

Returns:

true if the access token is in lockout period, false if not

Throws:

java.lang.Exception

loadContactAccessTokensToAnonymize

public java.util.ArrayList<java.lang.String> loadContactAccessTokensToAnonymize(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                                                                         throws java.lang.Exception

Loads the given contact information access tokens to anonymize

Parameters:

contact - - the contact information to anonymize its access tokens

Throws:

java.lang.Exception

anonymizeContactAccessTokens

public void anonymizeContactAccessTokens(java.util.ArrayList<java.lang.String> accessTokens)
                                  throws java.lang.Exception

Anonymizes the given contact information access tokens

Parameters:

accessTokens - - the accessTokens to anonymize

Throws:

java.lang.Exception