atg.projects.store.profile
Class StoreProfileFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.userprofiling.ProfileForm
                      atg.userprofiling.ProfileFormHandler
                          atg.scenario.userprofiling.ScenarioProfileFormHandler
                              atg.commerce.profile.CommerceProfileFormHandler
                                  atg.projects.store.profile.StoreProfileFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.process.ProcessConstants, atg.scenario.ScenarioConstants, atg.scenario.targeting.SlotConstants, java.util.EventListener

Direct Known Subclasses:

CheckoutProfileFormHandler

public class StoreProfileFormHandler
extends atg.commerce.profile.CommerceProfileFormHandler

Profile form handler.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/profile/StoreProfileFormHandler.java#8 $$Change: 799934 $

Author:

ATG

See Also:

CommerceProfileFormHandler

Nested Class Summary

Nested classes/interfaces inherited from class atg.userprofiling.ProfileForm

atg.userprofiling.ProfileForm.ProfileFormHashtableWrapper

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
protected static java.lang.String	DATE_FORMAT
protected static java.lang.String	EDIT_VALUE
protected static java.lang.String	MSG_ALREADY_LOGGEDIN
protected static java.lang.String	MSG_DUPLICATE_ADDRESS_NICKNAME
protected static java.lang.String	MSG_DUPLICATE_CC_NICKNAME
protected static java.lang.String	MSG_DUPLICATE_USER
protected static java.lang.String	MSG_ERR_CREATING_ADDRESS
protected static java.lang.String	MSG_ERR_CREATING_CC
protected static java.lang.String	MSG_ERR_CREATING_EMAIL_RECIPIENT
protected static java.lang.String	MSG_ERR_DELETE_GIFT_ADDRESS
protected static java.lang.String	MSG_ERR_DELETE_SHIPPING_ADDRESS
protected static java.lang.String	MSG_ERR_DELETING_ADDRESS
protected static java.lang.String	MSG_ERR_MODIFYING_NICKNAME
protected static java.lang.String	MSG_ERR_REMOVING_EMAIL_RECIPIENT
protected static java.lang.String	MSG_ERR_SENDING_EMAIL
protected static java.lang.String	MSG_ERR_UPDATING_ADDRESS
protected static java.lang.String	MSG_ERR_UPDATING_CREDIT_CARD
protected static java.lang.String	MSG_ERR_UPDATING_EMAIL_RECIPIENT
protected static java.lang.String	MSG_ERROR_UPDATE_STATUS
protected static java.lang.String	MSG_INVALID_CC
protected static java.lang.String	MSG_INVALID_DATE_ENTERED
protected static java.lang.String	MSG_INVALID_DATE_FORMAT
protected static java.lang.String	MSG_INVALID_EMAIL
protected static java.lang.String	MSG_INVALID_PASSWORD
protected static java.lang.String	MSG_MISSING_CC_PROPERTY
protected static java.lang.String	MSG_MISSING_DEFAULT_CC
protected static java.lang.String	MSG_MISSING_EMAIL
protected static java.lang.String	MSG_STATE_IS_INCORRECT
protected static java.lang.String	MSG_STATE_REQUIRED
protected static java.lang.String	NO
protected static java.lang.String	PARAM_PORTAL_LOGOUT_URL
protected static java.lang.String	RESOURCE_BUNDLE
protected static java.lang.String	SECURITY_STATUS_PROPERTY_NAME
protected static java.lang.String	YES

Fields inherited from class atg.userprofiling.ProfileFormHandler

mClearValuesOnCreate, mClearValuesOnLogin, mClearValuesOnUpdate

Fields inherited from class atg.userprofiling.ProfileForm

CONFIRMPASSWORD_PARAM, DEFAULT_CREATE_PROFILE_TYPE, DEFAULT_LOGIN_PROFILE_TYPE, DEFAULT_LOGOUT_PROFILE_TYPE, HANDLE_CREATE, HANDLE_CREATE_PARAM, HANDLE_FAILURE, HANDLE_LOGIN, HANDLE_LOGIN_PARAM, HANDLE_SUCCESS, ID_NAME, mAuthenticationMessageTrigger, mBadPasswordDelay, mChangePasswordErrorURL, mChangePasswordSuccessURL, mCheckForRequiredParameters, mCheckForRequiredProperties, mCheckForRequiredPropertiesAfterUpdate, mCompareValueInCopyPropertiesOnLogin, mConfirmOldPassword, mConfirmPassword, mCreateErrorURL, mCreateProfileType, mCreateSuccessURL, mDeleteErrorURL, mDeleteSuccessURL, mExpireSessionOnLogout, mExtractDefaultValuesFromProfile, mLoginErrorURL, mLoginProfileType, mLoginSuccessURL, mLogoutErrorURL, mLogoutProfileType, mLogoutSuccessURL, mProfileTools, mPropertiesToAddOnLogin, mPropertiesToCopyOnLogin, mRepositoryId, MSG_ERR_CREATING_PROFILE, MSG_ERR_DELETING_PROFILE, MSG_ERR_UPDATING_PROFILE, MSG_ILLEGAL_ARGUMENT, MSG_INVALID_ADD_PROPERTY, MSG_INVALID_LOGIN, MSG_MISSING_LOGIN, MSG_MISSING_OLD_PASSWORD, MSG_MISSING_PASSWORD, MSG_MISSING_PROFILE, MSG_MISSING_PROFILE_TOOLS, MSG_MISSING_REQUIRED_PROPERTY, MSG_NO_SUCH_PROFILE_PROPERTY, MSG_NO_TYPE_CONVERTER, MSG_PASSWORD_SAME_AS_OLD_PASSWORD, MSG_PASSWORDS_DO_NOT_MATCH, MSG_PERMISSION_DEFINED_PASSWORD_CHANGE, MSG_READ_ONLY_PROFILE_PROPERTY, MSG_TYPE_CONVERSION_ERR, MSG_USER_ALREADY_EXISTS, MSG_WARNING_PROFILE_TOOLS, mSwapEventListeners, mTrimProperties, mUpdateErrorURL, mUpdateSuccessURL, mUserLoginManager, mUsingLdapProfile, mValue, NULL_SENTINEL, OLDPASSWORD_PARAM, REPOSITORY_ID_PROPERTY_NAME, RESOURCE_BUNDLE_NAME, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.scenario.ScenarioConstants

ATTR_SCENARIO_REDIRECT, PROPERTY_REFERENCE_TARGET, PROPERTY_REFERENCE_TYPE, PROPERTY_SCENARIO_INSTANCES, PROPERTY_SLOT_INSTANCES

Fields inherited from interface atg.process.ProcessConstants

COLLECTIVE_CLONE_PROPERTIES, DEFAULT_INITIAL_TIME_DELAY, DEFAULT_MAX_BATCH_SIZE, DEFAULT_PROCESS_FILE_EXTENSION, DEFAULT_TEMPLATE_FILE_EXTENSION, INDIVIDUAL_CLONE_PROPERTIES, INPUT_PORT_BATCH_TIMER, INPUT_PORT_COLLECTIVE_TIMER, INPUT_PORT_DISABLE_PROCESS, INPUT_PORT_GLOBAL_EVENT, INPUT_PORT_INDIVIDUAL_EVENT, INPUT_PORT_INDIVIDUAL_TIMER, INPUT_PORT_MIGRATION_UPDATE, INPUT_PORT_PROCESS_UPDATE, INPUT_PORT_SEGMENT_START_TIMER, JMS_TYPE_BATCH_TIMER, JMS_TYPE_COLLECTIVE_TIMER, JMS_TYPE_DISABLE_PROCESS, JMS_TYPE_INDIVIDUAL_TIMER, JMS_TYPE_MIGRATION_DELETE, JMS_TYPE_MIGRATION_UPDATE, JMS_TYPE_PROCESS_UPDATE, MIGRATION_STATUS_DONE, MIGRATION_STATUS_IN_PROGRESS, OUTPUT_PORT_BATCH_TIMER, OUTPUT_PORT_COLLECTIVE_TIMER, OUTPUT_PORT_INDIVIDUAL_TIMER, OUTPUT_PORT_MIGRATION_UPDATE, OUTPUT_PORT_PROCESS_UPDATE, OUTPUT_PORT_SEGMENT_START_TIMER, PROPERTY_AUTHOR, PROPERTY_COLLECTIVE_INSTANCE, PROPERTY_CONTEXT_BOOLEANS, PROPERTY_CONTEXT_DATES, PROPERTY_CONTEXT_DOUBLES, PROPERTY_CONTEXT_LONGS, PROPERTY_CONTEXT_STRINGS, PROPERTY_COUNT, PROPERTY_CREATED_BY_RECURRING_EVENT, PROPERTY_CREATION_TIME, PROPERTY_CREATOR_ID, PROPERTY_EVENT_TYPE, PROPERTY_ID, PROPERTY_LAST_MODIFIED_BY, PROPERTY_LAST_QUERY_ID, PROPERTY_MESSAGE_BEAN, PROPERTY_MIGRATION_INFO, PROPERTY_MIGRATION_INFOS, PROPERTY_MIGRATION_STATUS, PROPERTY_MODIFICATION_TIME, PROPERTY_NEW_MODIFICATION_TIME, PROPERTY_NUM_TRANSITION_RETRIES, PROPERTY_OLD_MODIFICATION_TIME, PROPERTY_PDL, PROPERTY_PROCESS_INFO, PROPERTY_PROCESS_NAME, PROPERTY_PROCESS_STATUS, PROPERTY_SEGMENT_NAME, PROPERTY_SEGMENT_NAMES, PROPERTY_SERVER_ID, PROPERTY_SERVER_TYPE, PROPERTY_STATE, PROPERTY_STATE_MACHINE_VERSION, PROPERTY_STEP, PROPERTY_SUBJECT, PROPERTY_TEMPLATE_NAME, STEP_ACTIONS_1, STEP_ACTIONS_2, STEP_NEXT_STATE_1, STEP_NEXT_STATE_2, UNDEFINED_TIMESTAMP_VALUE, WILDCARD_MATCH_ALL

