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.String	decryptPasscode(com.crm.dataobject.accesstokens.CRMDOAccessToken accessToken)
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.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, 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.
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.
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)
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, 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

CRMBOAccessTokenBean

public CRMBOAccessTokenBean()

Default constructor.

Method Detail

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

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.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

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

Throws:

java.lang.Exception

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