atg.svc.ui.formhandlers
Class RecommendedReadingFormHandler

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

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

@Service(requiredProperties={"userDictionary","profileService"})
public class RecommendedReadingFormHandler
extends FrameworkBaseFormHandler

Form handler for managing operation lik adding and deleting records for Recommended Reading

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

RecommendedReadingFormHandler()

Method Summary

java.lang.String	getContextId() The contextId of a document being used for recommended reading
java.lang.String	getOrgIds() The organizationIDs which are selected from recommended reading popup
ProfileService	getProfileService()
java.lang.String	getRecommendedReadingId()
java.lang.String	getSolutionId() The solutionId for a solution used in recommended reading
java.lang.String	getTitle() The title of a solution or document
java.lang.String	getType() The type--either solution or document--used for recommended reading
java.lang.String	getURL() The url of a document used for recommended reading
atg.userdirectory.UserDirectory	getUserDirectory()
java.lang.String	getUserId() The userId for a user belonging to a particular organization
boolean	handleAddToRecommendedReading(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called when the user performs an action that inserts a record that corresponds to a specified method @ param DynamoHttpServletRequest @ param DynamoHttpServletResponse
boolean	handleRemoveRecommendedReading(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called when the user performs an action that deletes a record that corresponds to a specified recommendedId @ param DynamoHttpServletRequest @ param DynamoHttpServletResponse
void	setContextId(java.lang.String pContextId)
void	setOrgIds(java.lang.String pOrgIds)
void	setProfileService(ProfileService pProfileService)
void	setRecommendedReadingId(java.lang.String pRecommendedReadingId)
void	setSolutionId(java.lang.String pSolutionId)
void	setTitle(java.lang.String pTitle)
void	setType(java.lang.String pType)
void	setURL(java.lang.String pURL)
void	setUserDirectory(atg.userdirectory.UserDirectory pUserDirectory)
void	setUserId(java.lang.String pUserId)

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

formHandlerInit, 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

Class version string

Constructor Detail

RecommendedReadingFormHandler

public RecommendedReadingFormHandler()

Method Detail

getUserDirectory

public atg.userdirectory.UserDirectory getUserDirectory()

See Also:

atg.userdictionary.UserDictionary

setUserDirectory

public void setUserDirectory(atg.userdirectory.UserDirectory pUserDirectory)

getProfileService

public ProfileService getProfileService()

See Also:

ProfileService

setProfileService

public void setProfileService(ProfileService pProfileService)

getRecommendedReadingId

public java.lang.String getRecommendedReadingId()

setRecommendedReadingId

public void setRecommendedReadingId(java.lang.String pRecommendedReadingId)

getSolutionId

public java.lang.String getSolutionId()

The solutionId for a solution used in recommended reading

setSolutionId

public void setSolutionId(java.lang.String pSolutionId)

getURL

public java.lang.String getURL()

The url of a document used for recommended reading

setURL

public void setURL(java.lang.String pURL)

getContextId

public java.lang.String getContextId()

The contextId of a document being used for recommended reading

setContextId

public void setContextId(java.lang.String pContextId)

getTitle

public java.lang.String getTitle()

The title of a solution or document

setTitle

public void setTitle(java.lang.String pTitle)

getType

public java.lang.String getType()

The type--either solution or document--used for recommended reading

setType

public void setType(java.lang.String pType)

getOrgIds

public java.lang.String getOrgIds()

The organizationIDs which are selected from recommended reading popup

setOrgIds

public void setOrgIds(java.lang.String pOrgIds)

getUserId

public java.lang.String getUserId()

The userId for a user belonging to a particular organization

setUserId

public void setUserId(java.lang.String pUserId)

handleAddToRecommendedReading

public boolean handleAddToRecommendedReading(atg.servlet.DynamoHttpServletRequest pRequest,
                                             atg.servlet.DynamoHttpServletResponse pResponse)
                                      throws java.lang.Exception

This method is called when the user performs an action that inserts a record that corresponds to a specified method @ param DynamoHttpServletRequest @ param DynamoHttpServletResponse

Returns:

boolean

Throws:

java.lang.Exception

handleRemoveRecommendedReading

public boolean handleRemoveRecommendedReading(atg.servlet.DynamoHttpServletRequest pRequest,
                                              atg.servlet.DynamoHttpServletResponse pResponse)
                                       throws java.lang.Exception

This method is called when the user performs an action that deletes a record that corresponds to a specified recommendedId @ param DynamoHttpServletRequest @ param DynamoHttpServletResponse

Returns:

boolean

Throws:

java.lang.Exception