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

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

public interface ISearchSession

The session object contains the search results in a raw format. To get search results getSearchResults must be called. The session concept optimizes performance because only for the displayed results resources must be retrieved from the resource factory.

Method Summary

int	getNumberResultKeys() Gets the number of document keys that have been found so far.
IQueryEntryList	getQueryEntryList() Returns the query list of the session.
java.util.Map	getRenderParameters() Returns the rendring parameters defined in search for the session.
IResourceContext	getResourceContext() Context of the user that performed the search.
ISearchResultList	getSearchResults(int from, int to) List of search results from position a to b in the result list.
ISearchResultList	getSearchResults(int from, int to, com.sapportals.wcm.service.resourcelistfilter.IResourceListFilter resourceListFilter, com.sapportals.wcm.repository.service.layout.customizing.IParameters filterParameters) List of search results from position a to b in the result list.
int	getTotalNumberResultKeys() Gets the total number of document keys that can be returned.
void	setRenderParameters(java.util.Map renderParameters) Sets the rendring parameters defined in search for the session.

Method Detail

getSearchResults

public ISearchResultList getSearchResults(int from,
                                          int to)
                                   throws WcmException

List of search results from position a to b in the result list.
If the result range once has been requested the next time the search results are returned from an internal cache.

Parameters:

from - position of first returned document in the result list

to - position of last returned document in the result list

Returns:

search result list

getSearchResults

public ISearchResultList getSearchResults(int from,
                                          int to,
                                          com.sapportals.wcm.service.resourcelistfilter.IResourceListFilter resourceListFilter,
                                          com.sapportals.wcm.repository.service.layout.customizing.IParameters filterParameters)
                                   throws WcmException

List of search results from position a to b in the result list.
If the result range once has been requested the next time the search results are returned from an internal cache.

Parameters:

from - position of first returned document in the result list

to - position of last returned document in the result list

resourceListFilter - filters the search results before they are returned

filterParameters - parameters for the resource list filter

Returns:

search result list

getResourceContext

public IResourceContext getResourceContext()

Context of the user that performed the search.

Returns:

the user context for this session

getNumberResultKeys

public int getNumberResultKeys()

Gets the number of document keys that have been found so far.

Returns:

number of found document keys

getTotalNumberResultKeys

public int getTotalNumberResultKeys()

Gets the total number of document keys that can be returned. IRawSearchSession.setTotalNumberResultKeys must be used to get a value here.

Returns:

total number of document keys

getQueryEntryList

public IQueryEntryList getQueryEntryList()

Returns the query list of the session.

Returns:

the query list

getRenderParameters

public java.util.Map getRenderParameters()

Returns the rendring parameters defined in search for the session.

Returns:

the rendering parameter map

setRenderParameters

public void setRenderParameters(java.util.Map renderParameters)

Sets the rendring parameters defined in search for the session.

Returns:

the rendering parameter map