Fields inherited from interface atg.scenario.targeting.SlotConstants

PROFILE_SLOT_TYPE, PROPERTY_ID, PROPERTY_SLOT_ITEMS, PROPERTY_SLOT_NAME, PROPERTY_SLOT_OFFSET, PROPERTY_SLOT_PRIORITIES, PROPERTY_SLOT_PROFILE, TRANS_MGR

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

StoreProfileFormHandler()

Method Summary

protected void	addCreditCardFormException(java.util.ResourceBundle pBundle, int pReturnCode) Adds form exception with the message according to the specified parameters
protected void	addFormException(java.lang.String pWhatException, java.lang.Object[] pArgs, atg.repository.RepositoryException pRepositoryExc, atg.servlet.DynamoHttpServletRequest pRequest) Create a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).
protected void	addFormException(java.lang.String pWhatException, java.lang.Object[] pArgs, java.lang.String pPath, atg.servlet.DynamoHttpServletRequest pRequest) Creates a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).
protected void	addFormException(java.lang.String pWhatException, atg.repository.RepositoryException pRepositoryExc, atg.servlet.DynamoHttpServletRequest pRequest) Create a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).
protected void	addFormException(java.lang.String pWhatException, java.lang.String pPath, atg.servlet.DynamoHttpServletRequest pRequest) Creates a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).
protected atg.repository.RepositoryItem	findCurrentCreditCard() Searches current user's credit card by nick-name from editValue properties.
protected atg.repository.RepositoryItem	findUser(java.lang.String pLogin, java.lang.String pPassword, atg.repository.Repository pProfileRepository, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Returns the user profile or null if the user could not be found with the given login and password.
java.util.List	getAddCommerceItemInfos()
java.lang.String	getAddressIdValueMapKey()
java.lang.String[]	getAddressProperties()
java.lang.String	getAnonymousEmailAddress()
java.util.Map	getBillAddrValue()
java.util.List	getBillingAddressPropertyList() Returns the BillingAddressPropertyList.
java.util.Date	getBirthDate() Returns birthDate property.
java.lang.String[]	getCardProperties()
CheckoutProgressStates	getCheckoutProgressStates() Get checkout progress states
java.lang.String	getCreateCardErrorURL()
java.lang.String	getCreateCardSuccessURL()
atg.payment.creditcard.ExtendableCreditCardTools	getCreditCardTools()
atg.service.util.CurrentDate	getCurrentDate()
java.lang.String	getDate() Returns property date.
protected java.lang.String	getDateByFormat(java.lang.Object pDate, java.lang.String pFormat) Operation called to get the Date on the basis of locale format.
java.lang.String	getDateFormat()
java.lang.String	getDateOfBirth()
java.lang.String	getDefaultCard() Returns property editCard, naming the credit card to be edited.
java.lang.String	getDefaultCardErrorURL()
java.lang.String	getDefaultCardSuccessURL()
java.lang.String	getDefaultShippingAddress()
java.lang.String	getEditAddress()
java.lang.String	getEditCard() Returns property editCard, naming the credit card to be edited.
java.util.Map<java.lang.String,java.lang.Object>	getEditValue()
java.lang.String	getEmailAddress()
atg.commerce.gifts.GiftlistManager	getGiftlistManager()
java.lang.String[]	getImmutableCardProperties() Returns immutableCardProperties property value.
protected java.util.Locale	getLocale(atg.servlet.DynamoHttpServletRequest pRequest) Determine the user's current locale, if available.
java.lang.String	getLoginEmailAddress()
java.lang.String	getMonth() Returns property month.
java.lang.String	getNewAddressErrorURL()
java.lang.String	getNewAddressId()
java.lang.String	getNewAddressSuccessURL()
java.lang.String	getNewCustomerEmailAddress()
java.lang.String	getNewNicknameValueMapKey()
java.lang.String	getNicknameValueMapKey()
atg.commerce.order.Order	getOrder() Return the Order property.
java.lang.String	getPreRegisterErrorURL()
java.lang.String	getPreRegisterSuccessURL()
java.lang.String	getPreviousEmailAddress()
java.util.List<atg.repository.RepositoryItem>	getRecentlyViewedProducts() Gets a recently viewed products list.
java.lang.String	getRemoveAddress()
java.lang.String	getRemoveCard()
java.lang.String	getRemoveCardErrorURL()
java.lang.String	getRemoveCardSuccessURL()
java.util.List	getRequiredBillingAddressPropertyList()
static java.util.ResourceBundle	getResourceBundle(java.util.Locale pLocale) Returns a ResourceBundle specific for the given locale.
SessionBean	getSessionBean()
java.lang.String	getShippingAddressNicknameMapKey()
atg.commerce.order.purchase.ShippingGroupMapContainer	getShippingGroupMapContainer() Return the ShippingGroupMapContainer property.
java.lang.String	getSourceCode()
protected StorePropertyManager	getStorePropertyManager() Utility method to retrieve the StorePropertyManager.
static java.lang.String	getString(java.lang.String pKey, java.util.Locale pLocale) Return a String message specific for the given locale.
atg.userprofiling.email.TemplateEmailInfo	getTemplateEmailInfo()
atg.userprofiling.email.TemplateEmailSender	getTemplateEmailSender()
java.lang.String	getUpdateAddressErrorURL()
java.lang.String	getUpdateAddressSuccessURL()
java.lang.String	getUpdateCardErrorURL() Returns property updateCardErrorURL, used to redirect user in case of an error updating a new credit card.
java.lang.String	getUpdateCardSuccessURL() Returns property updateCardSuccessURL.
protected java.util.Locale	getUserLocale(atg.servlet.DynamoHttpServletRequest pRequest) Returns the Locale for the user given the request.
java.lang.String	getYear() Returns property year.
boolean	handleCheckoutDefaults(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Handles changes on the 'Checkout Defaults' page - default credit card, shipping address and shipping method.
boolean	handleClear(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Override to prevent clear if there are form errors.
boolean	handleClearForm(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Override to prevent clear if there are form errors.
boolean	handleCreateNewCreditCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Creates a new credit card using the entries entered in the editValue map
boolean	handleCreateNewCreditCardAndAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Creates a new credit card using the entries entered in the editValue map
boolean	handleDefaultCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Deprecated.
boolean	handleDefaultShippingAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Deprecated.
boolean	handleEditAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Copy the named address into the editValue map, allowing the user to edit it.
boolean	handleEditCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Copy the named credit card into the editValue map, allowing the user to edit them.
boolean	handleNewAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Creates a new shipping address using the entries entered in the editValue map.
boolean	handlePreRegister(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Perform pre-registration actions before user actually registered.
boolean	handleRemoveAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This handler deletes a secondary address named in the removeAddress property.
boolean	handleRemoveCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Removes specified in removeCard property credit card from user's credit cards map.
boolean	handleUpdateAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Update the secondary address as modified by the user.
boolean	handleUpdateCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Updates the credit card as modified by the user.
boolean	isEmailOptIn()
boolean	isPersistEmails() Returns boolean indicating whether the email is persisted before it is sent.
boolean	isPreviousOptInStatus()
boolean	isSendEmailInSeparateThread() Returns boolean indicating whether the email is sent in a separate thread.
boolean	isUseShippingAddressAsDefault()
protected void	postChangePassword(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just after the user's password is changed.
protected void	postCreateNewCreditCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation is called just after new card with existing address be created
protected void	postCreateNewCreditCardAndAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation is called just after new card with new address be created
protected void	postCreateUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Override OOTB method so that if the profile has receiveEmail=yes, create an EmailRecipient repository item for Email Campaigns.
protected void	postLoginAddRecentlyViewed(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Update the logged in user's recentlyViewedProducts property with products viewed as an anonymous user.
protected void	postLoginUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) After logging in the user's session cached promotions are reloaded into the PricingModelHolder.
void	postLogoutUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just after the user is logged out.
protected void	postUpdateUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
protected void	preCreateNewCreditCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation is called just before new card with existing address be created
protected void	preCreateNewCreditCardAndAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation is called just before new card with new address be created
protected void	preCreateUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just before the user creation process is started.
protected void	preLoginUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Override OOTB method so that auto-logged in user is not logged out if they provide an invalid password.
void	preRemoveAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Address that we'd like to remove could be associated with a gift list.
protected void	preUpdateCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Called before handleUpdateCard logic is applied.
protected void	preUpdateUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This overriding method will check to see if a new email address that is being submitted in an update already belongs to another user profile.
protected void	sendEmail(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Send email to current user using configured TemplateEmailInfo and TemplateEmailSender.
void	setAddCommerceItemInfos(java.util.List pAddCommerceItemInfos)
void	setAddressIdValueMapKey(java.lang.String pAddressIdValueMapKey)
void	setAddressProperties(java.lang.String[] pAddressProperties) Sets property addressProperties, naming the properties in a secondary address record.
void	setAnonymousEmailAddress(java.lang.String pAnonymousEmailAddress)
void	setBillingAddressPropertyList(java.util.List pBillingAddressPropertyList) Sets the Address property list, which is a list that mirrors the original design of the AddressProperties property with the property names defined in a configuration file.
void	setBirthDate(java.util.Date pBirthDate) Sets birthDate property.
void	setCardProperties(java.lang.String[] pCardProperties) Sets property cardProperties, naming the properties in a credit card entry.
void	setCheckoutProgressStates(CheckoutProgressStates pCheckoutProgressStates) Set checkout progress states
void	setCreateCardErrorURL(java.lang.String pCreateCardErrorURL) Sets property createCardErrorURL, used to redirect user in case of an error adding a new credit card.
void	setCreateCardSuccessURL(java.lang.String pCreateCardSuccessURL) Sets property createCardSuccessURL, used to redirect user if a new credit card was successfully added.
void	setCreditCardTools(atg.payment.creditcard.ExtendableCreditCardTools pCreditCardTools)
void	setCurrentDate(atg.service.util.CurrentDate pCurrentDate)
void	setDate(java.lang.String pDate) Sets property date.
void	setDateFormat(java.lang.String pDateFormat)
void	setDateOfBirth(java.lang.String pDateOfBirth)
void	setDefaultCard(java.lang.String pDefaultCard) Sets property efaultCard, naming the credit card to be the default.
void	setDefaultCardErrorURL(java.lang.String pDefaultCardErrorURL) Sets property DefaultCardErrorURL, used to redirect user in case of an error removing a credit card.
void	setDefaultCardSuccessURL(java.lang.String pDefaultCardSuccessURL) Sets property DefaultCardSuccessURL, used to redirect user when a credit card is successfully removed.
void	setDefaultShippingAddress(java.lang.String pDefaultShippingAddress)
void	setEditAddress(java.lang.String pEditAddress) Sets property editAddress, naming the address to be edited
void	setEditCard(java.lang.String pEditCard) Sets property editCard, naming the credit card to be edited.
void	setEmailAddress(java.lang.String pEmailAddress)
void	setEmailOptIn(boolean pEmailOptIn)
void	setGiftlistManager(atg.commerce.gifts.GiftlistManager pGiftlistManager)
void	setImmutableCardProperties(java.lang.String[] pImmutableCardProperties) Sets immutableCardProperties property value.
void	setLoginEmailAddress(java.lang.String pLoginEmailAddress)
void	setMonth(java.lang.String pMonth) Sets property month.
void	setNewAddressErrorURL(java.lang.String pNewAddressErrorURL) Sets property newAddressErrorURL, used to redirect user in case of an error creating an address.
void	setNewAddressId(java.lang.String pNewAddressId)
void	setNewAddressSuccessURL(java.lang.String pNewAddressSuccessURL) Sets property newAddressSuccessURL, used to redirect user after successfully creating an address.
void	setNewCustomerEmailAddress(java.lang.String pNewCustomerEmailAddress)
void	setNewNicknameValueMapKey(java.lang.String pNewNicknameValueMapKey)
void	setNicknameValueMapKey(java.lang.String pNicknameValueMapKey)
void	setOrder(atg.commerce.order.Order pOrder) Set the Order property.
void	setPersistEmails(boolean pPersistEmails) Sets boolean indicating whether the email is persisted before it is sent.
void	setPreRegisterErrorURL(java.lang.String pPreRegisterErrorURL)
void	setPreRegisterSuccessURL(java.lang.String pPreRegisterSuccessURL)
void	setPreviousEmailAddress(java.lang.String pPreviousEmailAddress)
void	setPreviousOptInStatus(boolean pPreviousOptInStatus)
void	setRecentlyViewedProducts(java.util.List<atg.repository.RepositoryItem> pRecentlyViewedProducts) Sets a recently viewed products list.
void	setRemoveAddress(java.lang.String pRemoveAddress) Sets property removeAddress, naming the address to be removed by handleRemoveAddress().
void	setRemoveCard(java.lang.String pRemoveCard) Sets property removeCard, naming the address to be removed by handleRemoveCard().
void	setRemoveCardErrorURL(java.lang.String pRemoveCardErrorURL) Sets property RemoveCardErrorURL, used to redirect user in case of an error removing a credit card.
void	setRemoveCardSuccessURL(java.lang.String pRemoveCardSuccessURL) Sets property removeCardSuccessURL, used to redirect user when a credit card is successfully removed.
void	setRequiredBillingAddressPropertyList(java.util.List pRequiredBillingAddressPropertyList)
void	setSendEmailInSeparateThread(boolean pSendEmailInSeparateThread) Sets boolean indicating whether the email is sent in a separate thread.
void	setSessionBean(SessionBean pSessionBean)
void	setShippingAddressNicknameMapKey(java.lang.String pShippingAddressNicknameMapKey)
void	setShippingGroupMapContainer(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer) Set the ShippingGroupMapContainer property.
void	setSourceCode(java.lang.String pSourceCode)
void	setTemplateEmailInfo(atg.userprofiling.email.TemplateEmailInfo pTemplateEmailInfo)
void	setTemplateEmailSender(atg.userprofiling.email.TemplateEmailSender pTemplateEmailSender) Sets the property TemplateEmailSender
void	setUpdateAddressErrorURL(java.lang.String pUpdateAddressErrorURL) Sets property updateAddressErrorURL, used to redirect user in case of an error updating an address.
void	setUpdateAddressSuccessURL(java.lang.String pUpdateAddressSuccessURL) Sets property updateAddressSuccessURL, used to redirect user when an address is successfully updated.
void	setUpdateCardErrorURL(java.lang.String pUpdateCardErrorURL) Sets property updateCardErrorURL, used to redirect user in case of an error updating a new credit card.
void	setUpdateCardSuccessURL(java.lang.String pUpdateCardSuccessURL) Sets property updateCardSuccessURL.
void	setUseShippingAddressAsDefault(boolean pUseShippingAddressAsDefault)
void	setYear(java.lang.String pYear) Sets property year.
protected void	updateSecondaryInfo(atg.core.util.Address pTargetAddress, atg.core.util.Address pSourceAddress) Updates the properties of an address that don't affect where the item is shipped to - e.g the phone number.
protected boolean	validateAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validates new address fields entered by user: all required fields are specified for new address country/state combination is valid for new address not duplicate address nickname is used for create address or update address operation
protected boolean	validateBillingAddressFields(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validates that all required fields are entered for billing address
protected void	validateBirthDate(atg.servlet.DynamoHttpServletRequest pRequest) Validates the values of the mBirthDate property.
protected void	validateCountryStateCombination(java.util.Map pAddress, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validate country-state combination.
protected void	validateCountryStateCombination(java.lang.String pCountry, java.lang.String pState, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validate country-state combination.
protected boolean	validateCreateCreditCardInformation(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse, boolean pIsNewAddress) Validates credit card information entered by user: all required fields are specified for credit card all required fields are specified for new address country/state combination is valid for new address card number and expiry date are valid not duplicate credit card nickname is used
protected boolean	validateCreditCard(java.util.Map pCard, java.util.ResourceBundle pBundle) Validates the credit card information using CreditCardTools.
protected boolean	validateCreditCardFields(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validates that all required credit card's fields are entered by user
protected java.util.Date	validateDateFormat(java.lang.String pDate, java.lang.String pFormat) Operation called to validate the Date on the basis of locale format
protected boolean	validateUpdateCreditCardInformation(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validates updated credit card information entered by user: country/state combination is valid for billing address card expiry date are valid not duplicate credit card nickname is used

Methods inherited from class atg.commerce.profile.CommerceProfileFormHandler

addProperty, copyProperty, formatUserMessage, getAddCostCenterDescription, getAddCostCenterErrorURL, getAddCostCenterIdentifier, getAddCostCenterSuccessURL, getCatalogTools, getDefaultLocale, getEditCostCenterDescription, getEditCostCenterErrorURL, getEditCostCenterIdentifier, getEditCostCenterSuccessURL, getOrderManager, getPriceListManager, getPricingTools, getPromotionTools, getRemoveCostCenterErrorURL, getRemoveCostCenterIdentifier, getRemoveCostCenterSuccessURL, getShoppingCart, getUserLocale, getUserPricingModels, handleAddCostCenter, handleEditCostCenter, handleRemoveCostCenter, isDefaultCostCenter, isDetermineCatalog, isDeterminePriceList, processException, setAddCostCenterDescription, setAddCostCenterErrorURL, setAddCostCenterIdentifier, setAddCostCenterSuccessURL, setCatalogTools, setDefaultCostCenter, setDefaultLocale, setDetermineCatalog, setDeterminePriceList, setEditCostCenterDescription, setEditCostCenterErrorURL, setEditCostCenterIdentifier, setEditCostCenterSuccessURL, setOrderManager, setPriceListManager, setPricingTools, setPromotionTools, setRemoveCostCenterErrorURL, setRemoveCostCenterIdentifier, setRemoveCostCenterSuccessURL, setShoppingCart, setUserPricingModels

Methods inherited from class atg.scenario.userprofiling.ScenarioProfileFormHandler

addScenarioInstances, addSlotInstances, getScenarioManager, handleCreate, handleDelete, handleLogin, handleLogout, handleUpdate, isOverrideFormHandlerRedirect, setOverrideFormHandlerRedirect, setScenarioManager

Methods inherited from class atg.userprofiling.ProfileFormHandler

addProfileUpdateListener, checkFormError, createProfileItem, getClearValuesOnCreate, getClearValuesOnLogin, getClearValuesOnUpdate, getExpiredPasswordService, getProfile, getProfileUpdateEvent, getProfileUpdateTrigger, getRepositoryId, getRequestLocale, getTestPassword, getUpdateRepositoryId, getVerifyPasswordSuccessURL, handleCancel, handleVerifyPassword, isCreateNewUser, isGenerateProfileUpdateEvents, isSendCookie, preLogoutUser, propagateLocale, removeProfileUpdateListener, sendProfileUpdateEvent, setClearValuesOnCreate, setClearValuesOnLogin, setClearValuesOnUpdate, setCreateNewUser, setExpiredPasswordService, setGenerateProfileUpdateEvents, setProfile, setProfileUpdateEvent, setProfileUpdateTrigger, setRepositoryId, setRequestLocale, setTestPassword, setUpdateRepositoryId, setVerifyPasswordSuccessURL, shouldCreateNewUser

Methods inherited from class atg.userprofiling.ProfileForm

addMulti, addPropertiesOnLogin, addSwapEventListener, addUser, changePassword, checkFormSuccess, checkForRequiredParameters, checkForRequiredProperties, checkForRequiredProperties, commitTransaction, copyPropertiesOnLogin, copyPropertyValue, createUser, doStartService, ensureTransaction, findUser, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getAddMultiPropertyName, getAddMultiPropertyValue, getAuthenticationMessageTrigger, getBadPasswordDelay, getChangePasswordErrorURL, getChangePasswordSuccessURL, getCheckForRequiredParameters, getCheckForRequiredProperties, getCheckForRequiredPropertiesAfterUpdate, getCreateErrorURL, getCreateProfileType, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getDescriptor, getExpireSessionOnLogout, getLoginErrorURL, getLoginProfileType, getLoginSuccessURL, getLogoutErrorURL, getLogoutProfileType, getLogoutSuccessURL, getProcessPropertyNames, getProfileItem, getProfileRealmManager, getProfileTools, getPropertiesToAddOnLogin, getPropertiesToCopyOnLogin, getRealmSessionTracker, getRealmSessionTrackerName, getStringValueProperty, getTransactionDemarcation, getTransactionManager, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getUserLoginManager, getValue, getValueFromArrayString, getValueFromObject, getValueFromObjectArray, getValueFromString, getValueFromStringArray, getValueMap, getValueProperty, handleAddMulti, handleChangePassword, handleValueDictionaryByParameters, isCompareValueInCopyPropertiesOnLogin, isConfirmOldPassword, isConfirmPassword, isExtractDefaultValuesFromProfile, isInvalidateAllChildSessions, isTrimProperty, isUsingLdapProfile, postAddMulti, postDeleteUser, postValueDictionaryByParameters, preAddMulti, preChangePassword, preDeleteUser, preValueDictionaryByParameters, removeSwapEventListener, removeUser, sendProfileSwapEvent, setAuthenticationMessageTrigger, setBadPasswordDelay, setChangePasswordErrorURL, setChangePasswordSuccessURL, setCheckForRequiredParameters, setCheckForRequiredProperties, setCheckForRequiredPropertiesAfterUpdate, setCompareValueInCopyPropertiesOnLogin, setConfirmOldPassword, setConfirmPassword, setCreateErrorURL, setCreateProfileType, setCreateSuccessURL, setDeleteErrorURL, setDeleteSuccessURL, setExpireSessionOnLogout, setExtractDefaultValuesFromProfile, setInvalidateAllChildSessions, setLoginErrorURL, setLoginProfileType, setLoginSuccessURL, setLogoutErrorURL, setLogoutProfileType, setLogoutSuccessURL, setProfileTools, setPropertiesToAddOnLogin, setPropertiesToCopyOnLogin, setRealmSessionTrackerName, setTrimProperties, setUpdateErrorURL, setUpdateSuccessURL, setUserLoginManager, setUsingLdapProfile, setValueDictionaryByParameters, setValueProperty, updateLDAPProfileAttributes, updatePasswordValue, updateProfileAttributes, updateProfileAttributes, updateUser, updateUser, userAlreadyExists, valueIsEmpty

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

SECURITY_STATUS_PROPERTY_NAME

protected static final java.lang.String SECURITY_STATUS_PROPERTY_NAME

See Also:

Constant Field Values

NO

protected static final java.lang.String NO

See Also:

Constant Field Values

YES

protected static final java.lang.String YES

See Also:

Constant Field Values

RESOURCE_BUNDLE

protected static final java.lang.String RESOURCE_BUNDLE

See Also:

Constant Field Values

MSG_ERR_SENDING_EMAIL

protected static final java.lang.String MSG_ERR_SENDING_EMAIL

See Also:

Constant Field Values

MSG_ERR_CREATING_ADDRESS

protected static final java.lang.String MSG_ERR_CREATING_ADDRESS

See Also:

Constant Field Values

MSG_ERR_DELETING_ADDRESS

protected static final java.lang.String MSG_ERR_DELETING_ADDRESS

See Also:

Constant Field Values

MSG_ERR_UPDATING_ADDRESS

protected static final java.lang.String MSG_ERR_UPDATING_ADDRESS

See Also:

Constant Field Values

MSG_DUPLICATE_ADDRESS_NICKNAME

protected static final java.lang.String MSG_DUPLICATE_ADDRESS_NICKNAME

See Also:

Constant Field Values

MSG_ERR_MODIFYING_NICKNAME

protected static final java.lang.String MSG_ERR_MODIFYING_NICKNAME

See Also:

Constant Field Values

MSG_ERR_CREATING_CC

protected static final java.lang.String MSG_ERR_CREATING_CC

See Also:

Constant Field Values

MSG_ERR_UPDATING_CREDIT_CARD

protected static final java.lang.String MSG_ERR_UPDATING_CREDIT_CARD

See Also:

Constant Field Values

MSG_MISSING_CC_PROPERTY

protected static final java.lang.String MSG_MISSING_CC_PROPERTY

See Also:

Constant Field Values

MSG_DUPLICATE_CC_NICKNAME

protected static final java.lang.String MSG_DUPLICATE_CC_NICKNAME

See Also:

Constant Field Values

MSG_INVALID_CC

protected static final java.lang.String MSG_INVALID_CC

See Also:

Constant Field Values

MSG_MISSING_DEFAULT_CC

protected static final java.lang.String MSG_MISSING_DEFAULT_CC

See Also:

Constant Field Values

MSG_DUPLICATE_USER

protected static final java.lang.String MSG_DUPLICATE_USER

See Also:

Constant Field Values

MSG_ERR_CREATING_EMAIL_RECIPIENT

protected static final java.lang.String MSG_ERR_CREATING_EMAIL_RECIPIENT

See Also:

Constant Field Values

MSG_ERR_REMOVING_EMAIL_RECIPIENT

protected static final java.lang.String MSG_ERR_REMOVING_EMAIL_RECIPIENT

See Also:

Constant Field Values

MSG_ERR_UPDATING_EMAIL_RECIPIENT

protected static final java.lang.String MSG_ERR_UPDATING_EMAIL_RECIPIENT

See Also:

Constant Field Values

MSG_INVALID_PASSWORD

protected static final java.lang.String MSG_INVALID_PASSWORD

See Also:

Constant Field Values

MSG_ALREADY_LOGGEDIN

protected static final java.lang.String MSG_ALREADY_LOGGEDIN

See Also:

Constant Field Values

MSG_MISSING_EMAIL

protected static final java.lang.String MSG_MISSING_EMAIL

See Also:

Constant Field Values

MSG_ERROR_UPDATE_STATUS

protected static final java.lang.String MSG_ERROR_UPDATE_STATUS

See Also:

Constant Field Values

MSG_INVALID_EMAIL

protected static final java.lang.String MSG_INVALID_EMAIL

See Also:

Constant Field Values

MSG_STATE_REQUIRED

protected static final java.lang.String MSG_STATE_REQUIRED

See Also:

Constant Field Values

MSG_STATE_IS_INCORRECT

protected static final java.lang.String MSG_STATE_IS_INCORRECT

See Also:

Constant Field Values

MSG_INVALID_DATE_FORMAT

protected static final java.lang.String MSG_INVALID_DATE_FORMAT

See Also:

Constant Field Values

MSG_ERR_DELETE_GIFT_ADDRESS

protected static final java.lang.String MSG_ERR_DELETE_GIFT_ADDRESS

See Also:

Constant Field Values

MSG_ERR_DELETE_SHIPPING_ADDRESS

protected static final java.lang.String MSG_ERR_DELETE_SHIPPING_ADDRESS

See Also:

Constant Field Values

MSG_INVALID_DATE_ENTERED

protected static final java.lang.String MSG_INVALID_DATE_ENTERED

See Also:

Constant Field Values

PARAM_PORTAL_LOGOUT_URL

protected static final java.lang.String PARAM_PORTAL_LOGOUT_URL

See Also:

Constant Field Values

DATE_FORMAT

protected static final java.lang.String DATE_FORMAT

See Also:

Constant Field Values

EDIT_VALUE

protected static final java.lang.String EDIT_VALUE

See Also:

Constant Field Values

Constructor Detail

StoreProfileFormHandler

public StoreProfileFormHandler()

Method Detail

getCheckoutProgressStates

public CheckoutProgressStates getCheckoutProgressStates()

Get checkout progress states

Returns:

the checkoutProgressStates

setCheckoutProgressStates

public void setCheckoutProgressStates(CheckoutProgressStates pCheckoutProgressStates)

Set checkout progress states

Parameters:

pCheckoutProgressStates - the checkoutProgressStates to set

setSendEmailInSeparateThread

public void setSendEmailInSeparateThread(boolean pSendEmailInSeparateThread)

Sets boolean indicating whether the email is sent in a separate thread.

Parameters:

pSendEmailInSeparateThread - boolean indicating whether the email is sent in a separate thread.

isSendEmailInSeparateThread

public boolean isSendEmailInSeparateThread()

Returns boolean indicating whether the email is sent in a separate thread.

setPersistEmails

public void setPersistEmails(boolean pPersistEmails)

Sets boolean indicating whether the email is persisted before it is sent.

Parameters:

pPersistEmails - boolean indicating whether the email is persisted before it is sent.

isPersistEmails

public boolean isPersistEmails()

Returns boolean indicating whether the email is persisted before it is sent.

setTemplateEmailSender

public void setTemplateEmailSender(atg.userprofiling.email.TemplateEmailSender pTemplateEmailSender)

Sets the property TemplateEmailSender

getTemplateEmailSender

public atg.userprofiling.email.TemplateEmailSender getTemplateEmailSender()

Returns:

The value of the property TemplateEmailSender

getTemplateEmailInfo

public atg.userprofiling.email.TemplateEmailInfo getTemplateEmailInfo()

Returns:

the templateEmailInfo

setTemplateEmailInfo

public void setTemplateEmailInfo(atg.userprofiling.email.TemplateEmailInfo pTemplateEmailInfo)

Parameters:

pTemplateEmailInfo - the templateEmailInfo to set

getSessionBean

public SessionBean getSessionBean()

Returns:

the session bean

setSessionBean

public void setSessionBean(SessionBean pSessionBean)

Parameters:

pSessionBean - the session bean to set

getGiftlistManager

public atg.commerce.gifts.GiftlistManager getGiftlistManager()

Returns:

the giftlist manager

setGiftlistManager

public void setGiftlistManager(atg.commerce.gifts.GiftlistManager pGiftlistManager)

Parameters:

pGiftlistManager - the giftlist manager to set

getNicknameValueMapKey

public java.lang.String getNicknameValueMapKey()

Returns:

A value that indicates the nickname of the address in the editValues map.

setNicknameValueMapKey

public void setNicknameValueMapKey(java.lang.String pNicknameValueMapKey)

Parameters:

pNicknameValueMapKey - the String to set

getAddressIdValueMapKey

public java.lang.String getAddressIdValueMapKey()

Returns:

The value located under this key will be used to check whether the address being updated is the default address.

setAddressIdValueMapKey

public void setAddressIdValueMapKey(java.lang.String pAddressIdValueMapKey)

Parameters:

pAddressIdValueMapKey - the String to set

getNewNicknameValueMapKey

public java.lang.String getNewNicknameValueMapKey()

Returns:

the String

setNewNicknameValueMapKey

public void setNewNicknameValueMapKey(java.lang.String pNewNicknameValueMapKey)

Parameters:

pNewNicknameValueMapKey - the String to set

getShippingAddressNicknameMapKey

public java.lang.String getShippingAddressNicknameMapKey()

Returns:

the String

setShippingAddressNicknameMapKey

public void setShippingAddressNicknameMapKey(java.lang.String pShippingAddressNicknameMapKey)

Parameters:

pShippingAddressNicknameMapKey - the String to set

getEditValue

public java.util.Map<java.lang.String,java.lang.Object> getEditValue()

Returns:

This is a map that stores the pending values for an editing operations on the B2CStore profile.

setAddressProperties

public void setAddressProperties(java.lang.String[] pAddressProperties)

Sets property addressProperties, naming the properties in a secondary address record.

Parameters:

pAddressProperties - the addressProperties to set

getAddressProperties

public java.lang.String[] getAddressProperties()

Returns:

List of address properties that are available in a secondaryAddress (profile address).

setCardProperties

public void setCardProperties(java.lang.String[] pCardProperties)

Sets property cardProperties, naming the properties in a credit card entry.

Parameters:

pCardProperties - the cardProperties to set

getCardProperties

public java.lang.String[] getCardProperties()

Returns:

property cardProperties, naming the properties in a credit card entry.

getImmutableCardProperties

public java.lang.String[] getImmutableCardProperties()

Returns immutableCardProperties property value. This property contains names of credit card's immutable properties. By default CC number and it's type are immutable.

Returns:

immutableCardProperties

setImmutableCardProperties

public void setImmutableCardProperties(java.lang.String[] pImmutableCardProperties)

Sets immutableCardProperties property value.

Parameters:

pImmutableCardProperties - property names to be immutable.

setRemoveAddress

public void setRemoveAddress(java.lang.String pRemoveAddress)

Sets property removeAddress, naming the address to be removed by handleRemoveAddress().

Parameters:

pRemoveAddress - the removeAddress to set

getRemoveAddress

public java.lang.String getRemoveAddress()

Returns:

property removeAddress, naming the address to be removed by handleRemoveAddress().

setEditAddress

public void setEditAddress(java.lang.String pEditAddress)

Sets property editAddress, naming the address to be edited

Parameters:

pEditAddress - the editAddress to set

getEditAddress

public java.lang.String getEditAddress()

Returns:

property editAddress, naming the address to be edited

setRemoveCard

public void setRemoveCard(java.lang.String pRemoveCard)

Sets property removeCard, naming the address to be removed by handleRemoveCard().

Parameters:

pRemoveCard - the removeCard to set

getRemoveCard

public java.lang.String getRemoveCard()

Returns:

property removeCard, naming the address to be removed by handleRemoveCard().

getDateOfBirth

public java.lang.String getDateOfBirth()

Returns:

date of birth.

setDateOfBirth

public void setDateOfBirth(java.lang.String pDateOfBirth)

Parameters:

pDateOfBirth - Set a new date of birth.

setMonth

public void setMonth(java.lang.String pMonth)

Sets property month.

Parameters:

pMonth - The property to store the month value of the birth date.

getMonth

public java.lang.String getMonth()

Returns property month.

Returns:

The value of the property month.

setDate

public void setDate(java.lang.String pDate)

Sets property date.

Parameters:

pDay - The property to store the day of the month value of the birth date.

getDate

public java.lang.String getDate()

Returns property date.

Returns:

The value of the property day.

setYear

public void setYear(java.lang.String pYear)

Sets property year.

Parameters:

pYear - The property to store the year value of the birth date.

getYear

public java.lang.String getYear()

Returns property year.

Returns:

The value of the property year.

setBirthDate

public void setBirthDate(java.util.Date pBirthDate)

Sets birthDate property.

Parameters:

pBirthDate - The property to store the event date as a Calendar object.

getBirthDate

public java.util.Date getBirthDate()
                            throws atg.commerce.gifts.InvalidDateException

Returns birthDate property.

Returns:

The value of the property birthDate.

Throws:

atg.commerce.gifts.InvalidDateException - if an invalid date was entered.

getDateFormat

public java.lang.String getDateFormat()

Returns:

date format.

setDateFormat

public void setDateFormat(java.lang.String pDateFormat)

Parameters:

pDateFormat - - date format.

setBillingAddressPropertyList

public void setBillingAddressPropertyList(java.util.List pBillingAddressPropertyList)

Sets the Address property list, which is a list that mirrors the original design of the AddressProperties property with the property names defined in a configuration file. This List will be created by the initializeAddressPropertyList method creating the appropriate list containing the values from the property manager.

Parameters:

pBillingAddressPropertyList - - Billing address property list

getBillingAddressPropertyList

public java.util.List getBillingAddressPropertyList()

Returns the BillingAddressPropertyList.

Returns:

a List that contains the Address properties that are available

setDefaultCard

public void setDefaultCard(java.lang.String pDefaultCard)

Sets property efaultCard, naming the credit card to be the default.

Parameters:

pDefaultCard - - nickname of default credit card

getDefaultCard

public java.lang.String getDefaultCard()

Returns property editCard, naming the credit card to be edited.

Returns:

Default credit card nickname

setEditCard

public void setEditCard(java.lang.String pEditCard)

Sets property editCard, naming the credit card to be edited.

Parameters:

pEditCard - - nickname of card being edited

getEditCard

public java.lang.String getEditCard()

Returns property editCard, naming the credit card to be edited.

Returns:

The nickname of the credit card being edited

getBillAddrValue

public java.util.Map getBillAddrValue()

Returns:

The value of the property EditValue. This is a map that stores the pending values for an editing operations on the B2CStore profile.

setDefaultShippingAddress

public void setDefaultShippingAddress(java.lang.String pDefaultShippingAddress)

Parameters:

pDefaultShippingAddress - - default shipping address.

getDefaultShippingAddress

public java.lang.String getDefaultShippingAddress()

Returns:

default shipping address.

isUseShippingAddressAsDefault

public boolean isUseShippingAddressAsDefault()

Returns:

mUseShippingAddressAsDefault

setUseShippingAddressAsDefault

public void setUseShippingAddressAsDefault(boolean pUseShippingAddressAsDefault)

Parameters:

pUseShippingAddressAsDefault - the boolean value to set

getSourceCode

public java.lang.String getSourceCode()

Returns:

source code.

setSourceCode

public void setSourceCode(java.lang.String pSourceCode)

Parameters:

pSourceCode - - source code.

getLoginEmailAddress

public java.lang.String getLoginEmailAddress()

Returns:

login e-mail address.

setLoginEmailAddress

public void setLoginEmailAddress(java.lang.String pLoginEmailAddress)

Parameters:

pLoginEmailAddress - - login e-mail address.

getEmailAddress

public java.lang.String getEmailAddress()

Returns:

e-mail address.

setEmailAddress

public void setEmailAddress(java.lang.String pEmailAddress)

Parameters:

pEmailAddress - - e-mail address.

getNewCustomerEmailAddress

public java.lang.String getNewCustomerEmailAddress()

Returns:

new customer email address

setNewCustomerEmailAddress

public void setNewCustomerEmailAddress(java.lang.String pNewCustomerEmailAddress)

Parameters:

pNewCustomerEmailAddress - email address

getAnonymousEmailAddress

public java.lang.String getAnonymousEmailAddress()

Returns:

anonymous customer email address

setAnonymousEmailAddress

public void setAnonymousEmailAddress(java.lang.String pAnonymousEmailAddress)

Parameters:

pAnonymousEmailAddress - email address

setOrder

public void setOrder(atg.commerce.order.Order pOrder)

Set the Order property.

Parameters:

pOrder - an Order value

getOrder

public atg.commerce.order.Order getOrder()

Return the Order property.

Returns:

an Order value

setAddCommerceItemInfos

public void setAddCommerceItemInfos(java.util.List pAddCommerceItemInfos)

Parameters:

pAddCommerceItemInfos - - add commerce item information.

getAddCommerceItemInfos

public java.util.List getAddCommerceItemInfos()

Returns:

add commerce item information.

getRequiredBillingAddressPropertyList

public java.util.List getRequiredBillingAddressPropertyList()

Returns:

required billing address property list.

setRequiredBillingAddressPropertyList

public void setRequiredBillingAddressPropertyList(java.util.List pRequiredBillingAddressPropertyList)

Parameters:

pRequiredBillingAddressPropertyList - - required billing address property list.

isEmailOptIn

public boolean isEmailOptIn()

Returns:

true if e-mail opt in is turned on, false - otherwise.

setEmailOptIn

public void setEmailOptIn(boolean pEmailOptIn)

Parameters:

pEmailOptIn - - true to turn on e-mail opt in, false - otherwise.

isPreviousOptInStatus

public boolean isPreviousOptInStatus()

Returns:

previous opt in status.

setPreviousOptInStatus

public void setPreviousOptInStatus(boolean pPreviousOptInStatus)

Parameters:

pPreviousOptInStatus - - previous opt in status.

getPreviousEmailAddress

public java.lang.String getPreviousEmailAddress()

Returns:

previous email address.

setPreviousEmailAddress

public void setPreviousEmailAddress(java.lang.String pPreviousEmailAddress)

Parameters:

pPreviousEmailAddress - - previous email address.

getCreditCardTools

public atg.payment.creditcard.ExtendableCreditCardTools getCreditCardTools()

Returns:

ExtendableCreditCardTools

setCreditCardTools

public void setCreditCardTools(atg.payment.creditcard.ExtendableCreditCardTools pCreditCardTools)

Parameters:

pCreditCardTools - new ExtendableCreditCardTools

setNewAddressSuccessURL

public void setNewAddressSuccessURL(java.lang.String pNewAddressSuccessURL)

Sets property newAddressSuccessURL, used to redirect user after successfully creating an address.

Parameters:

pNewAddressSuccessURL - the newAddressSuccessURL to set

getNewAddressSuccessURL

public java.lang.String getNewAddressSuccessURL()

Returns:

property newAddressSuccessURL, used to redirect user after successfully creating an address.

setNewAddressErrorURL

public void setNewAddressErrorURL(java.lang.String pNewAddressErrorURL)

Sets property newAddressErrorURL, used to redirect user in case of an error creating an address.

Parameters:

pNewAddressErrorURL - the newAddressErrorURL to set

getNewAddressErrorURL

public java.lang.String getNewAddressErrorURL()

Returns:

property newAddressErrorURL, used to redirect user when theere was an error creating an address.

setUpdateAddressSuccessURL

public void setUpdateAddressSuccessURL(java.lang.String pUpdateAddressSuccessURL)

Sets property updateAddressSuccessURL, used to redirect user when an address is successfully updated.

Parameters:

pUpdateAddressSuccessURL - the updateAddressSuccessURL to set

getUpdateAddressSuccessURL

public java.lang.String getUpdateAddressSuccessURL()

Returns:

property updateAddressSuccessURL, used to redirect user when an address is successfully updated.

setUpdateAddressErrorURL

public void setUpdateAddressErrorURL(java.lang.String pUpdateAddressErrorURL)

Sets property updateAddressErrorURL, used to redirect user in case of an error updating an address.

Parameters:

pUpdateAddressErrorURL - the updateAddressErrorURL to set

getUpdateAddressErrorURL

public java.lang.String getUpdateAddressErrorURL()

Returns:

property updateAddressErrorURL, used to redirect user in case of an error updating an address.

setCreateCardSuccessURL

public void setCreateCardSuccessURL(java.lang.String pCreateCardSuccessURL)

Sets property createCardSuccessURL, used to redirect user if a new credit card was successfully added.

Parameters:

pCreateCardSuccessURL - the createCardSuccessURL to set

getCreateCardSuccessURL

public java.lang.String getCreateCardSuccessURL()

Returns:

property createCardSuccessURL, used to redirect user if a new credit card was successfully added.

setCreateCardErrorURL

public void setCreateCardErrorURL(java.lang.String pCreateCardErrorURL)

Sets property createCardErrorURL, used to redirect user in case of an error adding a new credit card.

Parameters:

pCreateCardErrorURL - the createCardErrorURL to set

getCreateCardErrorURL

public java.lang.String getCreateCardErrorURL()

Returns:

property createCardErrorURL, used to redirect user in case of an error adding a new credit card.

setUpdateCardSuccessURL

public void setUpdateCardSuccessURL(java.lang.String pUpdateCardSuccessURL)

Sets property updateCardSuccessURL.

Parameters:

pUpdateCardSuccessURL - - credit card update success URL

getUpdateCardSuccessURL

public java.lang.String getUpdateCardSuccessURL()

Returns property updateCardSuccessURL.

Returns:

mUpdateCardSuccessURL

setUpdateCardErrorURL

public void setUpdateCardErrorURL(java.lang.String pUpdateCardErrorURL)

Sets property updateCardErrorURL, used to redirect user in case of an error updating a new credit card.

Parameters:

pUpdateCardErrorURL - - credit card update error URL

getUpdateCardErrorURL

public java.lang.String getUpdateCardErrorURL()

Returns property updateCardErrorURL, used to redirect user in case of an error updating a new credit card.

Returns:

update credit card error URL

setRemoveCardSuccessURL

public void setRemoveCardSuccessURL(java.lang.String pRemoveCardSuccessURL)

Sets property removeCardSuccessURL, used to redirect user when a credit card is successfully removed.

Parameters:

pRemoveCardSuccessURL - the removeCardSuccessURL to set

getRemoveCardSuccessURL

public java.lang.String getRemoveCardSuccessURL()

Returns:

property removeCardSuccessURL, used to redirect user in a credit card is successfully removed.

setRemoveCardErrorURL

public void setRemoveCardErrorURL(java.lang.String pRemoveCardErrorURL)

Sets property RemoveCardErrorURL, used to redirect user in case of an error removing a credit card.

Parameters:

pRemoveCardErrorURL - the RemoveCardErrorURL to set

getRemoveCardErrorURL

public java.lang.String getRemoveCardErrorURL()

Returns:

property RemoveCardErrorURL, used to redirect user in case of an error removing a credit card.

setDefaultCardSuccessURL

public void setDefaultCardSuccessURL(java.lang.String pDefaultCardSuccessURL)

Sets property DefaultCardSuccessURL, used to redirect user when a credit card is successfully removed.

Parameters:

pDefaultCardSuccessURL - the DefaultCardSuccessURL to set

getDefaultCardSuccessURL

public java.lang.String getDefaultCardSuccessURL()

Returns:

property DefaultCardSuccessURL, used to redirect user in a credit card is successfully removed.

setDefaultCardErrorURL

public void setDefaultCardErrorURL(java.lang.String pDefaultCardErrorURL)

Sets property DefaultCardErrorURL, used to redirect user in case of an error removing a credit card.

Parameters:

pDefaultCardErrorURL - the DefaultCardErrorURL to set

getDefaultCardErrorURL

public java.lang.String getDefaultCardErrorURL()

Returns:

property DefaultCardErrorURL, used to redirect user in case of an error removing a credit card.

getPreRegisterSuccessURL

public java.lang.String getPreRegisterSuccessURL()

Returns:

the mPreRegisterSuccessURL

setPreRegisterSuccessURL

public void setPreRegisterSuccessURL(java.lang.String pPreRegisterSuccessURL)

Parameters:

pPreRegisterSuccessURL - the preRegisterSuccessURL to set

getPreRegisterErrorURL

public java.lang.String getPreRegisterErrorURL()

Returns:

the mPreRegisterErrorURL

setPreRegisterErrorURL

public void setPreRegisterErrorURL(java.lang.String pPreRegisterErrorURL)

Parameters:

pPreRegisterErrorURL - the preRegisterErrorURL to set

setShippingGroupMapContainer

public void setShippingGroupMapContainer(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer)

Set the ShippingGroupMapContainer property.

Parameters:

pShippingGroupMapContainer - a ShippingGroupMapContainer value

getShippingGroupMapContainer

public atg.commerce.order.purchase.ShippingGroupMapContainer getShippingGroupMapContainer()

Return the ShippingGroupMapContainer property.

Returns:

a ShippingGroupMapContainer value

setRecentlyViewedProducts

public void setRecentlyViewedProducts(java.util.List<atg.repository.RepositoryItem> pRecentlyViewedProducts)

Sets a recently viewed products list.

getRecentlyViewedProducts

public java.util.List<atg.repository.RepositoryItem> getRecentlyViewedProducts()

Gets a recently viewed products list.

setCurrentDate

public void setCurrentDate(atg.service.util.CurrentDate pCurrentDate)

Parameters:

pCurrentDate - The CurrentDate component.

getCurrentDate

public atg.service.util.CurrentDate getCurrentDate()

Returns:

The CurrentDate component.

getNewAddressId

public java.lang.String getNewAddressId()

Returns:

The id of the new address created by this form handler.

setNewAddressId

public void setNewAddressId(java.lang.String pNewAddressId)

Parameters:

pNewAddressId - Set the id of the newly created address.

preLoginUser

protected void preLoginUser(atg.servlet.DynamoHttpServletRequest pRequest,
                            atg.servlet.DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

Override OOTB method so that auto-logged in user is not logged out if they provide an invalid password.

Overrides:

preLoginUser in class atg.userprofiling.ProfileFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProfileForm.preLoginUser(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)

postLoginAddRecentlyViewed

protected void postLoginAddRecentlyViewed(atg.servlet.DynamoHttpServletRequest pRequest,
                                          atg.servlet.DynamoHttpServletResponse pResponse)
                                   throws javax.servlet.ServletException

Update the logged in user's recentlyViewedProducts property with products viewed as an anonymous user.

Throws:

javax.servlet.ServletException - If there was a problem updating the user's list.

postLoginUser

protected void postLoginUser(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

After logging in the user's session cached promotions are reloaded into the PricingModelHolder. In addition any non-transient orders are made persistent and old shopping carts are loaded from the database.

Overrides:

postLoginUser in class atg.commerce.profile.CommerceProfileFormHandler

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - - if there was an error while executing the code

java.io.IOException - - if there was an error with servlet io

postLogoutUser

public void postLogoutUser(atg.servlet.DynamoHttpServletRequest pRequest,
                           atg.servlet.DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Operation called just after the user is logged out.

Overrides:

postLogoutUser in class atg.userprofiling.ProfileFormHandler

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preCreateUser

protected void preCreateUser(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Operation called just before the user creation process is started.

Overrides:

preCreateUser in class atg.userprofiling.ProfileForm

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postCreateUser

protected void postCreateUser(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse pResponse)
                       throws javax.servlet.ServletException,
                              java.io.IOException

Override OOTB method so that if the profile has receiveEmail=yes, create an EmailRecipient repository item for Email Campaigns. If there were no errors on the form, then the Registered User email will be send as well.

Overrides:

postCreateUser in class atg.commerce.profile.CommerceProfileFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProfileForm.postCreateUser(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)

preUpdateUser

protected void preUpdateUser(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

This overriding method will check to see if a new email address that is being submitted in an update already belongs to another user profile.

Overrides:

preUpdateUser in class atg.userprofiling.ProfileFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProfileForm.preUpdateUser(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)

postUpdateUser

protected void postUpdateUser(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse pResponse)
                       throws javax.servlet.ServletException,
                              java.io.IOException

Overrides:

postUpdateUser in class atg.userprofiling.ProfileFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProfileForm.postUpdateUser(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)

validateDateFormat

protected java.util.Date validateDateFormat(java.lang.String pDate,
                                            java.lang.String pFormat)

Operation called to validate the Date on the basis of locale format

Parameters:

pDate - User Date

pFormat - the Date Format

Returns:

date from string

handleCreateNewCreditCardAndAddress

public boolean handleCreateNewCreditCardAndAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                                   atg.servlet.DynamoHttpServletResponse pResponse)
                                            throws javax.servlet.ServletException,
                                                   java.io.IOException

Creates a new credit card using the entries entered in the editValue map

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if success, false - otherwise

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preCreateNewCreditCardAndAddress

protected void preCreateNewCreditCardAndAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                                atg.servlet.DynamoHttpServletResponse pResponse)
                                         throws javax.servlet.ServletException,
                                                java.io.IOException

Operation is called just before new card with new address be created

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postCreateNewCreditCardAndAddress

protected void postCreateNewCreditCardAndAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                                 atg.servlet.DynamoHttpServletResponse pResponse)
                                          throws javax.servlet.ServletException,
                                                 java.io.IOException

Operation is called just after new card with new address be created

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

handleCreateNewCreditCard

public boolean handleCreateNewCreditCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                         atg.servlet.DynamoHttpServletResponse pResponse)
                                  throws javax.servlet.ServletException,
                                         java.io.IOException

Creates a new credit card using the entries entered in the editValue map

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if success, false - otherwise

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preCreateNewCreditCard

protected void preCreateNewCreditCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                      atg.servlet.DynamoHttpServletResponse pResponse)
                               throws javax.servlet.ServletException,
                                      java.io.IOException

Operation is called just before new card with existing address be created

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postCreateNewCreditCard

protected void postCreateNewCreditCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                       atg.servlet.DynamoHttpServletResponse pResponse)
                                throws javax.servlet.ServletException,
                                       java.io.IOException

Operation is called just after new card with existing address be created

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

validateCreateCreditCardInformation

protected boolean validateCreateCreditCardInformation(atg.servlet.DynamoHttpServletRequest pRequest,
                                                      atg.servlet.DynamoHttpServletResponse pResponse,
                                                      boolean pIsNewAddress)
                                               throws javax.servlet.ServletException,
                                                      java.io.IOException

Validates credit card information entered by user:

• all required fields are specified for credit card
• all required fields are specified for new address
• country/state combination is valid for new address
• card number and expiry date are valid
• not duplicate credit card nickname is used

Parameters:

pRequest - http request

pResponse - http response

pIsNewAddress - true if should validate new address

Returns:

true is validation succeeded

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

validateCreditCardFields

protected boolean validateCreditCardFields(atg.servlet.DynamoHttpServletRequest pRequest,
                                           atg.servlet.DynamoHttpServletResponse pResponse)

Validates that all required credit card's fields are entered by user

Parameters:

pRequest - http request

pResponse - http response

Returns:

true if all required fields are entered

validateBillingAddressFields

protected boolean validateBillingAddressFields(atg.servlet.DynamoHttpServletRequest pRequest,
                                               atg.servlet.DynamoHttpServletResponse pResponse)

Validates that all required fields are entered for billing address

Parameters:

pRequest - http request

pResponse - http response

Returns:

true if all required fields are entered

validateCreditCard

protected boolean validateCreditCard(java.util.Map pCard,
                                     java.util.ResourceBundle pBundle)

Validates the credit card information using CreditCardTools.

See Also:

CreditCardTools.verifyCreditCard(CreditCardInfo)

addCreditCardFormException

protected void addCreditCardFormException(java.util.ResourceBundle pBundle,
                                          int pReturnCode)

Adds form exception with the message according to the specified parameters

Parameters:

pBundle - Resource bundle

pReturnCode - The code returned from the validateCreditCard method

preUpdateCard

protected void preUpdateCard(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)
                      throws atg.repository.RepositoryException

Called before handleUpdateCard logic is applied. Adds properties listed in immutableCardProperties property to editValue map.

Parameters:

pRequest - current request

pResponse - current response

Throws:

atg.repository.RepositoryException - if unable to obtain user card's properties.

findCurrentCreditCard

protected atg.repository.RepositoryItem findCurrentCreditCard()

Searches current user's credit card by nick-name from editValue properties.

Returns:

credit card if found.

handleUpdateCard

public boolean handleUpdateCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                atg.servlet.DynamoHttpServletResponse pResponse)
                         throws atg.repository.RepositoryException,
                                javax.servlet.ServletException,
                                java.io.IOException

Updates the credit card as modified by the user.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if success, false - otherwise

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

atg.repository.RepositoryException - if there was an error accessing the repository

validateUpdateCreditCardInformation

protected boolean validateUpdateCreditCardInformation(atg.servlet.DynamoHttpServletRequest pRequest,
                                                      atg.servlet.DynamoHttpServletResponse pResponse)
                                               throws javax.servlet.ServletException,
                                                      java.io.IOException

Validates updated credit card information entered by user:

• country/state combination is valid for billing address
• card expiry date are valid
• not duplicate credit card nickname is used

Parameters:

pRequest - http request

pResponse - http response

Returns:

true is validation succeeded

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

handleRemoveCard

public boolean handleRemoveCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                atg.servlet.DynamoHttpServletResponse pResponse)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Removes specified in removeCard property credit card from user's credit cards map.

Parameters:

pRequest - http request

pResponse - http response

Returns:

true if success, false - otherwise

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

handleDefaultCard

public boolean handleDefaultCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                          throws atg.repository.RepositoryException,
                                 javax.servlet.ServletException,
                                 java.io.IOException

Deprecated.

Makes the credit card identified by a nickname, default in the given profile.

Parameters:

pRequest - DynamoHttpServletRequest

pResponse - DynamoHttpServletResponse

Returns:

boolean true/false for success

Throws:

atg.repository.RepositoryException - if there was an error accessing the repository

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

handleEditCard

public boolean handleEditCard(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse pResponse)
                       throws javax.servlet.ServletException,
                              java.io.IOException

Copy the named credit card into the editValue map, allowing the user to edit them.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if success, false - otherwise

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

handleNewAddress

public boolean handleNewAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                atg.servlet.DynamoHttpServletResponse pResponse)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Creates a new shipping address using the entries entered in the editValue map. The address will be indexed using the nickname provided by the user.

Parameters:

pRequest - The current HTTP request

pResponse - The current HTTP response

Returns:

boolean returns true/false for success

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

validateAddress

protected boolean validateAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                  atg.servlet.DynamoHttpServletResponse pResponse)
                           throws javax.servlet.ServletException,
                                  java.io.IOException

Validates new address fields entered by user:

• all required fields are specified for new address
• country/state combination is valid for new address
• not duplicate address nickname is used for create address or update address operation

Parameters:

pRequest - http request

pResponse - http response

Returns:

true is validation succeeded

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

validateCountryStateCombination

protected void validateCountryStateCombination(java.util.Map pAddress,
                                               atg.servlet.DynamoHttpServletRequest pRequest,
                                               atg.servlet.DynamoHttpServletResponse pResponse)

Validate country-state combination.

Parameters:

pAddress - - address

pRequest - - http address

pResponse - - http response

validateCountryStateCombination

protected void validateCountryStateCombination(java.lang.String pCountry,
                                               java.lang.String pState,
                                               atg.servlet.DynamoHttpServletRequest pRequest,
                                               atg.servlet.DynamoHttpServletResponse pResponse)

Validate country-state combination.

Parameters:

pCountry - country code

pState - county code

pRequest - dynamo request

pResponse - dynamo response

handleUpdateAddress

public boolean handleUpdateAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.DynamoHttpServletResponse pResponse)
                            throws atg.repository.RepositoryException,
                                   javax.servlet.ServletException,
                                   java.io.IOException

Update the secondary address as modified by the user.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true for successful address update, false - otherwise

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

atg.repository.RepositoryException - if there was an error accessing the repository

updateSecondaryInfo

protected void updateSecondaryInfo(atg.core.util.Address pTargetAddress,
                                   atg.core.util.Address pSourceAddress)

Updates the properties of an address that don't affect where the item is shipped to - e.g the phone number.

Parameters:

pTargetAddress - The target Address

pSourceAddress - The source Address

handleRemoveAddress

public boolean handleRemoveAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.DynamoHttpServletResponse pResponse)
                            throws javax.servlet.ServletException,
                                   java.io.IOException

This handler deletes a secondary address named in the removeAddress property.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

boolean true/false for success

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

handleDefaultShippingAddress

public boolean handleDefaultShippingAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                            atg.servlet.DynamoHttpServletResponse pResponse)
                                     throws atg.repository.RepositoryException,
                                            javax.servlet.ServletException

Deprecated.

This sets the default shipping address.

Parameters:

pRequest - DynamoHttpServletRequest

pResponse - DynamoHttpServletResponse

Returns:

true for success, false - otherwise

Throws:

atg.repository.RepositoryException - indicates that a severe error occured while performing a Repository task

javax.servlet.ServletException - if there was an error while executing the code

handleEditAddress

public boolean handleEditAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException,
                                 atg.beans.PropertyNotFoundException

Copy the named address into the editValue map, allowing the user to edit it.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

atg.beans.PropertyNotFoundException - If a property is not found

handleClear

public boolean handleClear(atg.servlet.DynamoHttpServletRequest pRequest,
                           atg.servlet.DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Override to prevent clear if there are form errors.

This is here because postLogin will do a clear of the value dictionary even if the login fails

Overrides:

handleClear in class atg.userprofiling.ProfileFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

handleClearForm

public boolean handleClearForm(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse pResponse)
                        throws javax.servlet.ServletException,
                               java.io.IOException

Override to prevent clear if there are form errors.

This is here because postLogin will do a clear of the value dictionary even if the login fails

Throws:

javax.servlet.ServletException

java.io.IOException

handlePreRegister

public boolean handlePreRegister(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException

Perform pre-registration actions before user actually registered. Check email address. If it is passed validation, redirect to the registration page with filled in email value. Otherwise, add form error and stays on the same page.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Returns:

If redirect to the registration page occurred, return false. If no redirect occurred, return true.

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

findUser

protected atg.repository.RepositoryItem findUser(java.lang.String pLogin,
                                                 java.lang.String pPassword,
                                                 atg.repository.Repository pProfileRepository,
                                                 atg.servlet.DynamoHttpServletRequest pRequest,
                                                 atg.servlet.DynamoHttpServletResponse pResponse)
                                          throws atg.repository.RepositoryException,
                                                 javax.servlet.ServletException,
                                                 java.io.IOException

Returns the user profile or null if the user could not be found with the given login and password.

Overrides:

findUser in class atg.userprofiling.ProfileForm

Parameters:

pLogin - the login name for the person

pPassword - the password for the person, optionally null if no password checking should be performed.

pProfileRepository - the repository which should contain the desired profile template

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

the user profile or null if the user could not be found with the given login and password

Throws:

atg.repository.RepositoryException - - if there was an error while accessing the Profile Repository

javax.servlet.ServletException - - if there was an error while executing the code

java.io.IOException - - if there was an error with servlet io

getStorePropertyManager

protected StorePropertyManager getStorePropertyManager()

Utility method to retrieve the StorePropertyManager.

Returns:

property manager

addFormException

protected void addFormException(java.lang.String pWhatException,
                                atg.repository.RepositoryException pRepositoryExc,
                                atg.servlet.DynamoHttpServletRequest pRequest)

Create a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).

Parameters:

pWhatException - String description of exception

pRepositoryExc - RepositoryException

pRequest - DynamoHttpServletRequest

addFormException

protected void addFormException(java.lang.String pWhatException,
                                java.lang.Object[] pArgs,
                                atg.repository.RepositoryException pRepositoryExc,
                                atg.servlet.DynamoHttpServletRequest pRequest)

Create a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).

Parameters:

pWhatException - String description of exception

pArgs - String array with arguments used message formatting

pRepositoryExc - RepositoryException

pRequest - DynamoHttpServletRequest

addFormException

protected void addFormException(java.lang.String pWhatException,
                                java.lang.Object[] pArgs,
                                java.lang.String pPath,
                                atg.servlet.DynamoHttpServletRequest pRequest)

Creates a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).

Parameters:

pWhatException - String description of exception

pArgs - String array with arguments used message formatting

pPath - Full path to form handler property associated with the exception

pRequest - DynamoHttpServletRequest

addFormException

protected void addFormException(java.lang.String pWhatException,
                                java.lang.String pPath,
                                atg.servlet.DynamoHttpServletRequest pRequest)

Creates a form exception, by looking up the exception code in a resource file identified by the RESOURCE_BUNDLE constant (defined above).

Parameters:

pWhatException - String description of exception

pPath - Full path to form handler property associated with the exception

pRequest - DynamoHttpServletRequest

getLocale

protected java.util.Locale getLocale(atg.servlet.DynamoHttpServletRequest pRequest)

Determine the user's current locale, if available.

Parameters:

pRequest - DynamoHttpServletRequest

Returns:

Locale Request's Locale

getDateByFormat

protected java.lang.String getDateByFormat(java.lang.Object pDate,
                                           java.lang.String pFormat)

Operation called to get the Date on the basis of locale format.

Parameters:

pDate - getting from database

pFormat - Date Format get by database

Returns:

date in specified format

getString

public static java.lang.String getString(java.lang.String pKey,
                                         java.util.Locale pLocale)

Return a String message specific for the given locale.

Parameters:

pKey - the identifier for the message to retrieve out of the ResourceBundle

pLocale - the locale of the user

Returns:

the localized message

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.util.Locale pLocale)
                                                  throws java.util.MissingResourceException

Returns a ResourceBundle specific for the given locale.

Parameters:

pLocale - the locale of the user

Returns:

ResourcerBundle

Throws:

java.util.MissingResourceException - ResourceBundle could not be located

getUserLocale

protected java.util.Locale getUserLocale(atg.servlet.DynamoHttpServletRequest pRequest)

Returns the Locale for the user given the request.

Overrides:

getUserLocale in class atg.userprofiling.ProfileForm

Parameters:

pRequest - the request object which can be used to extract the user's locale

Returns:

Locale

handleCheckoutDefaults

public boolean handleCheckoutDefaults(atg.servlet.DynamoHttpServletRequest pRequest,
                                      atg.servlet.DynamoHttpServletResponse pResponse)
                               throws javax.servlet.ServletException,
                                      java.io.IOException

Handles changes on the 'Checkout Defaults' page - default credit card, shipping address and shipping method.

Parameters:

pRequest - - current HTTP request.

pResponse - - current HTTP response.

Returns:

true if request hasn't been redirected and false otherwise.

Throws:

javax.servlet.ServletException - if something goes wrong.

java.io.IOException - if unable to redirect current request.

preRemoveAddress

public void preRemoveAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)

Address that we'd like to remove could be associated with a gift list. In this case, we'd like to prevent address removal from the profile. Also on billing page shouldn't be deleted address that was chosen as shipping address.

Parameters:

pRequest - Dynamo http request

pResponse - Dynamo http response

postChangePassword

protected void postChangePassword(atg.servlet.DynamoHttpServletRequest pRequest,
                                  atg.servlet.DynamoHttpServletResponse pResponse)
                           throws javax.servlet.ServletException,
                                  java.io.IOException

Operation called just after the user's password is changed. If the were no errors during password changing, Updated Password email should be send.

Overrides:

postChangePassword in class atg.userprofiling.ProfileForm

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

sendEmail

protected void sendEmail(atg.servlet.DynamoHttpServletRequest pRequest,
                         atg.servlet.DynamoHttpServletResponse pResponse)
                  throws javax.servlet.ServletException,
                         java.io.IOException

Send email to current user using configured TemplateEmailInfo and TemplateEmailSender.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

validateBirthDate

protected void validateBirthDate(atg.servlet.DynamoHttpServletRequest pRequest)

Validates the values of the mBirthDate property. If all of them are set birthDate will be updated.