atg.svc.ui.formhandlers
Class UserOptionsFormHandler

java.lang.Object
  atg.nucleus.GenericService
      atg.droplet.EmptyFormHandler
          atg.droplet.GenericFormHandler
              atg.droplet.TransactionalFormHandler
                  atg.web.formhandlers.ApplicationFormHandler
                      atg.svc.ui.formhandlers.ServiceFormHandler
                          atg.svc.ui.formhandlers.FrameworkBaseFormHandler
                              atg.svc.ui.formhandlers.UserOptionsFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, FormHandlerConstants, java.util.EventListener

public class UserOptionsFormHandler
extends FrameworkBaseFormHandler

Retrieves a map of user options and allows them to be modified
Properties

options

Map

Map of all user options

Actions

save	Saves user options

Version:

$Id: //application/service/version/2007.3/common-ui/src/classes/atg/svc/ui/formhandlers/UserOptionsFormHandler.java#2 $$Change: 632007 $

Author:

wwechten

Field Summary

static java.lang.String	CLASS_VERSION
protected java.util.Map	mOptions
protected java.lang.String	mRestoreOptions
static java.lang.String	OPTION_SEPARATOR

Fields inherited from class atg.web.formhandlers.ApplicationFormHandler

EQUALS, PARAM_DELIMITER, QUERY_DELIMITER, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.svc.ui.formhandlers.FormHandlerConstants

OPTIONS_ANSWER_DISPLAY, OPTIONS_ANSWER_DISPLAY_CURRENT_WINDOW, OPTIONS_ANSWER_DISPLAY_MULTIPLE_WINDOWS, OPTIONS_ANSWER_DISPLAY_SINGLE_WINDOW, OPTIONS_ANSWERS_PER_PAGE, OPTIONS_FAQS_PER_PAGE, OPTIONS_FILTER_BY, OPTIONS_FILTER_BY_DOC_SET, OPTIONS_FILTER_BY_FORMAT, OPTIONS_FILTER_BY_SOURCE, OPTIONS_FILTER_BY_TITLE, OPTIONS_FILTER_OR_GROUPING, OPTIONS_FILTER_OR_GROUPING_FILTER, OPTIONS_FILTER_OR_GROUPING_GROUP, OPTIONS_FILTER_OR_GROUPING_NONE, OPTIONS_GROUP_BY, OPTIONS_QUERY_LANGUAGE, OPTIONS_RESULT_LANGUAGE, OPTIONS_SHOW_ANSWERS_AS, OPTIONS_SHOW_ANSWERS_BY_DOC, OPTIONS_SHOW_ANSWERS_INDIVIDUAL, OPTIONS_SHOW_FAQS_AS, OPTIONS_SHOW_FAQS_AS_QUESTIONS, OPTIONS_SHOW_FAQS_AS_QUESTIONS_AND_ANSWERS, PARAM_SITE_ID

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

UserOptionsFormHandler()

Method Summary

protected void	formHandlerInit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
java.util.Map	getOptions()
java.lang.String	getProfileComponentName()
java.lang.String	getRestoreOptions()
UserOptionsService	getUserOptionsService() Gets the UserOptionsService.
boolean	handleRestoreAllDefaultOptions(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used to restore All the default settings at options page.
boolean	handleRestoreDefaultOptions(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used to restore the default settings at options page.
boolean	handleSave(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	setOptions(java.util.Map pOptions)
void	setProfileComponentName(java.lang.String pProfileComponentName)
void	setRestoreOptions(java.lang.String pRestoreOptions)
void	setUserOptionsService(UserOptionsService pUserOptionsService) Sets the UserOptionsService.

Methods inherited from class atg.svc.ui.formhandlers.FrameworkBaseFormHandler

getErrorURL, getParameterMap, getParameters, handleChangeTab, handleCloseWindow, handleGetWindowTab, handleHidePanel, handleProcessPanel, handleScrollPanelTabsLeft, handleScrollPanelTabsRight, handleSelectTabbedPanel, handleShowPanel, handleToggleCell, handleTogglePanel, handleTogglePanelContent, handleTogglePanelsToTabs, handleTransform, setErrorURL, setParameterMap, setParameters

Methods inherited from class atg.svc.ui.formhandlers.ServiceFormHandler

handleUncheckedFormException, isLoggingUncheckedException, isRollbackTransactionOnFormError, isTransactionMarkedAsRollback, processException, processException, setLoggingUncheckedException, setRollbackTransactionOnFormError

Methods inherited from class atg.web.formhandlers.ApplicationFormHandler

addParameterToURLString, beforeGet, beforeSet, checkFormError, checkFormRedirect, checkFormSuccess, formHandlerBeforeGet, formHandlerBeforeSet, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserMessagesResourceBundle, handleCancel, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setRedirectDelayMS, setSuccessURL, setUserMessagesResourceBundle

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, commitTransaction, getTransactionDemarcation, isEnsureTransaction, isRollbackTransaction, setEnsureTransaction, setRollbackTransaction, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, handleFormException, isRestorableForm, isValidSession, resetFormExceptions, setCancelURL, setCheckForValidSession, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingWarning, setServiceInfo, startService, stopService

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

OPTION_SEPARATOR

public static final java.lang.String OPTION_SEPARATOR

See Also:

Constant Field Values

mOptions

protected java.util.Map mOptions

mRestoreOptions

protected java.lang.String mRestoreOptions

Constructor Detail

UserOptionsFormHandler

public UserOptionsFormHandler()

Method Detail

getRestoreOptions

public java.lang.String getRestoreOptions()

Returns:

Returns the restore options.

setRestoreOptions

public void setRestoreOptions(java.lang.String pRestoreOptions)

Parameters:

pRestoreOptions - The restore options to set.

getOptions

public java.util.Map getOptions()

Returns:

Returns the options.

setOptions

public void setOptions(java.util.Map pOptions)

Parameters:

pOptions - The options to set.

getProfileComponentName

public java.lang.String getProfileComponentName()

Returns:

Returns the profileComponentName.

setProfileComponentName

public void setProfileComponentName(java.lang.String pProfileComponentName)

Parameters:

pProfileComponentName - The profileComponentName to set.

formHandlerInit

protected void formHandlerInit(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse pResponse)

Overrides:

formHandlerInit in class FrameworkBaseFormHandler

handleSave

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

Throws:

javax.servlet.ServletException

java.io.IOException

handleRestoreDefaultOptions

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

This method is used to restore the default settings at options page.

Parameters:

pRequest -

pResponse -

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

handleRestoreAllDefaultOptions

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

This method is used to restore All the default settings at options page.

Parameters:

pRequest -

pResponse -

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

getUserOptionsService

public UserOptionsService getUserOptionsService()

Gets the UserOptionsService.

Returns:

The UserOptionsService.

setUserOptionsService

public void setUserOptionsService(UserOptionsService pUserOptionsService)

Sets the UserOptionsService.

Parameters:

pUserOptionsService - The UserOptionsService.