atg.portal.admin
Class PageGearsFormHandler

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.PageGearsFormHandler

All Implemented Interfaces:

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 PageGearsFormHandler
extends PageFormHandler

This form handler provides convenient methods for adding or removing gears from a community page.

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 handleUpdateGears has an associated preUpdateGears and postUpdateGears. 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

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

PageGearsFormHandler()

Method Summary

boolean	handleReset(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Reset this formhandler.
boolean	handleUpdateGearsAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Update the list of gears available to an admin created page.
boolean	handleUpdateGearsUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to update the gears available to a page
void	postUpdateGearsAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just after component update is finished
void	postUpdateGearsUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just after component update is finished
void	preUpdateGearsAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component update is started
void	preUpdateGearsUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component update is started
protected boolean	updateGearsAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) updateGears is called by the handlers to update the list of gears available to a page.
protected boolean	updateGearsUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) updateGears is called by the handlers to update the list of gears available to a 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, 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

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

Class version string

Constructor Detail

PageGearsFormHandler

public PageGearsFormHandler()

Method Detail

handleUpdateGearsAdminMode

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

Update the list of gears available to an admin created 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

updateGearsAdminMode

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

updateGears is called by the handlers to update the list of gears available to a 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

preUpdateGearsAdminMode

public void preUpdateGearsAdminMode(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

postUpdateGearsAdminMode

public void postUpdateGearsAdminMode(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

handleUpdateGearsUserMode

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

Called to update the gears available to 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

updateGearsUserMode

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

updateGears is called by the handlers to update the list of gears available to a 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

preUpdateGearsUserMode

public void preUpdateGearsUserMode(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

postUpdateGearsUserMode

public void postUpdateGearsUserMode(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

handleReset

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

Reset this formhandler. Useful if used as a session scoped form handler.

Overrides:

handleReset in class PageFormHandler

Throws:

java.io.IOException

javax.servlet.ServletException