net.sf.mmm.search.view.base

Class SearchViewContextBean

java.lang.Object

net.sf.mmm.search.view.base.SearchViewContextBean

All Implemented Interfaces:

SearchViewContext

public class SearchViewContextBean
extends Object
implements SearchViewContext

This class contains represents the context of a search-request.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private SearchEntry	entry
private NlsRuntimeException	exception
private SearchViewLogic	logic
private SearchViewRequestParameters	requestParameters
private SearchResultPage	resultPage
private SearchViewConfiguration	viewConfiguration

Fields inherited from interface net.sf.mmm.search.view.api.SearchViewContext

KEY

Constructor Summary

Constructors

Constructor and Description
SearchViewContextBean(javax.servlet.ServletRequest request, SearchViewLogic logic, SearchViewConfiguration viewConfiguration) The constructor.

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.
void	setEntry(SearchEntry newEntry)
void	setException(NlsRuntimeException newException)
void	setResultPage(SearchResultPage newResultPage)

Methods inherited from class java.lang.Object

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

Field Detail

requestParameters

private final SearchViewRequestParameters requestParameters

See Also:

getRequestParameters()

logic

private final SearchViewLogic logic

See Also:

getLogic()

resultPage

private SearchResultPage resultPage

See Also:

getResultPage()

entry

private SearchEntry entry

See Also:

getResultPage()

exception

private NlsRuntimeException exception

See Also:

getException()

viewConfiguration

private SearchViewConfiguration viewConfiguration

See Also:

getViewConfiguration()

Constructor Detail

SearchViewContextBean

public SearchViewContextBean(javax.servlet.ServletRequest request,
                             SearchViewLogic logic,
                             SearchViewConfiguration viewConfiguration)

The constructor.
It will fill all parameters except for result-page and exception.
ATTENTION: This constructor will automatically set itself (this) as attribute of the given request.

Parameters:

request - is the servlet request.

logic - is the SearchViewLogic.

viewConfiguration - is the SearchViewConfiguration.

Method Detail

getRequestParameters

public SearchViewRequestParameters getRequestParameters()

This method gets the SearchViewRequestParameters.

Specified by:

getRequestParameters in interface SearchViewContext

Returns:

the SearchViewRequestParameters.

getLogic

public SearchViewLogic getLogic()

This method gets the SearchViewLogic.

Specified by:

getLogic in interface SearchViewContext

Returns:

the SearchViewLogic.

getViewConfiguration

public SearchViewConfiguration getViewConfiguration()

This method gets the SearchViewConfiguration.

Specified by:

getViewConfiguration in interface SearchViewContext

Returns:

the SearchViewConfiguration.

getResultPage

public SearchResultPage getResultPage()

This method gets the SearchResultPage.

Specified by:

getResultPage in interface SearchViewContext

Returns:

the SearchResultPage or null if no search has been performed.

setResultPage

public void setResultPage(SearchResultPage newResultPage)

Parameters:

newResultPage - the resultPage to set

getEntry

public SearchEntry getEntry()

This method gets the single SearchEntry for viewing details.

Specified by:

getEntry in interface SearchViewContext

Returns:

the SearchEntry or null if no details shall be displayed.

See Also:

SearchViewConfiguration.getDetailsPath()

setEntry

public void setEntry(SearchEntry newEntry)

Parameters:

newEntry - the entry to set

getException

public NlsRuntimeException getException()

This method gets the Exception that potentially occurred.

Specified by:

getException in interface SearchViewContext

Returns:

the Exception or null in case of success.

setException

public void setException(NlsRuntimeException newException)

Parameters:

newException - the exception to set