|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class ViewInContextFormHandler
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.droplet.EmptyFormHandler |
---|
afterGet |
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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ViewInContextFormHandler()
Method Detail |
---|
public void setReturn(java.lang.String pReturnType)
pReturnType
- one of the valid strings for this attributepublic java.lang.String getReturn()
public void setUrl(java.lang.String pUrl)
pUrl
- the <url> tag's bodypublic java.lang.String getUrl()
public void setValue(java.lang.String pValue)
pValue
- the <value> tag's bodypublic java.lang.String getValue()
public void setInput(java.lang.String pInput)
public java.lang.String getInput()
public void setDocContextId(java.lang.String pDocContextId)
pDocContextId
- the document context id valuepublic java.lang.String getDocContextId()
public void setProperty(java.lang.String pProperty)
pProperty
- the property tag body valuepublic java.lang.String getProperty()
protected ClientRequest createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
createClientRequest
in class BaseSearchFormHandler
pRequest
- the Dynamo http requestpResponse
- the Dynamo http response
protected SearchMessage createSearchMessage(ClientRequest pQueryRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
createSearchMessage
in class BaseSearchFormHandler
pQueryRequest
- the ClientRequestpRequest
- the Dynamo http requestpResponse
- the Dynamo http response
protected ClientVicRequest getClientVicRequest()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |