atg.portal.admin

Class PageColorFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.droplet.TransactionalFormHandler

atg.portal.admin.PortalGenericFormHandler

atg.portal.admin.PageFormHandler

atg.portal.admin.PageColorFormHandler

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, java.util.EventListener

public class PageColorFormHandler
extends PageFormHandler

This form handler provides convenient methods for updating a community page's color palette.

All handle methods in this form handler mirror a similiar pattern. Each handleXXX process, some have an associated preXXX and postXXX method. For example, the handleUpdateColor has an associated preUpdateColor and postUpdateColor. These pre/post methods provide an easy way for customer's to extend the functionality of this form handler.

See Also:

TransactionalFormHandler, PortalGenericFormHandler, PageFormHandler

Field Summary

Fields

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

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

Constructors

Constructor and Description
PageColorFormHandler()

Method Summary

Modifier and Type	Method and Description
boolean	handleUpdateColorAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to update the color palette of a page
boolean	handleUpdateColorUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to update the color palette of a personalized page a personalized page will be created if one does not exist.
void	postUpdateColorAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just after component update is finished
void	postUpdateColorUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just after component update is finished
void	preUpdateColorAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component update is started
void	preUpdateColorUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component update is started
protected boolean	updateColorAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) updateColor is called by the handlers to update the color palette of the page.
protected boolean	updateColorUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) updateColor is called by the handlers to update the color palette of the page.

Methods inherited from class atg.portal.admin.PageFormHandler

createPageAdminMode, createPageUserMode, deletePageAdminMode, deletePageUserMode, getAccessLevel, getAllowLayoutChanges, getColorPalette, getCommunity, getCommunityId, getDescription, getFixed, getGears, getLayoutTemplate, getMakeDefault, getName, getPage, getPageId, getParentCommunity, getParentFolder, getPortal, getPosition, getProfile, getRegions, getUrl, getWirelessEnabled, handleCreatePageAdminMode, handleCreatePageUserMode, handleDeletePageAdminMode, handleDeletePageUserMode, handleReset, handleUpdatePageAdminMode, handleUpdatePageUserMode, postCreatePageAdminMode, postCreatePageUserMode, postDeletePageAdminMode, postDeletePageUserMode, postUpdatePageAdminMode, postUpdatePageUserMode, preCreatePageAdminMode, preCreatePageUserMode, preDeletePageAdminMode, preDeletePageUserMode, preUpdatePageAdminMode, preUpdatePageUserMode, resetBean, setAccessLevel, setAllowLayoutChanges, setColorPalette, setCommunity, setCommunityId, setDescription, setFixed, setGears, setLayoutTemplate, setMakeDefault, setName, setPage, setPageId, setParentCommunity, setParentFolder, setPortal, setPosition, setProfile, setRegions, setUrl, setWirelessEnabled, updatePageAdminMode, updatePageUserMode

Methods inherited from class atg.portal.admin.PortalGenericFormHandler

addFormException, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, getDefaultLocale, getFailureMessageProcessor, getFailureURL, getFormError, getFormInfo, getFormMessages, getLocale, getPublisher, getSuccessMessageProcessor, getSuccessURL, getUserLocale, handleResetFormExceptions, handleResetFormMessages, handleSetLocale, isUseRequestLocale, processException, processException, processException, processException, processSuccess, processSuccess, processSuccess, resetFormMessages, sendAlertMessage, setDefaultLocale, setFailureMessageProcessor, setFailureURL, setPublisher, setSuccessMessageProcessor, setSuccessURL, setUseRequestLocale

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, 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, 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

PageColorFormHandler

public PageColorFormHandler()

Method Detail

handleUpdateColorAdminMode

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

Called to update the color palette of a page

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

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

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

updateColorAdminMode

protected boolean updateColorAdminMode(DynamoHttpServletRequest pRequest,
                                       DynamoHttpServletResponse pResponse)
                                throws java.io.IOException,
                                       javax.servlet.ServletException,
                                       SecurityException

updateColor is called by the handlers to update the color palette of the page.

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

SecurityException

preUpdateColorAdminMode

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

Operation called just before component update is started

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postUpdateColorAdminMode

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

Operation called just after component update is finished

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

handleUpdateColorUserMode

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

Called to update the color palette of a personalized page a personalized page will be created if one does not exist.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

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

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

updateColorUserMode

protected boolean updateColorUserMode(DynamoHttpServletRequest pRequest,
                                      DynamoHttpServletResponse pResponse)
                               throws java.io.IOException,
                                      javax.servlet.ServletException,
                                      SecurityException

updateColor is called by the handlers to update the color palette of the page.

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

SecurityException

preUpdateColorUserMode

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

Operation called just before component update is started

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postUpdateColorUserMode

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

Operation called just after component update is finished

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong