org.eaglei.search.provider
Class SearchResultSet

java.lang.Object
  org.eaglei.search.provider.SearchResultSet

All Implemented Interfaces:

java.io.Serializable

public class SearchResultSet
extends java.lang.Object
implements java.io.Serializable

Set of search results.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Constructor Summary

SearchResultSet(SearchRequest request)
Creates a new SearchResultSet

Method Summary

boolean	deepEquals(java.lang.Object obj)
boolean	equals(java.lang.Object obj)
java.util.List<org.eaglei.model.EIURI>	getInstitutionsIncluded() If partial results, list of institutional data included Undefined if no timeout occurred.
SearchRequest	getRequest() Gets the search request.
java.util.List<SearchResult>	getResults() Gets all of the SearchResults
int	getStartIndex() Start index for this result set.
int	getTotalCount() Total number of results for the search.
int	hashCode()
void	setInstitutionsIncluded(java.util.List<org.eaglei.model.EIURI> institutionsIncluded)
void	setStartIndex(int startIndex) Sets the start index.
void	setTotalCount(int totalCount) Sets the total number of results for the search.
void	setWasTimeout(boolean wasTimeout)
boolean	wasTimeout() True if timeout occurred, and result set is partial.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SearchResultSet

public SearchResultSet(SearchRequest request)

Creates a new SearchResultSet

Parameters:

request - The request

Method Detail

wasTimeout

public boolean wasTimeout()

True if timeout occurred, and result set is partial.

setWasTimeout

public void setWasTimeout(boolean wasTimeout)

getInstitutionsIncluded

public java.util.List<org.eaglei.model.EIURI> getInstitutionsIncluded()

If partial results, list of institutional data included Undefined if no timeout occurred.

setInstitutionsIncluded

public void setInstitutionsIncluded(java.util.List<org.eaglei.model.EIURI> institutionsIncluded)

getRequest

public SearchRequest getRequest()

Gets the search request.

Returns:

Search request.

getResults

public java.util.List<SearchResult> getResults()

Gets all of the SearchResults

getTotalCount

public int getTotalCount()

Total number of results for the search. Only a subset may be included in this result set.

Returns:

Total number of results

setTotalCount

public void setTotalCount(int totalCount)

Sets the total number of results for the search.

Parameters:

totalCount - Total number of results.

getStartIndex

public int getStartIndex()

Start index for this result set. 0-based.

Returns:

1-based start index.

setStartIndex

public void setStartIndex(int startIndex)

Sets the start index.

Parameters:

startIndex - 0-based start index

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

deepEquals

public boolean deepEquals(java.lang.Object obj)