com.sapportals.wcm.service.indexmanagement.retrieval.search

Interface IRawSearchSession

public interface IRawSearchSession

Access to a search session from the input side.

Method Summary

void	addPropertyInfo(String attrName, IPropertyInfo propertyInfo)
IRawSearchResult	createRawSearchResult(String docKey, float rankValue)
IRawSearchResult	createRawSearchResult(String docKey, float rankValue, IProperty sortProperty, IPropertyMap resultResourceProperties)
IPropertyInfo	getPropertyInfo(String attrName)
List	getRawSearchResults() Gets all in the session existing results
List	getRawSearchResults(int newMaxResults) If the session has less than new max results a search with newMaxResults is performed and these raw results are returned.
ISearchResultList	getSearchResults(List rawSearchResults) Converts raw search results in real search results
ISortPropertyName	getSortProperty()
void	setRawSearchResults(List rawSearchResults) List of raw search results is set by the index impl
void	setSearchLanguages(Set languages) Sets the languages, on which the search is restricted.
void	setTotalNumberResultKeys(int totalNumberDocKeys) Sets the total number of document keys that can be returned.

Method Detail

setRawSearchResults

public void setRawSearchResults(List rawSearchResults)

List of raw search results is set by the index impl

getRawSearchResults

public List getRawSearchResults(int newMaxResults)
                         throws WcmException

If the session has less than new max results a search with newMaxResults is performed and these raw results are returned. Otherwise the raw search results of the session are returned.

Parameters:

newMaxResults - new maximum number of returned results

Returns:

list of IRawSearchResult

Throws:

WcmException

getRawSearchResults

public List getRawSearchResults()

Gets all in the session existing results

Returns:

list of IRawSearchResult

getSearchResults

public ISearchResultList getSearchResults(List rawSearchResults)
                                   throws ResourceException

Converts raw search results in real search results

Parameters:

rawSearchResults - list of IRawSearchResult

Returns:

list of search result objects (with resources)

Throws:

ResourceException

createRawSearchResult

public IRawSearchResult createRawSearchResult(String docKey,
                                              float rankValue)

Parameters:

docKey - document key of the result

rankValue - rank value of the search result

Returns:

new raw search result

createRawSearchResult

public IRawSearchResult createRawSearchResult(String docKey,
                                              float rankValue,
                                              IProperty sortProperty,
                                              IPropertyMap resultResourceProperties)

Parameters:

docKey - document key of the result

rankValue - rank value of the search result

sortProperty - property that has been used for sorting

resultResourceProperties - properties of the result that have been retrieved by the search engine

Returns:

new raw search result

getSortProperty

public ISortPropertyName getSortProperty()

Returns:

property that has been used for sorting

setTotalNumberResultKeys

public void setTotalNumberResultKeys(int totalNumberDocKeys)

Sets the total number of document keys that can be returned.

Parameters:

totalNumberDocKeys - total number of document keys

setSearchLanguages

public void setSearchLanguages(Set languages)

Sets the languages, on which the search is restricted.

Parameters:

languages - set of strings describing languages

getPropertyInfo

public IPropertyInfo getPropertyInfo(String attrName)

Returns:

addPropertyInfo

public void addPropertyInfo(String attrName,
                            IPropertyInfo propertyInfo)

Parameters:

propertyInfo -