atg.svc.ui.formhandlers
Class UserOptionsFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      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.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, 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

Field Summary

static java.lang.String	CLASS_VERSION
protected java.util.Map<java.lang.String,atg.svc.repository.beans.UserOption>	mOptions
protected java.lang.String	mRestoreOptions
static java.lang.String	OPTION_SEPARATOR

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

PERFMON_OP_FORM_HANDLER

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.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.svc.ui.formhandlers.FormHandlerConstants

OPTIONS_ANSWER_DISPLAY, OPTIONS_ANSWER_DISPLAY_CURRENT_WINDOW, OPTIONS_ANSWER_DISPLAY_MULTIPLE_WINDOWS, OPTIONS_ANSWER_DISPLAY_SINGLE_WINDOW, OPTIONS_FILTER_BY_DOC_SET, OPTIONS_FILTER_BY_FORMAT, OPTIONS_FILTER_BY_SOURCE, OPTIONS_FILTER_BY_TITLE, OPTIONS_FILTER_OR_GROUPING_FILTER, OPTIONS_FILTER_OR_GROUPING_GROUP, OPTIONS_FILTER_OR_GROUPING_NONE, OPTIONS_QUERY_LANGUAGE, OPTIONS_RESULT_LANGUAGE, OPTIONS_SHOW_ANSWERS_AS, OPTIONS_SHOW_ANSWERS_BY_DOC, OPTIONS_SHOW_ANSWERS_INDIVIDUAL, OPTIONS_SHOW_FAQS_AS_QUESTIONS, OPTIONS_SHOW_FAQS_AS_QUESTIONS_AND_ANSWERS, PARAM_SITE_ID

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

UserOptionsFormHandler()

Method Summary

protected void	formHandlerInit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Populates getOptions() for the current user
java.util.Map<java.lang.String,atg.svc.repository.beans.UserOption>	getOptions() Lazy loaded map of option name and option.
java.lang.String	getProfileComponentName() Name of the /atg/userprofiling/Profile compoent
java.lang.String	getRestoreOptions() List of option names to restore.
atg.svc.repository.service.UserOptionService	getUserOptionService()
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) Saves any options modified in getOptions()
void	setOptions(java.util.Map<java.lang.String,atg.svc.repository.beans.UserOption> pOptions) Lazy loaded map of option name and option.
void	setProfileComponentName(java.lang.String pProfileComponentName) Name of the /atg/userprofiling/Profile compoent
void	setRestoreOptions(java.lang.String pRestoreOptions) List of option names to restore.
void	setUserOptionService(atg.svc.repository.service.UserOptionService pUserOptionService)

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, getDefaultLocale, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserLocale, getUserMessagesResourceBundle, handleCancel, isUseRequestLocale, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setDefaultLocale, setRedirectDelayMS, setSuccessURL, setUseRequestLocale, setUserMessagesResourceBundle

Methods inherited from class atg.droplet.TransactionalFormHandler

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

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, 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

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

OPTION_SEPARATOR

public static final java.lang.String OPTION_SEPARATOR

See Also:

Constant Field Values

mRestoreOptions

protected java.lang.String mRestoreOptions

mOptions

protected java.util.Map<java.lang.String,atg.svc.repository.beans.UserOption> mOptions

Constructor Detail

UserOptionsFormHandler

public UserOptionsFormHandler()

Method Detail

getUserOptionService

public atg.svc.repository.service.UserOptionService getUserOptionService()

See Also:

UserOptionService

setUserOptionService

public void setUserOptionService(atg.svc.repository.service.UserOptionService pUserOptionService)

See Also:

UserOptionService

getRestoreOptions

public java.lang.String getRestoreOptions()

List of option names to restore. Options delimited by #OPTION_SEPARATOR

setRestoreOptions

public void setRestoreOptions(java.lang.String pRestoreOptions)

List of option names to restore. Options delimited by #OPTION_SEPARATOR

getOptions

public java.util.Map<java.lang.String,atg.svc.repository.beans.UserOption> getOptions()

Lazy loaded map of option name and option.

setOptions

public void setOptions(java.util.Map<java.lang.String,atg.svc.repository.beans.UserOption> pOptions)

Lazy loaded map of option name and option.

getProfileComponentName

public java.lang.String getProfileComponentName()

Name of the /atg/userprofiling/Profile compoent

setProfileComponentName

public void setProfileComponentName(java.lang.String pProfileComponentName)

Name of the /atg/userprofiling/Profile compoent

formHandlerInit

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

Populates getOptions() for the current user

Overrides:

formHandlerInit in class FrameworkBaseFormHandler

handleSave

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

Saves any options modified in getOptions()

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. Requires populating setRestoreOptions(String)

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