Skip navigation links

oracle.search.query.webservice.client
Class OracleSearchResult

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

public class OracleSearchResult

extends java.lang.Object

OracleSearchResult encapsulates results for the user's query.

Constructor Summary

OracleSearchResult()

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

Method Summary

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

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

Constructor Detail

OracleSearchResult

public OracleSearchResult()

OracleSearchResult

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

Parameters:

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

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 java.lang.Boolean getReturnCount()

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

setReturnCount

public void setReturnCount(java.lang.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 java.lang.Integer getEstimatedHitCount()

Returns the estimated hit count for the query.

setEstimatedHitCount

public void setEstimatedHitCount(java.lang.Integer estimatedHitCount)

Sets the estimated hit count for the query.

Parameters:

estimatedHitCount - estimated hit count for the query

getDupRemoved

public java.lang.Boolean getDupRemoved()

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

setDupRemoved

public void setDupRemoved(java.lang.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 java.lang.Boolean getDupMarked()

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

setDupMarked

public void setDupMarked(java.lang.Boolean dupMarked)

Sets the 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 java.lang.String getQuery()

Returns the query string.

setQuery

public void setQuery(java.lang.String query)

Sets query string.

Parameters:

query - query string

getAltKeywords

public java.lang.String getAltKeywords()

Returns the alternate keywords for the query.

setAltKeywords

public void setAltKeywords(java.lang.String altKeywords)

Sets the alternate keywords for the query.

Parameters:

altKeywords - alternate keywords for the query

getStartIndex

public java.lang.Integer getStartIndex()

Returns the start index for the hit-list.

setStartIndex

public void setStartIndex(java.lang.Integer startIndex)

Sets the start index for the hit-list.

Parameters:

startIndex - start index of the hit-list

getDocsReturned

public java.lang.Integer getDocsReturned()

Returns the number of search hits returned.

setDocsReturned

public void setDocsReturned(java.lang.Integer docsReturned)

Sets the number of search hits returned.

Parameters:

docsReturned - number of search hits returned

Skip navigation links