atg.search.query.formhandlers
Class ViewInContextFormHandler

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

All Implemented Interfaces:

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

public class ViewInContextFormHandler
extends BaseSearchFormHandler

This form handler issues requests using the <viewInContext> tag, which also corresponds to the ClientVicRequest of the searchclient API.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.search.query.formhandlers.BaseSearchFormHandler

DEFAULT_ANONYMOUS_USERNAME, DEFAULT_SITE_NAME

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

ViewInContextFormHandler()

Method Summary

protected ClientRequest	createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Create the appropriate ClientRequest subtype for this query type, in this case a ClientVicRequest object.
protected SearchMessage	createSearchMessage(ClientRequest pQueryRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Create the JMS message to represent a ClientQueryRequest and associated response data.
protected ClientVicRequest	getClientVicRequest() Convenience method for this class to avoid massive casting
java.lang.String	getDocContextId() Get the <viewInContext><docContextID> tag body
java.lang.String	getInput() Get the <viewInContext><input> tag's value
java.lang.String	getProperty() Get the <viewInContext><property> tag's body
java.lang.String	getReturn() Get the ClientVicRequest's returnType request attribute value as a string
java.lang.String	getUrl() Get the <viewInContext><url> tag's body
java.lang.String	getValue() Get the <viewInContext><value> tag's body
void	setDocContextId(java.lang.String pDocContextId) Set the <viewInContext><docContextID> tag body
void	setInput(java.lang.String pInput) Set the <viewInContext><input> tag's value
void	setProperty(java.lang.String pProperty) Set the <viewInContext><property> tag's body
void	setReturn(java.lang.String pReturnType) Set the ClientVicRequest's returnType property, corresponds to the query's return request attribute.
void	setUrl(java.lang.String pUrl) Set the <viewInContext><url> tag's body
void	setValue(java.lang.String pValue) Set the <viewInContext><value> tag's body

Methods inherited from class atg.search.query.formhandlers.BaseSearchFormHandler

afterSearch, beforeGet, beforeSearch, beforeSet, buildClientRequest, buildSimpleTag, createOptionSet, createSearchSession, createSessionConfig, decodeMapData, dumpMap, dumpRequestInfo, encodeArrayData, encodeCollectionData, encodeMapData, getAnonymousUserName, getAutoRedirect, getBooleanRequestAttribute, getBoolRequestAttribute, getClearQueryURL, getClientRequest, getDocumentSets, getDocumentSetsBuilder, getErrorURL, getIntegerRequestAttribute, getIntRequestAttribute, getOptionSet, getOptionSetName, getParserOptions, getParserOptionsBuilder, getRequestAttribute, getRequestAttributes, getResults, getResultsFetcher, getSearchContext, getSearchMessageSource, getSearchService, getSearchSession, getSessionBasedSearchRequest, getSessionBasedSearchResults, getSessionConfigLanguage, getSiteDefaultOptionSet, getSiteName, getStringArrayRequestAttribute, getSuccessURL, getUserProfile, handleAutoRedirect, handleClearQuery, handleErrorCondition, handleSearch, isRequestLogging, mergeMaps, prepareClientRequest, sendSearchMessage, setAnonymousUserName, setAutoRedirect, setBooleanRequestAttribute, setClearQueryURL, setClientRequest, setDocumentSetsBuilder, setErrorURL, setOptionSet, setOptionSetName, setParserOptionsBuilder, setRequestAttribute, setRequestAttributes, setRequestLogging, setResults, setResultsFetcher, setSearchContext, setSearchService, setSessionBasedSearchRequest, setSessionBasedSearchResults, setSessionConfigLanguage, setSiteName, setSuccessURL, setUserProfile

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, 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

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

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

ViewInContextFormHandler

public ViewInContextFormHandler()

Method Detail

setReturn

public void setReturn(java.lang.String pReturnType)

Set the ClientVicRequest's returnType property, corresponds to the query's return request attribute.

Parameters:

pReturnType - one of the valid strings for this attribute

getReturn

public java.lang.String getReturn()

Get the ClientVicRequest's returnType request attribute value as a string

Returns:

the string value or null

setUrl

public void setUrl(java.lang.String pUrl)

Set the <viewInContext><url> tag's body

Parameters:

pUrl - the <url> tag's body

getUrl

public java.lang.String getUrl()

Get the <viewInContext><url> tag's body

Returns:

the <url> tag's body

setValue

public void setValue(java.lang.String pValue)

Set the <viewInContext><value> tag's body

Parameters:

pValue - the <value> tag's body

getValue

public java.lang.String getValue()

Get the <viewInContext><value> tag's body

Returns:

the <value> tag's body

setInput

public void setInput(java.lang.String pInput)

Set the <viewInContext><input> tag's value

getInput

public java.lang.String getInput()

Get the <viewInContext><input> tag's value

Returns:

the input tag's value

setDocContextId

public void setDocContextId(java.lang.String pDocContextId)

Set the <viewInContext><docContextID> tag body

Parameters:

pDocContextId - the document context id value

getDocContextId

public java.lang.String getDocContextId()

Get the <viewInContext><docContextID> tag body

Returns:

pDocContextId the document context id value

setProperty

public void setProperty(java.lang.String pProperty)

Set the <viewInContext><property> tag's body

Parameters:

pProperty - the property tag body value

getProperty

public java.lang.String getProperty()

Get the <viewInContext><property> tag's body

Returns:

pProperty the property tag body value

createClientRequest

protected ClientRequest createClientRequest(DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)

Create the appropriate ClientRequest subtype for this query type, in this case a ClientVicRequest object.

Specified by:

createClientRequest in class BaseSearchFormHandler

Parameters:

pRequest - the Dynamo http request

pResponse - the Dynamo http response

Returns:

a new ClientRequest object

createSearchMessage

protected SearchMessage createSearchMessage(ClientRequest pQueryRequest,
                                            DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)

Create the JMS message to represent a ClientQueryRequest and associated response data.

Specified by:

createSearchMessage in class BaseSearchFormHandler

Parameters:

pQueryRequest - the ClientRequest

pRequest - the Dynamo http request

pResponse - the Dynamo http response

Returns:

the JMS message to be sent

getClientVicRequest

protected ClientVicRequest getClientVicRequest()

Convenience method for this class to avoid massive casting

Returns:

the ClientVicRequest