| 
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.droplet.EmptyFormHandler
atg.droplet.GenericFormHandler
atg.projects.store.email.GenericEmailSenderFormHandler
atg.projects.store.email.TemplateTesterFormHandler
public class TemplateTesterFormHandler
Email templates form handler.
| Field Summary | |
|---|---|
static java.lang.String | 
CLASS_VERSION
Class version string  | 
static java.lang.String | 
EMAIL_ID_PARAM
 | 
static java.lang.String | 
INVALID_ORDER_ID_MSG
 | 
static java.lang.String | 
INVALID_PRODUCT_ID_MSG
 | 
static java.lang.String | 
INVALID_RETURNREQUEST_ID_MSG
 | 
static java.lang.String | 
INVALID_SHIPPING_GROUP_ID_MSG
 | 
static java.lang.String | 
INVALID_SKU_ID_MSG
 | 
static java.lang.String | 
MISSING_REQUIRED_FIELD
 | 
static java.lang.String | 
MSG_ACTION_SENT_EMAIL
 | 
static java.lang.String | 
NO_RETURN_ITEMS_QUANTITY_MSG
 | 
static java.lang.String | 
ORDER_ID_PROPERTY_NAME
 | 
static java.lang.String | 
USER_PROFILE_TYPE
 | 
| Fields inherited from class atg.projects.store.email.GenericEmailSenderFormHandler | 
|---|
MSG_ACTION_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 | |
|---|---|
TemplateTesterFormHandler()
 | 
|
| Method Summary | |
|---|---|
protected  java.util.Map | 
collectParams()
Collect parameters for e-mail templates  | 
 java.lang.String | 
getApplyOrderErrorURL()
 | 
 java.lang.String | 
getApplyOrderSuccessURL()
 | 
 java.lang.String | 
getApplyReturnErrorURL()
 | 
 java.lang.String | 
getApplyReturnSuccessURL()
 | 
 java.lang.String | 
getEmailAFriendMessage()
 | 
 java.lang.String | 
getEmailAFriendMessageParameterName()
 | 
 java.lang.String | 
getEmailLocale()
 | 
 java.lang.String | 
getEmailLocaleName()
 | 
 java.lang.String | 
getLogin()
 | 
 java.lang.String | 
getNewPassword()
 | 
 java.lang.String | 
getNewPasswordParameterName()
 | 
 java.lang.String | 
getOrderId()
 | 
 atg.commerce.order.OrderManager | 
getOrderManager()
 | 
 java.lang.String | 
getOrderMessage()
 | 
 java.lang.String | 
getOrderParameterName()
 | 
 java.lang.String | 
getOrderRecipientEmail()
 | 
 java.lang.String | 
getOrderRecipientName()
 | 
 java.lang.String | 
getOrderSenderEmail()
 | 
 java.lang.String | 
getOrderSenderName()
 | 
 java.lang.String | 
getOrderSubject()
 | 
 StoreOrderTools | 
getOrderTools()
 | 
 java.lang.String | 
getPassword()
 | 
 java.lang.String | 
getProductId()
 | 
 java.lang.String | 
getProductIdParameterName()
 | 
 atg.userprofiling.Profile | 
getProfile()
Gets the user profile associated with the email.  | 
 StoreRepositoryProfileItemFinder | 
getProfileItemFinder()
 | 
protected  java.util.ResourceBundle | 
getResourceBundle()
Returns the error message ResourceBundle  | 
 java.lang.String | 
getResourceBundleName()
Returns the name of the error message ResourceBundle  | 
 java.util.Map<java.lang.String,java.lang.String> | 
getReturnItemToQuantityMap()
 | 
 java.lang.String | 
getReturnItemToQuantityReceivedParameterName()
 | 
 java.lang.String | 
getReturnRequestId()
 | 
 java.lang.String | 
getReturnRequestParameterName()
 | 
 atg.commerce.csr.returns.ReturnTools | 
getReturnTools()
The service that is used to find the desired return  | 
 TemplateTesterSessionBean | 
getSessionBean()
 | 
 java.lang.String | 
getShippingGroupId()
 | 
 java.lang.String | 
getShippingGroupParameterName()
 | 
 java.lang.String | 
getSkuId()
 | 
 java.lang.String | 
getSkuIdParameterName()
 | 
 boolean | 
handleApplyOrder(atg.servlet.DynamoHttpServletRequest pRequest,
                 atg.servlet.DynamoHttpServletResponse pResponse)
Stores order ID into session bean along with other user's input.  | 
 boolean | 
handleApplyReturn(atg.servlet.DynamoHttpServletRequest pRequest,
                  atg.servlet.DynamoHttpServletResponse pResponse)
