atg.svc.ui.formhandlers
Class TopicTreeFormHandler

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

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 TopicTreeFormHandler
extends FrameworkBaseFormHandler

Placeholder form handler for topic tree functionality. Stores current node
Properties

topicId	String	Id of current topic
targetId	String	Id of target where we want to load the children
treeId	String	Id of our tree component

Version:

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

Author:

ssaarine

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

TopicTreeFormHandler()

Method Summary

boolean	getCountFilter()
java.lang.String	getIncludeOtherTopic()
java.lang.String	getLabelExclude()
java.lang.String	getLabelInclude()
java.lang.String	getTargetId()
java.lang.String	getTopicId()
java.lang.String	getTreeId()
boolean	handleTraverse(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	setCountFilter(boolean pCountFilter)
void	setIncludeOtherTopic(java.lang.String pIncludeOtherTopic)
void	setLabelExclude(java.lang.String pLabelExclude)
void	setLabelInclude(java.lang.String pLabelInclude)
void	setTargetId(java.lang.String targetId)
void	setTopicId(java.lang.String topicId)
void	setTreeId(java.lang.String treeId)

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

Class version string

Constructor Detail

TopicTreeFormHandler

public TopicTreeFormHandler()

Method Detail

getTopicId

public java.lang.String getTopicId()

setTopicId

public void setTopicId(java.lang.String topicId)

getTargetId

public java.lang.String getTargetId()

setTargetId

public void setTargetId(java.lang.String targetId)

getTreeId

public java.lang.String getTreeId()

setTreeId

public void setTreeId(java.lang.String treeId)

getLabelExclude

public java.lang.String getLabelExclude()

setLabelExclude

public void setLabelExclude(java.lang.String pLabelExclude)

getLabelInclude

public java.lang.String getLabelInclude()

setLabelInclude

public void setLabelInclude(java.lang.String pLabelInclude)

getCountFilter

public boolean getCountFilter()

setCountFilter

public void setCountFilter(boolean pCountFilter)

getIncludeOtherTopic

public java.lang.String getIncludeOtherTopic()

setIncludeOtherTopic

public void setIncludeOtherTopic(java.lang.String pIncludeOtherTopic)

handleTraverse

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

Throws:

javax.servlet.ServletException

java.io.IOException