atg.commerce.profile

Class CommerceProfileFormHandler

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

All Implemented Interfaces:

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

Direct Known Subclasses:

B2CProfileFormHandler

public class CommerceProfileFormHandler
extends ScenarioProfileFormHandler

This form handler is a subclass of the DPS ProfileFormHandler to perform some operations that are specific to Commerce. The additional functionality includes:

• During a login operation the active promotions from the anonymous user are copied into the list of active promotions of the persistent user.
• After the login operation is finished the session-scope PricingModelHolder is reinitialized to cache all the promotions that the persistent user has accumulated.
• During the registration and login process any shopping carts (i.e. Orders) which were created while they were anonymous (and thus not persistent) are changed to be persistent.
• If the user logs in any old shopping carts (i.e. Orders in an INCOMPLETE state) are loaded into the user's session.

Nested Class Summary

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

ProfileForm.ProfileFormHashtableWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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_INVALID_PASSWORD, 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_RULE_CHECK_FAILED, 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, PROXY_FACTORY_PATH, 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_EXPIRATION_TIME, 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

Constructors

Constructor and Description
CommerceProfileFormHandler() Constructs an instanceof CommerceProfileFormHandler

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String pPropertyName, RepositoryItem pGuestUser, MutableRepositoryItem pAuthenticatedUser) If the property being added is "activePromotions", then use promotionTools to add it, otherwise call the super class.
void	copyProperty(java.lang.String pPropertyName, RepositoryItem pGuestUser, MutableRepositoryItem pAuthenticatedUser) If the property being added is catalog, priceList, or salePriceList then redetermine the correct values based on the authenticated user.
java.lang.String	formatUserMessage(java.lang.String pKey, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Utility method to format a message with no arguments using the Locale of the user
java.lang.String	getAddCostCenterDescription() Returns property AddCostCenterDescription
java.lang.String	getAddCostCenterErrorURL() Returns property AddCostCenterErrorURL
java.lang.String	getAddCostCenterIdentifier() Returns property AddCostCenterIdentifier
java.lang.String	getAddCostCenterSuccessURL() Returns property AddCostCenterSuccessURL
CustomCatalogTools	getCatalogTools()
java.util.Locale	getDefaultLocale() Returns property DefaultLocale.
java.lang.String	getEditCostCenterDescription() Returns property EditCostCenterDescription
java.lang.String	getEditCostCenterErrorURL() Returns property EditCostCenterErrorURL
java.lang.String	getEditCostCenterIdentifier() Returns property EditCostCenterIdentifier
java.lang.String	getEditCostCenterSuccessURL() Returns property EditCostCenterSuccessURL
OrderManager	getOrderManager() Returns property OrderManager
PriceListManager	getPriceListManager()
PricingTools	getPricingTools()
PromotionTools	getPromotionTools() Returns property PromotionTools
java.lang.String	getRemoveCostCenterErrorURL() Returns property RemoveCostCenterErrorURL
java.lang.String	getRemoveCostCenterIdentifier() Returns property RemoveCostCenterIdentifier
java.lang.String	getRemoveCostCenterSuccessURL() Returns property RemoveCostCenterSuccessURL
OrderHolder	getShoppingCart() Returns property ShoppingCart
java.util.Locale	getUserLocale(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Returns the locale associated with the request.
PricingModelHolder	getUserPricingModels() Returns property UserPricingModels
boolean	handleAddCostCenter(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Adds a cost center to the user's profile
boolean	handleEditCostCenter(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Adds a cost center to the user's profile
boolean	handleRemoveCostCenter(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Adds a cost center to the user's profile
boolean	isDefaultCostCenter() Returns property DefaultCostCenter
boolean	isDetermineCatalog() If true then call determineCatalog rather than copy the catalog value from the guest user.
boolean	isDeterminePriceList() If true then call determinePriceList rather than copy the priceList value from the guest user.
protected void	postCreateUser(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) After registration, any transient orders are made persistent through the persistShoppingCarts method of the CommerceProfileTools component
protected void	postLoginUser(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) After logging in the user's session cached promotions are reloaded into the PricingModelHolder.
void	processException(java.lang.Exception pException, java.lang.String pMsgId, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add a user error message to the form exceptions, and then display the exception in the logs
void	setAddCostCenterDescription(java.lang.String pAddCostCenterDescription) Sets property AddCostCenterDescription
void	setAddCostCenterErrorURL(java.lang.String pAddCostCenterErrorURL) Sets property AddCostCenterErrorURL.
void	setAddCostCenterIdentifier(java.lang.String pAddCostCenterIdentifier) Sets property AddCostCenterIdentifier
void	setAddCostCenterSuccessURL(java.lang.String pAddCostCenterSuccessURL) Sets property AddCostCenterSuccessURL.
void	setCatalogTools(CustomCatalogTools pCatalogTools)
void	setDefaultCostCenter(boolean pDefaultCostCenter) Sets property DefaultCostCenter
void	setDefaultLocale(java.util.Locale pDefaultLocale) Sets property DefaultLocale
void	setDetermineCatalog(boolean pDetermineCatalog)
void	setDeterminePriceList(boolean pDeterminePriceList)
void	setEditCostCenterDescription(java.lang.String pEditCostCenterDescription) Sets property EditCostCenterDescription
void	setEditCostCenterErrorURL(java.lang.String pEditCostCenterErrorURL) Sets property EditCostCenterErrorURL.
void	setEditCostCenterIdentifier(java.lang.String pEditCostCenterIdentifier) Sets property EditCostCenterIdentifier
void	setEditCostCenterSuccessURL(java.lang.String pEditCostCenterSuccessURL) Sets property EditCostCenterSuccessURL.
void	setOrderManager(OrderManager pOrderManager) Sets property OrderManager
void	setPriceListManager(PriceListManager pPriceListManager)
void	setPricingTools(PricingTools pPricingTools)
void	setPromotionTools(PromotionTools pPromotionTools) Sets property PromotionTools
void	setRemoveCostCenterErrorURL(java.lang.String pRemoveCostCenterErrorURL) Sets property RemoveCostCenterErrorURL.
void	setRemoveCostCenterIdentifier(java.lang.String pRemoveCostCenterIdentifier) Sets property RemoveCostCenterIdentifier
void	setRemoveCostCenterSuccessURL(java.lang.String pRemoveCostCenterSuccessURL) Sets property RemoveCostCenterSuccessURL.
void	setShoppingCart(OrderHolder pShoppingCart) Sets property ShoppingCart
void	setUserPricingModels(PricingModelHolder pUserPricingModels) Sets property UserPricingModels

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, getProfileRequestServletPath, getProfileUpdateEvent, getProfileUpdateTrigger, getRepositoryId, getRequestLocale, getTestPassword, getUpdateRepositoryId, getVerifyPasswordSuccessURL, handleCancel, handleClear, handleVerifyPassword, isCreateNewUser, isGenerateProfileUpdateEvents, isSendCookie, postLogoutUser, postUpdateUser, preLoginUser, preLogoutUser, preUpdateUser, propagateLocale, removeProfileUpdateListener, sendProfileUpdateEvent, setClearValuesOnCreate, setClearValuesOnLogin, setClearValuesOnUpdate, setCreateNewUser, setExpiredPasswordService, setGenerateProfileUpdateEvents, setProfile, setProfileRequestServletPath, 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, findUser, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getAddMultiPropertyName, getAddMultiPropertyValue, getAuthenticationMessageTrigger, getBadPasswordDelay, getChangePasswordErrorURL, getChangePasswordSuccessURL, getCheckForRequiredParameters, getCheckForRequiredProperties, getCheckForRequiredPropertiesAfterUpdate, getCreateErrorURL, getCreateProfileType, getCreateSuccessURL, getCurrentDataSource, getDeleteErrorURL, getDeleteSuccessURL, getDescriptor, getExpireSessionOnLogout, getLoginErrorURL, getLoginProfileType, getLoginSuccessURL, getLogoutErrorURL, getLogoutProfileType, getLogoutSuccessURL, getProcessPropertyNames, getProfileItem, getProfileRealmManager, getProfileTools, getPropertiesToAddOnLogin, getPropertiesToCopyOnLogin, getRealmSessionTracker, getStringValueProperty, getTransactionDemarcation, getTransactionManager, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getUserLocale, getUserLoginManager, getValue, getValueFromArrayString, getValueFromObject, getValueFromObjectArray, getValueFromString, getValueFromStringArray, getValueMap, getValueProperty, handleAddMulti, handleChangePassword, handleValueDictionaryByParameters, isCompareValueInCopyPropertiesOnLogin, isConfirmOldPassword, isConfirmPassword, isExtractDefaultValuesFromProfile, isInvalidateAllChildSessions, isTrimProperty, isUsingLdapProfile, postAddMulti, postChangePassword, postDeleteUser, postValueDictionaryByParameters, preAddMulti, preChangePassword, preCreateUser, 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, 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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

CommerceProfileFormHandler

public CommerceProfileFormHandler()

Constructs an instanceof CommerceProfileFormHandler

Method Detail

setShoppingCart

public void setShoppingCart(OrderHolder pShoppingCart)

Sets property ShoppingCart

getShoppingCart

public OrderHolder getShoppingCart()

Returns property ShoppingCart

setUserPricingModels

public void setUserPricingModels(PricingModelHolder pUserPricingModels)

Sets property UserPricingModels

getUserPricingModels

public PricingModelHolder getUserPricingModels()

Returns property UserPricingModels

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets property OrderManager

getOrderManager

public OrderManager getOrderManager()

Returns property OrderManager

setPromotionTools

public void setPromotionTools(PromotionTools pPromotionTools)

Sets property PromotionTools

getPromotionTools

public PromotionTools getPromotionTools()

Returns property PromotionTools

getCatalogTools

public CustomCatalogTools getCatalogTools()

Returns:

the CatalogTools

setCatalogTools

public void setCatalogTools(CustomCatalogTools pCatalogTools)

Parameters:

pCatalogTools - the CatalogTools to set

getPricingTools

public PricingTools getPricingTools()

Returns:

the PricingTools

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

Parameters:

pPricingTools - the PricingTools to set

getPriceListManager

public PriceListManager getPriceListManager()

Returns:

the PriceListManager

setPriceListManager

public void setPriceListManager(PriceListManager pPriceListManager)

Parameters:

pPriceListManager - the PriceListManager to set

setDefaultLocale

public void setDefaultLocale(java.util.Locale pDefaultLocale)

Sets property DefaultLocale

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns property DefaultLocale. If the property value is null, then JVM's default locale is returned.

isDeterminePriceList

public boolean isDeterminePriceList()

If true then call determinePriceList rather than copy the priceList value from the guest user.

Returns:

the determinePriceList

setDeterminePriceList

public void setDeterminePriceList(boolean pDeterminePriceList)

Parameters:

mDeterminePriceList - the mDeterminePriceList to set

isDetermineCatalog

public boolean isDetermineCatalog()

If true then call determineCatalog rather than copy the catalog value from the guest user.

Returns:

the determineCatalog

setDetermineCatalog

public void setDetermineCatalog(boolean pDetermineCatalog)

Parameters:

mDeterminePriceLists - the mDeterminePriceLists to set

copyProperty

public void copyProperty(java.lang.String pPropertyName,
                         RepositoryItem pGuestUser,
                         MutableRepositoryItem pAuthenticatedUser)
                  throws RepositoryException

If the property being added is catalog, priceList, or salePriceList then redetermine the correct values based on the authenticated user. If the property being copied is "activePromotions", then use promotionTools to copy it

Overrides:

copyProperty in class ProfileForm

Parameters:

pPropertyName - the name of the property being copied

pGuestUser - the guest user

pAuthenticatedUser - the authenticated user

Throws:

RepositoryException

addProperty

public void addProperty(java.lang.String pPropertyName,
                        RepositoryItem pGuestUser,
                        MutableRepositoryItem pAuthenticatedUser)
                 throws RepositoryException

If the property being added is "activePromotions", then use promotionTools to add it, otherwise call the super class.

Overrides:

addProperty in class ScenarioProfileFormHandler

Parameters:

pGuestUser - the user to copy values from

pAuthenticatedUser - the user to copy values to

pPropertyName - the name of a multi-valued property whose values will be copied from the guest user and added to the authenticated user

Throws:

RepositoryException

getUserLocale

public java.util.Locale getUserLocale(DynamoHttpServletRequest pRequest,
                                      DynamoHttpServletResponse pResponse)
                               throws javax.servlet.ServletException,
                                      java.io.IOException

Returns the locale associated with the request. The method first searches for a request paramater named locale. This value can be either a java.util.Locale object or a String which represents the locale. Next if the useRequestLocale property is true, then the locale of the request will be returned. Finally, if the locale cannot be determined, the the defaultLocale property is used.

Throws:

javax.servlet.ServletException

java.io.IOException

postCreateUser

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

After registration, any transient orders are made persistent through the persistShoppingCarts method of the CommerceProfileTools component

Overrides:

postCreateUser in class 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

postLoginUser

protected void postLoginUser(DynamoHttpServletRequest pRequest,
                             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 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

setAddCostCenterIdentifier

public void setAddCostCenterIdentifier(java.lang.String pAddCostCenterIdentifier)

Sets property AddCostCenterIdentifier

getAddCostCenterIdentifier

public java.lang.String getAddCostCenterIdentifier()

Returns property AddCostCenterIdentifier

setAddCostCenterDescription

public void setAddCostCenterDescription(java.lang.String pAddCostCenterDescription)

Sets property AddCostCenterDescription

getAddCostCenterDescription

public java.lang.String getAddCostCenterDescription()

Returns property AddCostCenterDescription

setEditCostCenterIdentifier

public void setEditCostCenterIdentifier(java.lang.String pEditCostCenterIdentifier)

Sets property EditCostCenterIdentifier

getEditCostCenterIdentifier

public java.lang.String getEditCostCenterIdentifier()

Returns property EditCostCenterIdentifier

setEditCostCenterDescription

public void setEditCostCenterDescription(java.lang.String pEditCostCenterDescription)

Sets property EditCostCenterDescription

getEditCostCenterDescription

public java.lang.String getEditCostCenterDescription()

Returns property EditCostCenterDescription

setRemoveCostCenterIdentifier

public void setRemoveCostCenterIdentifier(java.lang.String pRemoveCostCenterIdentifier)

Sets property RemoveCostCenterIdentifier

getRemoveCostCenterIdentifier

public java.lang.String getRemoveCostCenterIdentifier()

Returns property RemoveCostCenterIdentifier

setDefaultCostCenter

public void setDefaultCostCenter(boolean pDefaultCostCenter)

Sets property DefaultCostCenter

isDefaultCostCenter

public boolean isDefaultCostCenter()

Returns property DefaultCostCenter

setAddCostCenterSuccessURL

public void setAddCostCenterSuccessURL(java.lang.String pAddCostCenterSuccessURL)

Sets property AddCostCenterSuccessURL. This property is normally set on a jhtml page. It indicates which page we should redirect to if NO errors occur when the user pushes the ADD COST CENTER button.

getAddCostCenterSuccessURL

public java.lang.String getAddCostCenterSuccessURL()

Returns property AddCostCenterSuccessURL

setAddCostCenterErrorURL

public void setAddCostCenterErrorURL(java.lang.String pAddCostCenterErrorURL)

Sets property AddCostCenterErrorURL. This property is normally set on the a jhtml page. It indicates which page we should redirect to if errors occur when the user pushes the ADD COST CENTER button.

getAddCostCenterErrorURL

public java.lang.String getAddCostCenterErrorURL()

Returns property AddCostCenterErrorURL

setEditCostCenterSuccessURL

public void setEditCostCenterSuccessURL(java.lang.String pEditCostCenterSuccessURL)

Sets property EditCostCenterSuccessURL. This property is normally set on a jhtml page. It indicates which page we should redirect to if NO errors occur when the user pushes the EDIT COST CENTER button.

getEditCostCenterSuccessURL

public java.lang.String getEditCostCenterSuccessURL()

Returns property EditCostCenterSuccessURL

setEditCostCenterErrorURL

public void setEditCostCenterErrorURL(java.lang.String pEditCostCenterErrorURL)

Sets property EditCostCenterErrorURL. This property is normally set on the a jhtml page. It indicates which page we should redirect to if errors occur when the user pushes the EDIT COST CENTER button.

getEditCostCenterErrorURL

public java.lang.String getEditCostCenterErrorURL()

Returns property EditCostCenterErrorURL

setRemoveCostCenterSuccessURL

public void setRemoveCostCenterSuccessURL(java.lang.String pRemoveCostCenterSuccessURL)

Sets property RemoveCostCenterSuccessURL. This property is normally set on a jhtml page. It indicates which page we should redirect to if NO errors occur when the user pushes the REMOVE COST CENTER button.

getRemoveCostCenterSuccessURL

public java.lang.String getRemoveCostCenterSuccessURL()

Returns property RemoveCostCenterSuccessURL

setRemoveCostCenterErrorURL

public void setRemoveCostCenterErrorURL(java.lang.String pRemoveCostCenterErrorURL)

Sets property RemoveCostCenterErrorURL. This property is normally set on the a jhtml page. It indicates which page we should redirect to if errors occur when the user pushes the REMOVE COST CENTER button.

getRemoveCostCenterErrorURL

public java.lang.String getRemoveCostCenterErrorURL()

Returns property RemoveCostCenterErrorURL

handleAddCostCenter

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

Adds a cost center to the user's profile

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

CommerceException

handleEditCostCenter

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

Adds a cost center to the user's profile

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

CommerceException

handleRemoveCostCenter

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

Adds a cost center to the user's profile

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

CommerceException

processException

public void processException(java.lang.Exception pException,
                             java.lang.String pMsgId,
                             DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Add a user error message to the form exceptions, and then display the exception in the logs

Parameters:

pException - the exception to process

pMsgId - the message id

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

formatUserMessage

public java.lang.String formatUserMessage(java.lang.String pKey,
                                          DynamoHttpServletRequest pRequest,
                                          DynamoHttpServletResponse pResponse)
                                   throws javax.servlet.ServletException,
                                          java.io.IOException

Utility method to format a message with no arguments using the Locale of the user

Parameters:

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

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

pResponse - the servlet's response

Returns:

the formatted message

Throws:

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

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

See Also:

GiftlistUserMessage