Stores return request ID into session bean along with other user's input.  | 
 boolean | 
handleInitFromSentList(atg.servlet.DynamoHttpServletRequest pRequest,
                       atg.servlet.DynamoHttpServletResponse pResponse)
Initialize form handler based on information stored in recently sent list  | 
 boolean | 
handleInitializeForm(atg.servlet.DynamoHttpServletRequest pRequest,
                     atg.servlet.DynamoHttpServletResponse pResponse)
Initializes form with values stored in session.  | 
 boolean | 
handleSend(atg.servlet.DynamoHttpServletRequest pRequest,
           atg.servlet.DynamoHttpServletResponse pResponse)
Send email  | 
 void | 
initFromSentList(int pIndex)
Initializes form with values stored in the recently sent list.  | 
 void | 
initializeForm()
Initializes form with values stored in the session bean.  | 
 void | 
resetRequiredFieldsFormExceptions()
Removes all 'missing required field' exceptions except of the one for order ID property.  | 
 void | 
setApplyOrderErrorURL(java.lang.String pApplyOrderErrorURL)
 | 
 void | 
setApplyOrderSuccessURL(java.lang.String pApplyOrderSuccessURL)
 | 
 void | 
setApplyReturnErrorURL(java.lang.String pApplyReturnErrorURL)
 | 
 void | 
setApplyReturnSuccessURL(java.lang.String pApplyReturnSuccessURL)
 | 
 void | 
setEmailAFriendMessage(java.lang.String pEmailAFriendMessage)
 | 
 void | 
setEmailAFriendMessageParameterName(java.lang.String pEmailAFriendMessageParameterName)
 | 
 void | 
setEmailLocale(java.lang.String pEmailLocale)
 | 
 void | 
setEmailLocaleName(java.lang.String pEmailLocaleName)
 | 
 void | 
setLogin(java.lang.String pLogin)
 | 
 void | 
setNewPassword(java.lang.String pNewPassword)
 | 
 void | 
setNewPasswordParameterName(java.lang.String pNewPasswordParameterName)
 | 
 void | 
setOrderId(java.lang.String pOrderId)
 | 
 void | 
setOrderManager(atg.commerce.order.OrderManager pOrderManager)
 | 
 void | 
setOrderMessage(java.lang.String pOrderMessage)
 | 
 void | 
setOrderParameterName(java.lang.String pOrderParameterName)
 | 
 void | 
setOrderRecipientEmail(java.lang.String pOrderRecipientEmail)
 | 
 void | 
setOrderRecipientName(java.lang.String pOrderRecipientName)
 | 
 void | 
setOrderSenderEmail(java.lang.String pOrderSenderEmail)
 | 
 void | 
setOrderSenderName(java.lang.String pOrderSenderName)
 | 
 void | 
setOrderSubject(java.lang.String pOrderSubject)
 | 
 void | 
setOrderTools(StoreOrderTools pOrderTools)
 | 
 void | 
setPassword(java.lang.String pPassword)
 | 
 void | 
setProductId(java.lang.String pProductId)
 | 
 void | 
setProductIdParameterName(java.lang.String pProductIdParameterName)
 | 
 void | 
setProfileItemFinder(StoreRepositoryProfileItemFinder pProfileItemFinder)
 | 
 void | 
setReturnItemToQuantityMap(java.util.Map<java.lang.String,java.lang.String> pReturnItemToQuantityMap)
 | 
 void | 
setReturnItemToQuantityReceivedParameterName(java.lang.String pReturnItemToQuantityReceivedParameterName)
 | 
 void | 
setReturnRequestId(java.lang.String pReturnRequestId)
 | 
 void | 
setReturnRequestParameterName(java.lang.String pReturnRequestParameterName)
 | 
 void | 
setReturnTools(atg.commerce.csr.returns.ReturnTools pReturnTools)
The service that is used to find the desired returns  | 
 void | 
setSessionBean(TemplateTesterSessionBean pSessionBean)
 | 
 void | 
setShippingGroupId(java.lang.String pShippingGroupId)
 | 
 void | 
setShippingGroupParameterName(java.lang.String pShippingGroupParameterName)
 | 
 void | 
setSkuId(java.lang.String pSkuId)
 | 
 void | 
setSkuIdParameterName(java.lang.String pSkuIdParameterName)
 | 
 void | 
