|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.search.query.webservice.client.OracleSearchResult
public class OracleSearchResult
OracleSearchResult encapsulates results for the user's query.
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 |
---|
public OracleSearchResult()
public OracleSearchResult(Boolean returnCount, Integer estimatedHitCount, Boolean dupRemoved, Boolean dupMarked, ResultElement[] resultElements, SuggestedLink[] suggestedLinks, String query, String altKeywords, Integer startIndex, Integer docsReturned)
returnCount
- Boolean value indicating if the result includes count estimate for the hit listestimatedHitCount
- 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 resultdupMarked
- Boolean value indicating whether duplicate document have been marked in the resultresultElements
- hit list for the querysuggestedLinks
- suggested links for the queryquery
- query stringaltKeywords
- alternate keywords for the querystartIndex
- start index of the search resultdocsReturned
- number of search hits returnedMethod Detail |
---|
public Boolean getReturnCount()
public Boolean isReturnCount()
public void setReturnCount(Boolean returnCount)
returnCount
- Boolean value indicating whether the estimated hit count is included in the resultpublic Integer getEstimatedHitCount()
public void setEstimatedHitCount(Integer estimatedHitCount)
estimatedHitCount
- estimated hit count for the querypublic Boolean getDupRemoved()
public Boolean isDupRemoved()
public void setDupRemoved(Boolean dupRemoved)
dupRemoved
- Boolean value indicating if the duplicate documents are removed from the hit listpublic Boolean getDupMarked()
public Boolean isDupMarked()
public void setDupMarked(Boolean dupMarked)
dupMarked
- Boolean value indicating if the duplicate documents are marked in the hit listpublic ResultElement[] getResultElements()
public void setResultElements(ResultElement[] resultElements)
resultElements
- hit list for the querypublic SuggestedLink[] getSuggestedLinks()
public void setSuggestedLinks(SuggestedLink[] suggestedLinks)
suggestedLinks
- suggested links for the querypublic String getQuery()
public void setQuery(String query)
query
- query stringpublic String getAltKeywords()
public void setAltKeywords(String altKeywords)
altKeywords
- alternate keywords for the querypublic Integer getStartIndex()
public void setStartIndex(Integer startIndex)
startIndex
- start index of the hit listpublic Integer getDocsReturned()
public void setDocsReturned(Integer docsReturned)
docsReturned
- number of search hits returned
|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |