|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.projects.store.email.GenericEmailSenderFormHandler atg.projects.store.catalog.EmailAFriendFormHandler
public class EmailAFriendFormHandler
Form handler for sending email from the ATG Store website.
The JSP form
that accepts the email can directly set the From, Subject and To fields or
use the defaults as named in the configuration of the DefaultEmailInfo.
When the form submits the parameters the template is used to format the email
and then the EmailSender sends the email. The names for the From, Subject, To
and Profile parameters that are sent to the Email Template are set in the
configuration and must match the email template.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string. |
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 | |
---|---|
EmailAFriendFormHandler()
|
Method Summary | |
---|---|
protected java.util.Map |
collectParams()
Collect parameters for e-mail templates |
java.lang.String |
getLocale()
Gets the value of the Locale: field. |
java.lang.String |
getLocaleParamName()
|
java.lang.String |
getProductId()
Gets the value of the ProductId: field. |
java.lang.String |
getProductIdParamName()
Gets the name of the parameter used for the ProductId: field. |
java.lang.String |
getStoreId()
Gets the value of the StoreId: field. |
java.lang.String |
getStoreIdParamName()
|
java.lang.String |
getSubjectParamName()
Gets the name of the parameter used for the Subject: field. |
java.lang.String |
getSuccessURL()
|
protected void |
redirectOrForward(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse,
java.lang.String pURL)
|
void |
setLocale(java.lang.String pLocale)
Sets the value of the locale: field. |
void |
setLocaleParamName(java.lang.String pLocaleParamName)
|
void |
setProductId(java.lang.String pProductId)
Sets the value of the ProductId: field. |
void |
setProductIdParamName(java.lang.String pProductIdParamName)
Sets the name of the parameter used for the ProductId: field. |
void |
setStoreId(java.lang.String pStoreId)
Sets the value of the StoreId: field. |
void |
setStoreIdParamName(java.lang.String pStoreIdParamName)
The storeId parameter name - it represents the Store from which the email is dispatched parameter to be used in Email template |
void |
setSubjectParamName(java.lang.String pSubjectParamName)
Sets the name of the parameter used for the Subject: field. |
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, 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, 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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public EmailAFriendFormHandler()
Method Detail |
---|
public java.lang.String getProductIdParamName()
public void setProductIdParamName(java.lang.String pProductIdParamName)
pProductIdParamName
- -
the name of the parameter used for the ProductId: field.public java.lang.String getSubjectParamName()
getSubjectParamName
in class GenericEmailSenderFormHandler
public void setSubjectParamName(java.lang.String pSubjectParamName)
setSubjectParamName
in class GenericEmailSenderFormHandler
pSubjectParamName
- -
the name of the parameter used for the Subject: field.public void setLocaleParamName(java.lang.String pLocaleParamName)
pLocaleParamName
- -
locale parameter name.public java.lang.String getLocaleParamName()
public java.lang.String getLocale()
public void setLocale(java.lang.String pLocale)
pLocale
- -
the value of the locale: field.public java.lang.String getProductId()
public void setProductId(java.lang.String pProductId)
pProductId
- -
the value of the ProductId: field.public void setStoreIdParamName(java.lang.String pStoreIdParamName)
pStoreIdParamName
- storeId parameter namepublic java.lang.String getStoreIdParamName()
public java.lang.String getStoreId()
public void setStoreId(java.lang.String pStoreId)
pStoreId
- The value of the StoreId: field.protected java.util.Map collectParams()
GenericEmailSenderFormHandler
collectParams
in class GenericEmailSenderFormHandler
protected void redirectOrForward(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse, java.lang.String pURL) throws java.io.IOException, javax.servlet.ServletException
redirectOrForward
in class atg.droplet.GenericFormHandler
java.io.IOException
javax.servlet.ServletException
public java.lang.String getSuccessURL()
getSuccessURL
in class GenericEmailSenderFormHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |