atg.commerce.csr.profile
Class CSRCustomerProfileFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.userprofiling.ProfileForm
                      atg.svc.agent.ui.formhandlers.CustomerProfileFormHandler
                          atg.commerce.csr.profile.CSRCustomerProfileFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, 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, java.util.EventListener

public class CSRCustomerProfileFormHandler
extends atg.svc.agent.ui.formhandlers.CustomerProfileFormHandler

This class is used to perform CSC specific profile tasks such as saving credit card details to a profile.

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 atg.commerce.profile.CommerceProfileTools	mCommerceProfileTools
protected boolean	mIsProfileSaved
protected boolean	mIsSaveCreditCards
protected java.lang.String	mOrderId
static java.lang.String	MY_RESOURCE_NAME Resources file
static java.lang.String	NO_ORDER_ID_ERROR
static java.lang.String	NO_SUCH_ORDER_ERROR
static java.lang.String	PROFILE_UPDATE_FAILURE
static java.lang.String	PROFILE_UPDATE_OK

Fields inherited from class atg.svc.agent.ui.formhandlers.CustomerProfileFormHandler

LOGIN_PARAM_NAME, mAgentMessagingTools, mEnvironmentTools, mSaveOnUpdate, PASSWORD_PARAM_NAME

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, 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_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, sResourceBundle, 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.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

CSRCustomerProfileFormHandler()

Method Summary

atg.commerce.profile.CommerceProfileTools	getCommerceProfileTools()
java.lang.String	getOrderId()
boolean	isProfileSaved()
boolean	isSaveCreditCards()
protected void	postUpdateUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	setCommerceProfileTools(atg.commerce.profile.CommerceProfileTools pCommerceProfileTools) Sets the property CommerceProfileTools.
void	setIsProfileSaved(boolean pIsProfileSaved) Property for determining whether or not a profile has been saved in the current request.
void	setOrderId(java.lang.String pOrderId) Sets the OrderId property.
void	setSaveCreditCards(boolean pIsSaveCreditCards) Property for determining whether or not to save credit cards to the profile.

Methods inherited from class atg.svc.agent.ui.formhandlers.CustomerProfileFormHandler

generateNewAccountEmailParameters, generateNewAccountEmailParameters, generateResetPasswordEmailParameters, generateResetPasswordEmailParameters, getAgentMessagingTools, getAgentProfile, getAgentTools, getApplicationName, getEditValue, getEnvironmentTools, getErrorUrl, getMutableProfileItem, getNewAccountTemplateEmailInfo, getProfile, getPropertyUpdates, getRepositoryId, getResetPasswordTemplateEmailInfo, getSuccessUrl, getTemplateEmailSender, getUpdateErrorURL, getUpdateSuccessURL, handleCancel, handleClear, handleResetPassword, handleUpdate, isBackToTicketAfterCreate, isPersistNewAccountEmails, isPersistResetPasswordEmails, isSaveOnUpdate, isSendNewAccountEmailInSeparateThread, isSendNewAccountEmails, isSendResetPasswordEmailInSeparateThread, isSendResetPasswordEmails, isViewMode, preUpdateUser, setAgentMessagingTools, setAgentProfile, setAgentTools, setApplicationName, setBackToTicketAfterCreate, setEnvironmentTools, setErrorUrl, setNewAccountTemplateEmailInfo, setPersistNewAccountEmails, setPersistResetPasswordEmails, setProfile, setPropertyUpdates, setResetPasswordTemplateEmailInfo, setSaveOnUpdate, setSendNewAccountEmailInSeparateThread, setSendNewAccountEmails, setSendResetPasswordEmailInSeparateThread, setSendResetPasswordEmails, setSuccessUrl, setTemplateEmailSender, setViewMode

Methods inherited from class atg.userprofiling.ProfileForm

