atg.svc.ui.formhandlers
Class RatingFormHandler

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

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={"ratingService","eventTools","recommendedAnswerService","fireRatingMessageSource","ticketingManager"})
public class RatingFormHandler
extends ServiceFormHandler

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

RatingFormHandler()

Method Summary

java.lang.String	getComment()
java.lang.String	getContentId() Deprecated. Use #getDocId
java.lang.String	getContextId()
java.lang.String	getDocId()
java.lang.String	getDocType()
java.lang.String	getEmailAddress()
atg.svc.agent.events.SelfServiceEventTools	getEventTools()
java.lang.String	getExcerpt()
java.lang.Boolean	getIsContactingSupport()
atg.svc.search.KnowledgeQueryContext	getKnowledgeQueryContextForWindow()
java.lang.String	getQueryId()
java.lang.String	getRatingName()
atg.svc.reporting.RatingService	getRatingService()
RecommendedAnswerService	getRecommendedAnswerService()
java.lang.String	getSolutionVersion()
java.lang.String	getTicketId()
atg.ticketing.TicketingManager	getTicketingManager()
java.lang.String	getTitle()
java.lang.String	getUrl()
boolean	handleRate(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Given a user rating of a document or solution, this method creates a RecommendedAnswer.
boolean	isFireAnswerMessage()
boolean	isFireQueryResultsMessage()
void	setComment(java.lang.String pComment)
void	setContentId(java.lang.String pDocId) Deprecated. Use #setDocId
void	setContextId(java.lang.String pContextId)
void	setDocId(java.lang.String pDocId)
void	setDocType(java.lang.String pDocType)
void	setEmailAddress(java.lang.String pEmailAddress)
void	setEventTools(atg.svc.agent.events.SelfServiceEventTools pEventTools)
void	setExcerpt(java.lang.String pExcerpt)
void	setFireAnswerMessage(boolean pFireAnswerMessage)
void	setFireQueryResultsMessage(boolean pFireQueryResultsMessage)
void	setIsContactingSupport(java.lang.Boolean pIsContactingSupport)
void	setQueryId(java.lang.String pQueryId)
void	setRatingName(java.lang.String pRatingName)
void	setRatingService(atg.svc.reporting.RatingService pRatingService)
void	setRecommendedAnswerService(RecommendedAnswerService pRecommendedAnswerService)
void	setSolutionVersion(java.lang.String pSolutionVersion)
void	setTicketId(java.lang.String pTicketId)
void	setTicketingManager(atg.ticketing.TicketingManager pTicketingManager)
void	setTitle(java.lang.String pDocTitle)
void	setUrl(java.lang.String pUrl)

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, formHandlerInit, getDefaultLocale, getErrorURL, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserLocale, getUserMessagesResourceBundle, handleCancel, isUseRequestLocale, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setDefaultLocale, setErrorURL, 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

RatingFormHandler

public RatingFormHandler()

Method Detail

getKnowledgeQueryContextForWindow

public atg.svc.search.KnowledgeQueryContext getKnowledgeQueryContextForWindow()

getRatingService

public atg.svc.reporting.RatingService getRatingService()

setRatingService

public void setRatingService(atg.svc.reporting.RatingService pRatingService)

setEventTools

public void setEventTools(atg.svc.agent.events.SelfServiceEventTools pEventTools)

getEventTools

public atg.svc.agent.events.SelfServiceEventTools getEventTools()

getRecommendedAnswerService

public RecommendedAnswerService getRecommendedAnswerService()

setRecommendedAnswerService

public void setRecommendedAnswerService(RecommendedAnswerService pRecommendedAnswerService)

getTicketingManager

public atg.ticketing.TicketingManager getTicketingManager()

See Also:

TicketingManager

setTicketingManager

public void setTicketingManager(atg.ticketing.TicketingManager pTicketingManager)

See Also:

TicketingManager

setComment

public void setComment(java.lang.String pComment)

Parameters:

pComment - The comment to set.

getComment

public java.lang.String getComment()

setContentId

public void setContentId(java.lang.String pDocId)

Deprecated. Use #setDocId

Parameters:

pDocId - The solution id or doc url

getContentId

public java.lang.String getContentId()

Deprecated. Use #getDocId

setDocId

public void setDocId(java.lang.String pDocId)

Parameters:

pDocId - The solution id or doc url

getDocId

public java.lang.String getDocId()

setContextId

public void setContextId(java.lang.String pContextId)

Parameters:

pContextId - The contextId in search results to set.

getContextId

public java.lang.String getContextId()

setDocType

public void setDocType(java.lang.String pDocType)

Parameters:

pDocType - Set this value to either of RecommendedAnswerDocType as Solution, Document, PDFDocument

See Also:

RecommendedAnswerDocType

getDocType

public java.lang.String getDocType()

setEmailAddress

public void setEmailAddress(java.lang.String pEmailAddress)

Parameters:

pEmailAddress - The emailAddress to set.

getEmailAddress

public java.lang.String getEmailAddress()

setExcerpt

public void setExcerpt(java.lang.String pExcerpt)

Parameters:

pExcerpt - The excerpt of solution or document to set.

getExcerpt

public java.lang.String getExcerpt()

setIsContactingSupport

public void setIsContactingSupport(java.lang.Boolean pIsContactingSupport)

Parameters:

pIsContactingSupport - The isContactingSupport to set.

getIsContactingSupport

public java.lang.Boolean getIsContactingSupport()

setRatingName

public void setRatingName(java.lang.String pRatingName)

Parameters:

pRatingName - The ratingName to set.

getRatingName

public java.lang.String getRatingName()

setSolutionVersion

public void setSolutionVersion(java.lang.String pSolutionVersion)

Parameters:

pSolutionVersion - The solutionVersion to set.

getSolutionVersion

public java.lang.String getSolutionVersion()

setTicketId

public void setTicketId(java.lang.String pTicketId)

Parameters:

pTicketId - The ticketId associated with the solution to set.

getTicketId

public java.lang.String getTicketId()

setTitle

public void setTitle(java.lang.String pDocTitle)

Parameters:

pTitle - The document or solution title to set.

getTitle

public java.lang.String getTitle()

setUrl

public void setUrl(java.lang.String pUrl)

Parameters:

pUrl - The url for the document found in search results.

getUrl

public java.lang.String getUrl()

isFireAnswerMessage

public boolean isFireAnswerMessage()

setFireAnswerMessage

public void setFireAnswerMessage(boolean pFireAnswerMessage)

isFireQueryResultsMessage

public boolean isFireQueryResultsMessage()

setFireQueryResultsMessage

public void setFireQueryResultsMessage(boolean pFireQueryResultsMessage)

getQueryId

public java.lang.String getQueryId()

setQueryId

public void setQueryId(java.lang.String pQueryId)

handleRate

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

Given a user rating of a document or solution, this method creates a RecommendedAnswer. For solutions, the creation of a RecommendedAnswer will increase the use count of the solution. The RecommendedAnswer is associated with the current KnowledgeSession. If the session is escalated to support, the session will be associated with a ticket and the recommended answer will be accessible via a research activity in the ticket history.

Throws:

java.lang.Exception

See Also:

RecommendedAnswer