atg.search.formhandlers
Class ViewDocumentFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.search.formhandlers.BaseSearchFormHandler
                      atg.search.formhandlers.ViewDocumentFormHandler

All Implemented Interfaces:

DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class ViewDocumentFormHandler
extends BaseSearchFormHandler

This form handler issues requests using the ViewDocumentRequest.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

ViewDocumentFormHandler()

Method Summary

protected SearchRequest	beforeSearch(SearchRequest pRequest, atg.search.client.SearchSession pSession) This method is called just before a search is executed and is intended to allow subclasses an opportunity to make last minute changes to the request object or to update the search context.
java.lang.String	getContentGuid()
java.lang.String	getContextInfoStr()
java.lang.String	getDocUrl()
java.lang.String	getQueryInput()
ViewDocumentRequest.Return	getReturnType()
java.lang.String	getSearchEnvironmentName()
boolean	handleViewDocument(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
boolean	isViewDocument()
void	setContentGuid(java.lang.String contentGuid)
void	setContextInfoStr(java.lang.String contextInfoStr)
void	setDocUrl(java.lang.String url)
void	setQueryInput(java.lang.String queryInput)
void	setReturnType(ViewDocumentRequest.Return pReturnType)
void	setSearchEnvironmentName(java.lang.String searchEnvironmentName)
void	setViewDocument(boolean pViewDocument)
protected SearchRequest	stringToRequest(java.lang.String pString) Converts XML into a request object.

Methods inherited from class atg.search.formhandlers.BaseSearchFormHandler

afterSearch, createSearchSession, doRedirect, doRedirect, getClearFormURL, getEnvironmentTargets, getErrorURL, getLogicalPartitionNames, getRedirect, getRedirects, getRequestFile, getResultsFetcher, getSearchAssetTools, getSearchClient, getSearchContext, getSearchException, getSearchExceptions, getSearchRedirectProcessors, getSearchRequest, getSearchRequestProcessors, getSearchResponse, getSearchResponseProcessors, getSearchSession, getSuccessURL, getSuccessURLDynamicParams, getUserProfile, handleClearForm, handleConnect, handleErrorCondition, handleLoad, handleLoadAndSearch, handleSearch, isForceDeployedOnlyAssets, isLoggingVerboseResponseXML, isPageRequest, isRedirectEnabled, isShowDetailedResults, isShowXml, search, setClearFormURL, setErrorURL, setForceDeployedOnlyAssets, setLoggingVerboseResponseXML, setPageRequest, setRedirectEnabled, setRequestFile, setResultsFetcher, setSearchAssetTools, setSearchContext, setSearchExceptions, setSearchRedirectProcessors, setSearchRequest, setSearchRequestProcessors, setSearchResponse, setSearchResponseProcessors, setShowDetailedResults, setShowXml, setSuccessURL, setSuccessURLDynamicParams, setUserProfile

Methods inherited from class atg.droplet.GenericFormHandler

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

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

ViewDocumentFormHandler

public ViewDocumentFormHandler()

Method Detail

isViewDocument

public boolean isViewDocument()

setViewDocument

public void setViewDocument(boolean pViewDocument)

handleViewDocument

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

Throws:

java.io.IOException

javax.servlet.ServletException

getQueryInput

public java.lang.String getQueryInput()

setQueryInput

public void setQueryInput(java.lang.String queryInput)

beforeSearch

protected SearchRequest beforeSearch(SearchRequest pRequest,
                                     atg.search.client.SearchSession pSession)

Description copied from class: BaseSearchFormHandler

This method is called just before a search is executed and is intended to allow subclasses an opportunity to make last minute changes to the request object or to update the search context.

Subclasses may abort the search by returning a null client request. This default implementation returns the unmodified request object.

Overrides:

beforeSearch in class BaseSearchFormHandler

Parameters:

pRequest - the client query request

pSession - the search session

Returns:

the client request or null to abort the search request

stringToRequest

protected SearchRequest stringToRequest(java.lang.String pString)

Description copied from class: BaseSearchFormHandler

Converts XML into a request object. Useful for "Load old request from file" feature.

Specified by:

stringToRequest in class BaseSearchFormHandler

Parameters:

pString - XML request string

Returns:

request object of the appropriate type

getReturnType

public ViewDocumentRequest.Return getReturnType()

setReturnType

public void setReturnType(ViewDocumentRequest.Return pReturnType)

getSearchEnvironmentName

public java.lang.String getSearchEnvironmentName()

setSearchEnvironmentName

public void setSearchEnvironmentName(java.lang.String searchEnvironmentName)

getContentGuid

public java.lang.String getContentGuid()

setContentGuid

public void setContentGuid(java.lang.String contentGuid)

getContextInfoStr

public java.lang.String getContextInfoStr()

setContextInfoStr

public void setContextInfoStr(java.lang.String contextInfoStr)

getDocUrl

public java.lang.String getDocUrl()

setDocUrl

public void setDocUrl(java.lang.String url)