addMulti, addPropertiesOnLogin, addProperty, addSwapEventListener, addUser, changePassword, checkFormError, checkFormSuccess, checkForRequiredParameters, checkForRequiredProperties, checkForRequiredProperties, commitTransaction, copyPropertiesOnLogin, createProfileItem, createUser, doStartService, ensureTransaction, findUser, findUser, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getAddMultiPropertyName, getAddMultiPropertyValue, getBadPasswordDelay, getChangePasswordErrorURL, getChangePasswordSuccessURL, getCheckForRequiredParameters, getCheckForRequiredProperties, getCheckForRequiredPropertiesAfterUpdate, getCreateErrorURL, getCreateProfileType, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getDescriptor, getExpireSessionOnLogout, getLoginErrorURL, getLoginProfileType, getLoginSuccessURL, getLogoutErrorURL, getLogoutProfileType, getLogoutSuccessURL, getProcessPropertyNames, getProfileItem, getProfileTools, getPropertiesToAddOnLogin, getPropertiesToCopyOnLogin, getStringValueProperty, getTransactionDemarcation, getTransactionManager, getTrimProperties, getUserLocale, getUserLoginManager, getValue, getValueFromArrayString, getValueFromObject, getValueFromObjectArray, getValueFromString, getValueFromStringArray, getValueMap, getValueProperty, handleAddMulti, handleChangePassword, handleCreate, handleDelete, handleLogin, handleLogout, handleValueDictionaryByParameters, isCompareValueInCopyPropertiesOnLogin, isConfirmOldPassword, isConfirmPassword, isExtractDefaultValuesFromProfile, isTrimProperty, isUsingLdapProfile, postAddMulti, postChangePassword, postCreateUser, postDeleteUser, postLoginUser, postLogoutUser, postValueDictionaryByParameters, preAddMulti, preChangePassword, preCreateUser, preDeleteUser, preLoginUser, preLogoutUser, preValueDictionaryByParameters, removeSwapEventListener, removeUser, sendProfileSwapEvent, setBadPasswordDelay, setChangePasswordErrorURL, setChangePasswordSuccessURL, setCheckForRequiredParameters, setCheckForRequiredProperties, setCheckForRequiredPropertiesAfterUpdate, setCompareValueInCopyPropertiesOnLogin, setConfirmOldPassword, setConfirmPassword, setCreateErrorURL, setCreateProfileType, setCreateSuccessURL, setDeleteErrorURL, setDeleteSuccessURL, setExpireSessionOnLogout, setExtractDefaultValuesFromProfile, setLoginErrorURL, setLoginProfileType, setLoginSuccessURL, setLogoutErrorURL, setLogoutProfileType, setLogoutSuccessURL, setProfileTools, setPropertiesToAddOnLogin, setPropertiesToCopyOnLogin, setRepositoryId, setTrimProperties, setUpdateErrorURL, setUpdateSuccessURL, setUserLoginManager, setUsingLdapProfile, setValueDictionaryByParameters, setValueProperty, updateLDAPProfileAttributes, updatePasswordValue, updateProfileAttributes, updateProfileAttributes, 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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 java.lang.String CLASS_VERSION

Class version string

MY_RESOURCE_NAME

public static final java.lang.String MY_RESOURCE_NAME

Resources file

See Also:

Constant Field Values

NO_ORDER_ID_ERROR

public static final java.lang.String NO_ORDER_ID_ERROR

See Also:

Constant Field Values

NO_SUCH_ORDER_ERROR

public static final java.lang.String NO_SUCH_ORDER_ERROR

See Also:

Constant Field Values

PROFILE_UPDATE_OK

public static final java.lang.String PROFILE_UPDATE_OK

See Also:

Constant Field Values

PROFILE_UPDATE_FAILURE

public static final java.lang.String PROFILE_UPDATE_FAILURE

See Also:

Constant Field Values

mIsSaveCreditCards

protected boolean mIsSaveCreditCards

mOrderId

protected java.lang.String mOrderId

mCommerceProfileTools

protected atg.commerce.profile.CommerceProfileTools mCommerceProfileTools

mIsProfileSaved

protected boolean mIsProfileSaved

Constructor Detail

CSRCustomerProfileFormHandler

public CSRCustomerProfileFormHandler()

Method Detail

isSaveCreditCards

public boolean isSaveCreditCards()

Returns:

the value of IsSaveCreditCards

setSaveCreditCards

public void setSaveCreditCards(boolean pIsSaveCreditCards)

Property for determining whether or not to save credit cards to the profile.

Parameters:

pIsSaveCreditCards - new value to set

getOrderId

public java.lang.String getOrderId()

Returns:

the id of the Order to be acted upon

setOrderId

public void setOrderId(java.lang.String pOrderId)

Sets the OrderId property. This is set to the id of the order to edit.

Parameters:

pOrderId - the new value to set.

getCommerceProfileTools

public atg.commerce.profile.CommerceProfileTools getCommerceProfileTools()

Returns:

The CommerceProfileTools component used to add credit cards the profile

setCommerceProfileTools

public void setCommerceProfileTools(atg.commerce.profile.CommerceProfileTools pCommerceProfileTools)

Sets the property CommerceProfileTools.

isProfileSaved

public boolean isProfileSaved()

Returns:

the value of IsProfileSaved

setIsProfileSaved

public void setIsProfileSaved(boolean pIsProfileSaved)

Property for determining whether or not a profile has been saved in the current request.

Parameters:

pIsProfileSaved - the new value to set

postUpdateUser

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

Overrides:

postUpdateUser in class atg.svc.agent.ui.formhandlers.CustomerProfileFormHandler

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

See Also:

This method performs the additional step of saving credit card details to the profile, after the profile has been created.