storeUserInputsIntoSession()
Stores user's input into session bean.  | 
protected  void | 
validateInputs()
Check that items are acceptable on the selected site  | 
| Methods inherited from class atg.droplet.GenericFormHandler | 
|---|
addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, 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, doStartService, 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 | 
|---|
public static final java.lang.String CLASS_VERSION
public static final java.lang.String INVALID_SKU_ID_MSG
public static final java.lang.String INVALID_SHIPPING_GROUP_ID_MSG
public static final java.lang.String INVALID_ORDER_ID_MSG
public static final java.lang.String INVALID_PRODUCT_ID_MSG
public static final java.lang.String INVALID_RETURNREQUEST_ID_MSG
public static final java.lang.String NO_RETURN_ITEMS_QUANTITY_MSG
public static final java.lang.String EMAIL_ID_PARAM
public static final java.lang.String USER_PROFILE_TYPE
public static final java.lang.String ORDER_ID_PROPERTY_NAME
public static final java.lang.String MISSING_REQUIRED_FIELD
public static final java.lang.String MSG_ACTION_SENT_EMAIL
| Constructor Detail | 
|---|
public TemplateTesterFormHandler()
| Method Detail | 
|---|
public java.lang.String getNewPassword()
public void setNewPassword(java.lang.String pNewPassword)
pNewPassword - the String to setpublic StoreRepositoryProfileItemFinder getProfileItemFinder()
public void setProfileItemFinder(StoreRepositoryProfileItemFinder pProfileItemFinder)
pProfileItemFinder - the ProfileItemFinder to setpublic atg.commerce.order.OrderManager getOrderManager()
public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)
pOrderManager - the OrderManager to setpublic void setReturnTools(atg.commerce.csr.returns.ReturnTools pReturnTools)
pReturnTools - the ReturnTools component.public atg.commerce.csr.returns.ReturnTools getReturnTools()
public java.lang.String getLogin()
public void setLogin(java.lang.String pLogin)
pLogin - the String to setpublic java.lang.String getPassword()
public void setPassword(java.lang.String pPassword)
pPassword - the String to setpublic java.lang.String getOrderId()
public void setOrderId(java.lang.String pOrderId)
pOrderId - the String to setpublic java.lang.String getReturnRequestId()
public void setReturnRequestId(java.lang.String pReturnRequestId)
pReturnRequestId - the String to setpublic java.lang.String getProductId()
public void setProductId(java.lang.String pProductId)
pProductId - the String to setpublic java.lang.String getSkuId()
public void setSkuId(java.lang.String pSkuId)
pSkuId - the String to setpublic java.lang.String getShippingGroupId()
public void setShippingGroupId(java.lang.String pShippingGroupId)
pShippingGroupId - the String to setpublic StoreOrderTools getOrderTools()
public void setOrderTools(StoreOrderTools pOrderTools)
pOrderTools - the OrderTools to setpublic java.lang.String getNewPasswordParameterName()
public void setNewPasswordParameterName(java.lang.String pNewPasswordParameterName)
pNewPasswordParameterName - the String to setpublic java.lang.String getProductIdParameterName()
public void setProductIdParameterName(java.lang.String pProductIdParameterName)
pProductIdParameterName - the String to setpublic java.lang.String getSkuIdParameterName()
public void setSkuIdParameterName(java.lang.String pSkuIdParameterName)
pSkuIdParameterName - the String to setpublic java.lang.String getEmailAFriendMessageParameterName()
public void setEmailAFriendMessageParameterName(java.lang.String pEmailAFriendMessageParameterName)
pEmailAFriendMessageParameterName - the String to setpublic java.lang.String getOrderParameterName()
public void setOrderParameterName(java.lang.String pOrderParameterName)
pOrderParameterName - the String to setpublic java.lang.String getReturnRequestParameterName()
public void setReturnRequestParameterName(java.lang.String pReturnRequestParameterName)
pReturnRequestParameterName - the String to setpublic java.lang.String getReturnItemToQuantityReceivedParameterName()
public void setReturnItemToQuantityReceivedParameterName(java.lang.String pReturnItemToQuantityReceivedParameterName)
pReturnItemToQuantityReceivedParameterName - the String to setpublic java.lang.String getShippingGroupParameterName()
public void setShippingGroupParameterName(java.lang.String pShippingGroupParameterName)
pShippingGroupParameterName - the String to setpublic java.lang.String getOrderRecipientEmail()
public void setOrderRecipientEmail(java.lang.String pOrderRecipientEmail)
pOrderRecipientEmail - the String to setpublic java.lang.String getOrderRecipientName()
public void setOrderRecipientName(java.lang.String pOrderRecipientName)
pOrderRecipientName - the String to setpublic java.lang.String getOrderSenderName()
public void setOrderSenderName(java.lang.String pOrderSenderName)
pOrderSenderName - the String to setpublic java.lang.String getOrderSenderEmail()
public void setOrderSenderEmail(java.lang.String pOrderSenderEmail)
pOrderSenderEmail - the String to setpublic java.lang.String getOrderSubject()
public void setOrderSubject(java.lang.String pOrderSubject)
pOrderSubject - the String to setpublic java.lang.String getOrderMessage()
public void setOrderMessage(java.lang.String pOrderMessage)
pOrderMessage - the Type to setpublic java.lang.String getEmailAFriendMessage()
public void setEmailAFriendMessage(java.lang.String pEmailAFriendMessage)
pEmailAFriendMessage - the String to setpublic java.lang.String getEmailLocale()
public void setEmailLocale(java.lang.String pEmailLocale)
pEmailLocale - the emailLocale to setpublic java.lang.String getEmailLocaleName()
public void setEmailLocaleName(java.lang.String pEmailLocaleName)
pEmailLocaleName - the emailLocaleName to setpublic java.util.Map<java.lang.String,java.lang.String> getReturnItemToQuantityMap()
public void setReturnItemToQuantityMap(java.util.Map<java.lang.String,java.lang.String> pReturnItemToQuantityMap)
pReturnItemToQuantityMap - the ReturnItemToQuantityMap to setpublic java.lang.String getApplyOrderSuccessURL()
public void setApplyOrderSuccessURL(java.lang.String pApplyOrderSuccessURL)
pApplyOrderSuccessURL - the applyOrderSuccessURLpublic java.lang.String getApplyOrderErrorURL()
public void setApplyOrderErrorURL(java.lang.String pApplyOrderErrorURL)
pApplyOrderErrorURL - the applyOrderErrorURL to setpublic java.lang.String getApplyReturnSuccessURL()
public void setApplyReturnSuccessURL(java.lang.String pApplyReturnSuccessURL)
pApplyReturnSuccessURL - the ApplyReturnSuccessURLpublic java.lang.String getApplyReturnErrorURL()
public void setApplyReturnErrorURL(java.lang.String pApplyReturnErrorURL)
pApplyReturnErrorURL - the ApplyReturnErrorURL to setpublic TemplateTesterSessionBean getSessionBean()
public void setSessionBean(TemplateTesterSessionBean pSessionBean)
pSessionBean - the sessionBean to setpublic atg.userprofiling.Profile getProfile()
getProfile in class GenericEmailSenderFormHandlerprotected java.util.ResourceBundle getResourceBundle()
public java.lang.String getResourceBundleName()
getResourceBundleName in class GenericEmailSenderFormHandlerprotected java.util.Map collectParams()
collectParams in class GenericEmailSenderFormHandler
public boolean handleApplyOrder(atg.servlet.DynamoHttpServletRequest pRequest,
                                atg.servlet.DynamoHttpServletResponse pResponse)
                         throws javax.servlet.ServletException,
                                java.io.IOException
