public class ViewDocumentFormHandler extends BaseSearchFormHandler
ViewDocumentRequest
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ViewDocumentFormHandler() |
Modifier and Type | Method and Description |
---|---|
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.
|
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
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
afterGet, beforeGet
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public boolean isViewDocument()
public void setViewDocument(boolean pViewDocument)
public boolean handleViewDocument(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public java.lang.String getQueryInput()
public void setQueryInput(java.lang.String queryInput)
protected SearchRequest beforeSearch(SearchRequest pRequest, atg.search.client.SearchSession pSession)
BaseSearchFormHandler
beforeSearch
in class BaseSearchFormHandler
pRequest
- the client query requestpSession
- the search sessionprotected SearchRequest stringToRequest(java.lang.String pString)
BaseSearchFormHandler
stringToRequest
in class BaseSearchFormHandler
pString
- XML request stringpublic ViewDocumentRequest.Return getReturnType()
public void setReturnType(ViewDocumentRequest.Return pReturnType)
public java.lang.String getSearchEnvironmentName()
public void setSearchEnvironmentName(java.lang.String searchEnvironmentName)
public java.lang.String getContentGuid()
public void setContentGuid(java.lang.String contentGuid)
public java.lang.String getContextInfoStr()
public void setContextInfoStr(java.lang.String contextInfoStr)
public java.lang.String getDocUrl()
public void setDocUrl(java.lang.String url)