com.primus.ae.searchclient
Class ClientVicRequest

java.lang.Object
  com.primus.ae.searchclient.ClientRequestImpl
      com.primus.ae.searchclient.ClientVicRequest

All Implemented Interfaces:

atg.search.routing.command.SearchEngineRequest, ClientRequest, java.io.Serializable

Deprecated. as of 9.0. Use ViewDocumentRequest instead.

public class ClientVicRequest
extends ClientRequestImpl

A client view in context (VIC) request fetches the document (or information about the document) associated with a particular answer. Thus it is always necessary to submit a ClientQueryRequest before submitting one of these. The easiest way to utilize this request type is to invoke ClientVicRequest(com.primus.searchstudio.ResponseSummary) with a ResponseSummary obtained from the Result of interest. In the most common usage scenario, the aforementioned Result corresponds to answer displayed to the user that they subsequently clicked on because the want to see the answer in the context of the original document. Result oneResult = results.getResult(i); This client request class differs from the rest in that it is not initialized with prepared documentSet constraints or parserOptions. Owing to their complexity for this request type, we rely on the existing com.primus.searchstudio.ViewRequest class to assemble them. Note that, as with other request types, user (security) roles are not passed in: they are obtained later, during request construction, from the SearchSession.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.primus.ae.searchclient.ClientRequestImpl

constraints, listPropertyAllowed, loggingEnabled, mLoggingThisRequest, mRequestIdentifier, mRequestTime, parsingOptions, requestAttributes

Fields inherited from interface com.primus.ae.searchclient.ClientRequest

BROWSE, CATEGORIZE, INSPECT, QUERY, REQUEST_TAG_BROWSE, REQUEST_TAG_CATEGORIZE, REQUEST_TAG_QUERY, REQUEST_TAG_SIMILARDOCS, REQUEST_TAG_STRUCTQUERY, REQUEST_TAG_VIC, SIMILARDOCS, STRUCTQUERY, TAGS, VIC

Fields inherited from interface atg.search.routing.command.SearchEngineRequest

CLASS_VERSION

Constructor Summary

ClientVicRequest()
Deprecated.

ClientVicRequest(com.primus.searchstudio.ResponseSummary responseSummary)
Deprecated.

ClientVicRequest(ViewItemConstants.ReturnType returnType, java.lang.String docContextId, java.lang.String userInput, java.lang.String groupId, java.lang.String requestURL, com.primus.searchstudio.ResponseSummary responseSummary, java.util.Map requestAttributes, Language language, java.lang.String viewDocProperty, java.lang.String viewDocPropertyValue, boolean loggingEnabled)
Deprecated. creates a new client vic request

Method Summary

java.lang.String	getDocContextId() Deprecated. Gets the document context ID
java.lang.String	getGroupId() Deprecated. gets the id group of the group that provided the answer
Language	getLanguage() Deprecated. Gets the target language
int	getRequestId() Deprecated.
java.lang.String	getRequestURL() Deprecated. Gets the request URL
com.primus.searchstudio.ResponseSummary	getResponseSummary() Deprecated. Gets the response summary object.
ViewItemConstants.ReturnType	getReturnType() Deprecated. Return type for vic request
java.lang.String	getUserInput() Deprecated. Gets the user's original input (question)
java.lang.String	getViewDocProperty() Deprecated. Gets the name of the view document property
java.lang.String	getViewDocPropertyValue() Deprecated. Gets the value of the doc property
void	setDocContextId(java.lang.String docContextId) Deprecated. Sets the doc context id
void	setGroupId(java.lang.String groupId) Deprecated. Sets the id of the group that provided the answer
void	setLanguage(Language language) Deprecated. Sets the target language
void	setRequestURL(java.lang.String requestURL) Deprecated. Sets the request url of the original request
void	setResponseSummary(com.primus.searchstudio.ResponseSummary responseSummary) Deprecated. Sets the response summary
void	setReturnType(ViewItemConstants.ReturnType returnType) Deprecated. Sets vic request return type
void	setUserInput(java.lang.String userInput) Deprecated. Sets the user's question
void	setViewDocProperty(java.lang.String viewDocProperty) Deprecated. Sets the view document propert name
void	setViewDocPropertyValue(java.lang.String viewDocPropertyValue) Deprecated. Sets the view doc property value
java.lang.String	toXML() Deprecated. returns xml suitable for submission to a search engine.

Methods inherited from class com.primus.ae.searchclient.ClientRequestImpl