pRequest - HTTP requestpResponse - HTTP response
javax.servlet.ServletException - if there was an error while executing the code
java.io.IOException - if there was an error with servlet iopublic void resetRequiredFieldsFormExceptions()
public boolean handleApplyReturn(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException
pRequest - HTTP requestpResponse - HTTP response
javax.servlet.ServletException - if there was an error while executing the code
java.io.IOException - if there was an error with servlet io
public boolean handleInitializeForm(atg.servlet.DynamoHttpServletRequest pRequest,
                                    atg.servlet.DynamoHttpServletResponse pResponse)
pRequest - HTTP requestpResponse - HTTP response
java.lang.Exception
public boolean handleInitFromSentList(atg.servlet.DynamoHttpServletRequest pRequest,
                                      atg.servlet.DynamoHttpServletResponse pResponse)
                               throws java.lang.NumberFormatException
pRequest - dynamo http requestpResponse - dynamo http response
java.lang.NumberFormatException - application has attempted to convert a string 
 to one of the numeric types, but that the string does not have the appropriate format.
public boolean handleSend(atg.servlet.DynamoHttpServletRequest pRequest,
                          atg.servlet.DynamoHttpServletResponse pResponse)
                   throws java.io.IOException,
                          javax.servlet.ServletException
handleSend in class GenericEmailSenderFormHandlerpRequest - dynamo http requestpResponse - dynamo http response
javax.servlet.ServletException - if there was an error while executing the code
java.io.IOException - if there was an error with servlet io
protected void validateInputs()
                       throws atg.repository.RepositoryException,
                              atg.commerce.CommerceException
atg.repository.RepositoryException - indicates that a severe error occured while performing a Repository task
atg.commerce.CommerceExceptionpublic void storeUserInputsIntoSession()
public void initializeForm()
public void initFromSentList(int pIndex)
pIndex - - index of SentItem object in the list. We use SentItem to initialize
 form handler fields
  | 
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||