atg.projects.store.profile.email
Class EmailCampaignFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.repository.servlet.RepositoryFormHandler
                      atg.projects.store.profile.email.EmailCampaignFormHandler

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.repository.servlet.RepositoryFormConstants, atg.repository.servlet.RepositoryFormData, java.util.EventListener

public class EmailCampaignFormHandler
extends atg.repository.servlet.RepositoryFormHandler

This formhandler is used to create an EmailRecipient repository item when a user signs up to receive marketing email campaigns.

Field Summary

static java.lang.String

CLASS_VERSION Class version string.

Fields inherited from class atg.repository.servlet.RepositoryFormHandler

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.repository.servlet.RepositoryFormConstants

NULL_SENTINEL, REPOSITORY_ID_PROPERTY_NAME, RESOURCE_BUNDLE_NAME, UPDATE_APPEND, UPDATE_PREPEND, UPDATE_REMOVE, UPDATE_REPLACE

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

EmailCampaignFormHandler()

Method Summary

protected void	addFormException(java.lang.String pMsgKey, 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, 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).
StoreEmailTools	getEmailTools()
java.lang.String	getRegistrationEmail() The email to use to register.
java.lang.String	getSourceCode() The code that indicates the source of the form input.
boolean	handleCreateEmailRecipient(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Creates an EmailRecipient with the user's email.
void	setEmailTools(StoreEmailTools pEmailTools)
void	setRegistrationEmail(java.lang.String pRegistrationEmail) The email to use to register.
void	setSourceCode(java.lang.String pSourceCode) The code that indicates the source of the form input.

Methods inherited from class atg.repository.servlet.RepositoryFormHandler

checkFormError, checkFormSuccess, checkForRequiredProperties, deleteItem, getCheckForReadOnlyProperties, getCheckForRequiredProperties, getContentItemDescriptor, getContentNameProperty, getContentPathProperty, getCreateErrorURL, getCreateSuccessURL, getDeleteErrorURL, getDeleteSuccessURL, getEditMapsAsLists, getErrorHandler, getExtractDefaultValuesFromItem, getFolderIdProperty, getItemDescriptor, getItemDescriptorName, getItemProperty, getLogger, getMapKeyValueSeparator, getRemoveReferencesToDeletedItems, getRepository, getRepositoryId, getRepositoryItem, getRepositoryItemEditor, getRepositoryPathName, getRequireIdOnCreate, getSpecifiedIdPropertyValue, getTransactionDemarcation, getTransactionManager, getTrimProperties, getUpdateErrorURL, getUpdateSuccessURL, getValue, getValueProperty, handleCreate, handleDelete, handleUpdate, isClearValueOnSet, isCreateTransientItems, isRequireMapKeys, isSortRepositoryItemSets, isTrimProperty, isUpdateItemsInCollection, postCreateItem, postDeleteItem, postUpdateItem, postUpdateItemProperties, preCreateItem, preDeleteItem, preUpdateItem, setCheckForReadOnlyProperties, setCheckForRequiredProperties, setClearValueOnSet, setContentNameProperty, setContentPathProperty, setCreateErrorURL, setCreateSuccessURL, setCreateTransientItems, setDeleteErrorURL, setDeleteSuccessURL, setEditMapsAsLists, setExtractDefaultValuesFromItem, setFolderIdProperty, setItemDescriptorName, setMapKeyValueSeparator, setRemoveReferencesToDeletedItems, setRepository, setRepositoryId, setRepositoryItemEditor, setRepositoryPathName, setRequireIdOnCreate, setRequireMapKeys, setSortRepositoryItemSets, setTrimProperties, setUpdateErrorURL, setUpdateItemsInCollection, setUpdateSuccessURL, setValueProperty, testPropertyAttribute, updateChildItemProperty, updateContentItemValues, updateItem, updateItemProperties, updateListProperty, updateMapProperty

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

Constructor Detail

EmailCampaignFormHandler

public EmailCampaignFormHandler()

Method Detail

getRegistrationEmail

public java.lang.String getRegistrationEmail()

The email to use to register.

Returns:

registration e-mail

setRegistrationEmail

public void setRegistrationEmail(java.lang.String pRegistrationEmail)

The email to use to register.

Parameters:

pRegistrationEmail - - registration e-mail

getSourceCode

public java.lang.String getSourceCode()

The code that indicates the source of the form input.

Returns:

source code

setSourceCode

public void setSourceCode(java.lang.String pSourceCode)

The code that indicates the source of the form input.

Parameters:

pSourceCode - - source code

getEmailTools

public StoreEmailTools getEmailTools()

Returns:

the StoreEmailTools

setEmailTools

public void setEmailTools(StoreEmailTools pEmailTools)

Parameters:

pEmailTools - the StoreEmailTools to set

handleCreateEmailRecipient

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

Creates an EmailRecipient with the user's email.

Parameters:

pRequest - - HTTP Request

pResponse - - HTTP Response

Returns:

True if success False if failed

Throws:

javax.servlet.ServletException - - if servlet exception occurs

java.io.IOException - - if I/O exception occurs

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 - - HTTP Request Object

addFormException

protected void addFormException(java.lang.String pMsgKey,
                                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:

pMsgKey - - key to the message in the bundl

pRequest - - HTTP Request Object