getConstraints, getConstraintsXml, getParsingOptions, getParsingOptionsXml, getRequestAttribute, getRequestAttributes, getRequestIdentifier, getRequestTag, getRequestTime, getSearchConstraints, isFiringSearchEvents, isKeepingResponseData, isListPropertyAllowed, isLoggingEnabled, isLoggingThisRequest, processResponse, setConstraints, setFiringSearchEvents, setKeepingResponseData, setListPropertyAllowed, setLoggingEnabled, setLoggingThisRequest, setParsingOptions, setRequestAttribute, setRequestAttributes, setRequestIdentifier, setRequestTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientVicRequest

public ClientVicRequest()

Deprecated.

ClientVicRequest

public ClientVicRequest(com.primus.searchstudio.ResponseSummary responseSummary)

Deprecated.

ClientVicRequest

public ClientVicRequest(ViewItemConstants.ReturnType returnType,
                        java.lang.String docContextId,
                        java.lang.String userInput,
                        java.lang.String groupId,
                        java.lang.String requestURL,
                        com.primus.searchstudio.ResponseSummary responseSummary,
                        java.util.Map requestAttributes,
                        Language language,
                        java.lang.String viewDocProperty,
                        java.lang.String viewDocPropertyValue,
                        boolean loggingEnabled)

Deprecated.

creates a new client vic request

Parameters:

returnType - A ViewItemConstants.ReturnType

docContextId - context info obtained from original response: Document identifier plus highligh regions, in the form of hdoc:start.end,start.end,...

userInput - user input (the question) from original response

groupId - id of group that provided the answer

requestURL - request url from original response

responseSummary - response summary--required for logging

requestAttributes - request attributes, usually from option set stockVICRequestOptions

language - Request language, for example, Language.ENGLISH

viewDocProperty - optional document property name, can be null

viewDocPropertyValue - optional document property value, can be null

loggingEnabled - true if DB logging should be performed

See Also:

ViewItemConstants

Method Detail

getGroupId

public java.lang.String getGroupId()

Deprecated.

gets the id group of the group that provided the answer

Returns:

group id

setGroupId

public void setGroupId(java.lang.String groupId)

Deprecated.

Sets the id of the group that provided the answer

Parameters:

groupId - group id

getReturnType

public ViewItemConstants.ReturnType getReturnType()

Deprecated.

Return type for vic request

Returns:

One of RequestConstants.VIC_RETURN_* values

setReturnType

public void setReturnType(ViewItemConstants.ReturnType returnType)

Deprecated.

Sets vic request return type

Parameters:

returnType - One of ReturnType values

getLanguage

public Language getLanguage()

Deprecated.

Gets the target language

Returns:

the language

setLanguage

public void setLanguage(Language language)

Deprecated.

Sets the target language

Parameters:

language - the language, e.g., Language.ENGLISH

getDocContextId

public java.lang.String getDocContextId()

Deprecated.

Gets the document context ID

Returns:

doc context id

setDocContextId

public void setDocContextId(java.lang.String docContextId)

Deprecated.

Sets the doc context id

Parameters:

docContextId - context id from original response

getUserInput

public java.lang.String getUserInput()

Deprecated.

Gets the user's original input (question)

Returns:

the question

setUserInput

public void setUserInput(java.lang.String userInput)

Deprecated.

Sets the user's question

Parameters:

userInput - the question

getRequestURL

public java.lang.String getRequestURL()

Deprecated.

Gets the request URL

Returns:

the url

setRequestURL

public void setRequestURL(java.lang.String requestURL)

Deprecated.

Sets the request url of the original request

Parameters:

requestURL - url from the original response

getViewDocProperty

public java.lang.String getViewDocProperty()

Deprecated.

Gets the name of the view document property

Returns:

the property name

setViewDocProperty

public void setViewDocProperty(java.lang.String viewDocProperty)

Deprecated.

Sets the view document propert name

Parameters:

viewDocProperty - the name of the property

getViewDocPropertyValue

public java.lang.String getViewDocPropertyValue()

Deprecated.

Gets the value of the doc property

Returns:

the property value

setViewDocPropertyValue

public void setViewDocPropertyValue(java.lang.String viewDocPropertyValue)

Deprecated.

Sets the view doc property value

Parameters:

viewDocPropertyValue - the property's value

getResponseSummary

public com.primus.searchstudio.ResponseSummary getResponseSummary()

Deprecated.

Gets the response summary object.

Returns:

response summary, or null

setResponseSummary

public void setResponseSummary(com.primus.searchstudio.ResponseSummary responseSummary)

Deprecated.

Sets the response summary

Parameters:

responseSummary - the response summary

getRequestId

public int getRequestId()

Deprecated.

Returns:

ClientRequest.VIC

toXML

public java.lang.String toXML()
                       throws atg.search.routing.command.IncompleteCommandException

Deprecated.

returns xml suitable for submission to a search engine. In the case where this request has already been submitted, call this method to examine the submitted xml.

Returns:

request xml

Throws:

atg.search.routing.command.IncompleteCommandException - if the command is incomplete