net.sf.mmm.search.view.api

Interface SearchViewContext

All Known Implementing Classes:

SearchViewContextBean

public interface SearchViewContext

This is the major interface to access all relevant attributes and components for the view (user-interface) of the search.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY The key used to associate and get this object.

Method Summary

Modifier and Type	Method and Description
SearchEntry	getEntry() This method gets the single SearchEntry for viewing details.
NlsRuntimeException	getException() This method gets the Exception that potentially occurred.
SearchViewLogic	getLogic() This method gets the SearchViewLogic.
SearchViewRequestParameters	getRequestParameters() This method gets the SearchViewRequestParameters.
SearchResultPage	getResultPage() This method gets the SearchResultPage.
SearchViewConfiguration	getViewConfiguration() This method gets the SearchViewConfiguration.

Field Detail

KEY

static final String KEY

The key used to associate and get this object.

Method Detail

getRequestParameters

SearchViewRequestParameters getRequestParameters()

This method gets the SearchViewRequestParameters.

Returns:

the SearchViewRequestParameters.

getViewConfiguration

SearchViewConfiguration getViewConfiguration()

This method gets the SearchViewConfiguration.

Returns:

the SearchViewConfiguration.

getLogic

SearchViewLogic getLogic()

This method gets the SearchViewLogic.

Returns:

the SearchViewLogic.

getException

NlsRuntimeException getException()

This method gets the Exception that potentially occurred.

Returns:

the Exception or null in case of success.

getResultPage

SearchResultPage getResultPage()

This method gets the SearchResultPage.

Returns:

the SearchResultPage or null if no search has been performed.

getEntry

SearchEntry getEntry()

This method gets the single SearchEntry for viewing details.

Returns:

the SearchEntry or null if no details shall be displayed.

See Also:

SearchViewConfiguration.getDetailsPath()