|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.SearchXMLObject atg.search.routing.command.SearchEngineCommandResponse atg.search.routing.command.search.SearchResponse atg.search.routing.command.search.ViewDocumentRequest.Response
public static class ViewDocumentRequest.Response
Response type for the ViewDocumentRequest
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.search.routing.command.search.SearchResponse |
---|
mMultiPartitionSearch |
Constructor Summary | |
---|---|
ViewDocumentRequest.Response(atg.search.routing.command.SearchEngineResponse response)
Constructs a response from an engine's response |
|
ViewDocumentRequest.Response(ViewDocumentRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This Java Merge instead of the engine's merge. |
Method Summary | |
---|---|
java.lang.String |
getDocContextId()
Returns Document identifier plus highlight regions |
ViewedDocument |
getDocument()
Returns the Document of the result |
java.lang.String |
getDocumentText()
Returns the document's text if this was a normal View request, otherwise null |
java.lang.String |
getHighlightInfo()
Returns highlight information |
java.lang.String |
getInput()
Returns original user input |
ItemInspect |
getItemInspect()
Returns item inspection |
ParserOptions |
getParserOptions()
Returns text processing options |
ViewDocumentRequest.Return |
getReturn()
Returns the return type |
java.lang.String |
getURL()
Returns the URL of document |
protected void |
merge(SearchRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This is Java merge. |
void |
setDocContextId(java.lang.String docContextId)
Sets Document identifier plus highlight regions |
void |
setDocument(ViewedDocument document)
Sets Document of the result |
void |
setDocumentText(java.lang.String documentText)
Sets the document's text |
void |
setHighlightInfo(java.lang.String highlightInfo)
Sets highlight information |
void |
setInput(java.lang.String input)
Sets original user input |
void |
setItemInspect(ItemInspect pItem)
Sets item inspection |
void |
setParserOptions(ParserOptions parserOptions)
Sets text processing options |
void |
setReturn(ViewDocumentRequest.Return aReturn)
Sets the return type |
void |
setURL(java.lang.String URL)
Sets URL of document |
Methods inherited from class atg.search.routing.command.SearchEngineCommandResponse |
---|
getNextResponse, getNonSAXParser, getRequestTag, getSearchEngineResponse, parseResponse, setNextResponse, setSearchEngineResponse |
Methods inherited from class atg.search.routing.command.SearchXMLObject |
---|
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ViewDocumentRequest.Response(ViewDocumentRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
#merge(atg.search.routing.command.search.ViewDocumentRequest,SearchResponse[])
.
pRequest
- original requestpParsedResponses
- parsed responses
atg.search.routing.MergeException
public ViewDocumentRequest.Response(atg.search.routing.command.SearchEngineResponse response)
response
- an engine's responseMethod Detail |
---|
protected void merge(SearchRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
merge
in class SearchResponse
pRequest
- the original requestpParsedResponses
- pre-parsed responses
atg.search.routing.MergeException
- if the merge failspublic java.lang.String getDocumentText()
public void setDocumentText(java.lang.String documentText)
documentText
- the document's textpublic java.lang.String getInput()
public void setInput(java.lang.String input)
input
- original user inputpublic ViewDocumentRequest.Return getReturn()
public void setReturn(ViewDocumentRequest.Return aReturn)
aReturn
- the return typepublic java.lang.String getURL()
public void setURL(java.lang.String URL)
URL
- URL of documentpublic java.lang.String getHighlightInfo()
public void setHighlightInfo(java.lang.String highlightInfo)
highlightInfo
- highlight informationpublic java.lang.String getDocContextId()
public void setDocContextId(java.lang.String docContextId)
docContextId
- Document identifier plus highlight regionspublic ViewedDocument getDocument()
public void setDocument(ViewedDocument document)
document
- the Document of the resultpublic ItemInspect getItemInspect()
public void setItemInspect(ItemInspect pItem)
pItem
- item inspectionpublic ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- text processing options
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |