Skip navigation links

oracle.search.query.webservice.wssclient
Class OracleSearchResult

java.lang.Object
oracle.search.query.webservice.wssclient.OracleSearchResult

public class OracleSearchResult

extends Object

OracleSearchResult encapsulates results for the user's query.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="oracleSearchResult">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="altKeywords" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="docsReturned" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="dupMarked" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="dupRemoved" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="estimatedHitCount" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="query" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="resultElements" type="{http://search.oracle.com/Query}resultElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="returnCount" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="startIndex" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="suggestedLinks" type="{http://search.oracle.com/Query}suggestedLink" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Constructor Summary

OracleSearchResult()

Method Summary

String	getAltKeywords() Returns the alternate keywords for the query.
Integer	getDocsReturned() Returns the number of search hits returned.
Integer	getEstimatedHitCount() Returns the estimated hit count for the query.
String	getQuery() Returns the query string.
List	getResultElements() Returns the hit list for the query.
Integer	getStartIndex() Returns the start index for the hit list.
List	getSuggestedLinks() Returns suggested links for the query.
Boolean	isDupMarked() Returns the flag indicating if the duplicate documents are marked in the hit list.
Boolean	isDupRemoved() Returns the flag indicating if the duplicate documents are removed from the hit list.
Boolean	isReturnCount() Returns a flag indicating whether the search count is returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleSearchResult

public OracleSearchResult()

Method Detail

getAltKeywords

public String getAltKeywords()

Returns the alternate keywords for the query.

Returns:

alternate keywords

getDocsReturned

public Integer getDocsReturned()

Returns the number of search hits returned.

Returns:

number of search hits

isDupMarked

public Boolean isDupMarked()

Returns the flag indicating if the duplicate documents are marked in the hit list.

Returns:

duplicate marked flag

isDupRemoved

public Boolean isDupRemoved()

Returns the flag indicating if the duplicate documents are removed from the hit list.

Returns:

duplicate removal flag

getEstimatedHitCount

public Integer getEstimatedHitCount()

Returns the estimated hit count for the query.

Returns:

estimate hit count

getQuery

public String getQuery()

Returns the query string.

Returns:

query string

getResultElements

public List getResultElements()

Returns the hit list for the query.

Returns:

list of ResultElement

isReturnCount

public Boolean isReturnCount()

Returns a flag indicating whether the search count is returned.

Returns:

return count flag

getStartIndex

public Integer getStartIndex()

Returns the start index for the hit list.

Returns:

hit list start index

getSuggestedLinks

public List getSuggestedLinks()

Returns suggested links for the query.

Returns:

list of SuggestedLink

Skip navigation links