Skip navigation links

oracle.search.query.webservice.client
Class OracleSearchResult

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

All Implemented Interfaces:

Serializable

public class OracleSearchResult

extends Object

implements Serializable

OracleSearchResult encapsulates results for the user's query.

See Also:

Serialized Form

Constructor Summary

OracleSearchResult()

OracleSearchResult(Boolean returnCount, Integer estimatedHitCount, Boolean dupRemoved, Boolean dupMarked, ResultElement[] resultElements, SuggestedLink[] suggestedLinks, String query, String altKeywords, Integer startIndex, Integer docsReturned)

Method Summary

String	getAltKeywords() Returns the alternate keywords for the query.
Integer	getDocsReturned() Returns the number of search hits returned.
Boolean	getDupMarked() Returns the Boolean value indicating if the duplicate documents are marked in the hit list.
Boolean	getDupRemoved() Returns the Boolean value indicating if the duplicate documents are removed from the hit list.
Integer	getEstimatedHitCount() Returns the estimated hit count for the query.
String	getQuery() Returns the query string.
ResultElement[]	getResultElements() Returns the hit list for the query.
Boolean	getReturnCount() Returns a Boolean value indicating whether the estimated hit count is included in the result.
Integer	getStartIndex() Returns the start index for the hit list.
SuggestedLink[]	getSuggestedLinks() Returns suggested links for the query.
Boolean	isDupMarked()
Boolean	isDupRemoved()
Boolean	isReturnCount()
void	setAltKeywords(String altKeywords) Sets the alternate keywords for the query.
void	setDocsReturned(Integer docsReturned) Sets the number of search hits returned.
void	setDupMarked(Boolean dupMarked) Sets the Boolean value indicating if the duplicate documents are marked in the hit list.
void	setDupRemoved(Boolean dupRemoved) Sets the Boolean value indicating if the duplicate documents are removed from the hit list.
void	setEstimatedHitCount(Integer estimatedHitCount) Sets the estimated hit count for the query.
void	setQuery(String query) Sets query string.
void	setResultElements(ResultElement[] resultElements) Sets the hit list for the query.
void	setReturnCount(Boolean returnCount) Sets the Boolean value indicating whether the estimated hit count is included in the result.
void	setStartIndex(Integer startIndex) Sets the start index for the hit list.
void	setSuggestedLinks(SuggestedLink[] suggestedLinks) Sets suggested links for the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleSearchResult

public OracleSearchResult()

OracleSearchResult

public OracleSearchResult(Boolean returnCount,
                          Integer estimatedHitCount,
                          Boolean dupRemoved,
                          Boolean dupMarked,
                          ResultElement[] resultElements,
                          SuggestedLink[] suggestedLinks,
                          String query,
                          String altKeywords,
                          Integer startIndex,
                          Integer docsReturned)

Parameters:

returnCount - Boolean value indicating if the result includes count estimate for the hit list

estimatedHitCount - estimated count for the hit list. -1 means the search result does not return estimated hit count.

dupRemoved - Boolean value indicating whether duplicate documents have been removed from the result

dupMarked - Boolean value indicating whether duplicate document have been marked in the result

resultElements - hit list for the query

suggestedLinks - suggested links for the query

query - query string

altKeywords - alternate keywords for the query

startIndex - start index of the search result

docsReturned - number of search hits returned

Method Detail

getReturnCount

public Boolean getReturnCount()

Returns a Boolean value indicating whether the estimated hit count is included in the result.

isReturnCount

public Boolean isReturnCount()

setReturnCount

public void setReturnCount(Boolean returnCount)

Sets the Boolean value indicating whether the estimated hit count is included in the result.

Parameters:

returnCount - Boolean value indicating whether the estimated hit count is included in the result

getEstimatedHitCount

public Integer getEstimatedHitCount()

Returns the estimated hit count for the query.

setEstimatedHitCount

public void setEstimatedHitCount(Integer estimatedHitCount)

Sets the estimated hit count for the query.

Parameters:

estimatedHitCount - estimated hit count for the query

getDupRemoved

public Boolean getDupRemoved()

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

isDupRemoved

public Boolean isDupRemoved()

setDupRemoved

public void setDupRemoved(Boolean dupRemoved)

Sets the Boolean value indicating if the duplicate documents are removed from the hit list.

Parameters:

dupRemoved - Boolean value indicating if the duplicate documents are removed from the hit list

getDupMarked

public Boolean getDupMarked()

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

isDupMarked

public Boolean isDupMarked()

setDupMarked

public void setDupMarked(Boolean dupMarked)

Sets the Boolean value indicating if the duplicate documents are marked in the hit list.

Parameters:

dupMarked - Boolean value indicating if the duplicate documents are marked in the hit list

getResultElements

public ResultElement[] getResultElements()

Returns the hit list for the query.

setResultElements

public void setResultElements(ResultElement[] resultElements)

Sets the hit list for the query.

Parameters:

resultElements - hit list for the query

getSuggestedLinks

public SuggestedLink[] getSuggestedLinks()

Returns suggested links for the query.

setSuggestedLinks

public void setSuggestedLinks(SuggestedLink[] suggestedLinks)

Sets suggested links for the query.

Parameters:

suggestedLinks - suggested links for the query

getQuery

public String getQuery()

Returns the query string.

setQuery

public void setQuery(String query)

Sets query string.

Parameters:

query - query string

getAltKeywords

public String getAltKeywords()

Returns the alternate keywords for the query.

setAltKeywords

public void setAltKeywords(String altKeywords)

Sets the alternate keywords for the query.

Parameters:

altKeywords - alternate keywords for the query

getStartIndex

public Integer getStartIndex()

Returns the start index for the hit list.

setStartIndex

public void setStartIndex(Integer startIndex)

Sets the start index for the hit list.

Parameters:

startIndex - start index of the hit list

getDocsReturned

public Integer getDocsReturned()

Returns the number of search hits returned.

setDocsReturned

public void setDocsReturned(Integer docsReturned)

Sets the number of search hits returned.

Parameters:

docsReturned - number of search hits returned

Skip navigation links