atg.search.routing.command.search
Class FeedbackReport

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.FeedbackReport
All Implemented Interfaces:
java.io.Serializable

public class FeedbackReport
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Feedback report for QueryRequests and StructuredQueryRequests.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
FeedbackReport(RelatedPhraseTerms relatedPhraseTerms, RelatedSentenceTerms relatedSentenceTerms, RelatedDocumentSets relatedDocumentSets)
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 RelatedDocumentSets getRelatedDocumentSets()
          Returns related document sets.
 RelatedPhraseTerms getRelatedPhraseTerms()
          Returns related phrase terms
 RelatedSentenceTerms getRelatedSentenceTerms()
          Returns related sentence terms
 java.lang.String getRequestTag()
          Gets the xml element tag used in the request
 void setRelatedDocumentSets(RelatedDocumentSets relatedDocumentSets)
          Sets related document sets
 void setRelatedPhraseTerms(RelatedPhraseTerms relatedPhraseTerms)
          Sets related phrase terms
 void setRelatedSentenceTerms(RelatedSentenceTerms relatedSentenceTerms)
          Sets related sentence terms
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

FeedbackReport

public FeedbackReport(RelatedPhraseTerms relatedPhraseTerms,
                      RelatedSentenceTerms relatedSentenceTerms,
                      RelatedDocumentSets relatedDocumentSets)
Method Detail

equals

public boolean equals(java.lang.Object pObject)
Overrides:
equals in class java.lang.Object

getRelatedPhraseTerms

public RelatedPhraseTerms getRelatedPhraseTerms()
Returns related phrase terms

Returns:
related phrase terms

setRelatedPhraseTerms

public void setRelatedPhraseTerms(RelatedPhraseTerms relatedPhraseTerms)
Sets related phrase terms

Parameters:
relatedPhraseTerms -

getRelatedSentenceTerms

public RelatedSentenceTerms getRelatedSentenceTerms()
Returns related sentence terms

Returns:
related sentence terms

setRelatedSentenceTerms

public void setRelatedSentenceTerms(RelatedSentenceTerms relatedSentenceTerms)
Sets related sentence terms

Parameters:
relatedSentenceTerms -

getRelatedDocumentSets

public RelatedDocumentSets getRelatedDocumentSets()
Returns related document sets.

Returns:
related document sets

setRelatedDocumentSets

public void setRelatedDocumentSets(RelatedDocumentSets relatedDocumentSets)
Sets related document sets

Parameters:
relatedDocumentSets -

getRequestTag

public java.lang.String getRequestTag()
Gets the xml element tag used in the request

Specified by:
getRequestTag in class atg.search.routing.command.SearchXMLObject
Returns:
xml element tag

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException
Overrides:
getBodyXML in class atg.search.routing.command.SearchXMLObject
Throws:
atg.search.routing.command.IncompleteCommandException