com.plumtree.remote.search
Interface ISearchResult

public interface ISearchResult

Interface that represents search results.

Method Summary

int	getNumberSkipped() Gets the number of results skipped.
ISearchRecord[]	getSearchResultList() Gets the array of ISearchRecords.
int	getTotalNumberOfHits() Gets the total number of search results.
boolean	isDescriptionEncoded() Checks whether the record descriptions will be HTML encoded.
void	setDescriptionEncoded(boolean encoded) Sets whether to HTML encode the descriptions.
void	setNumberSkipped(int skipped) Sets the number of results skipped.
void	setSearchResultList(ISearchRecord[] records) Sets the ISearchRecord array returned by the search.
void	setTotalNumberOfHits(int hits) Sets the total number of hits returned by the search.

Method Detail

setNumberSkipped

public void setNumberSkipped(int skipped)

Sets the number of results skipped.

Parameters:

skipped - the number of results skipped

getNumberSkipped

public int getNumberSkipped()

Gets the number of results skipped.

Returns:

the number of results skipped

setSearchResultList

public void setSearchResultList(ISearchRecord[] records)

Sets the ISearchRecord array returned by the search.

Parameters:

records - the ISearchRecord array; records cannot be null and cannot contain any null elements

getSearchResultList

public ISearchRecord[] getSearchResultList()

Gets the array of ISearchRecords.

Returns:

the ISearchRecord array

setTotalNumberOfHits

public void setTotalNumberOfHits(int hits)

Sets the total number of hits returned by the search. If this value is not set, the number of ISearchRecords in setSearchResultList will be used.

Parameters:

hits - the total number of hits

getTotalNumberOfHits

public int getTotalNumberOfHits()

Gets the total number of search results.

Returns:

the total number of search results

setDescriptionEncoded

public void setDescriptionEncoded(boolean encoded)

Sets whether to HTML encode the descriptions.

Parameters:

encoded - true to encode descriptions

isDescriptionEncoded

public boolean isDescriptionEncoded()

Checks whether the record descriptions will be HTML encoded.

Returns:

boolean true if the record descriptions will be HTML encoded