net.sf.mmm.search.view.api

Interface SearchViewConfiguration

All Known Implementing Classes:

AbstractSearchServlet, GenericSearchServlet

public interface SearchViewConfiguration

This interface contains the servlet-specific configuration of the view.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BUNDLE_NAME The default for getBundleName().
static String	DEFAULT_DETAILS_PATH The default for getDetailsPath().
static String	DEFAULT_SEARCH_PATH The default for getSearchPath().
static String	PARAMETER_BUNDLE_NAME The name of the servlet-parameter for the bundle-name.
static String	PARAMETER_CONFIGURATION_URL The name of the servlet-parameter for the configuration-URL.
static String	PARAMETER_DETAILS_PATH The name of the servlet-parameter for the details-path.
static String	PARAMETER_ERROR_PATH The name of the servlet-parameter for the error-path.
static String	PARAMETER_SEARCH_PATH The name of the servlet-parameter for the search-path.

Method Summary

Modifier and Type	Method and Description
String	getBundleName() This method gets the qualified name of the ResourceBundle used if texts for the UI from the configuration are specified in the from {<KEY>}.
String	getDetailsPath() The servlet-path for the view of the details of a particular SearchHit.
String	getErrorPath() This method get the name of the path to dispatch to in case of an error (e.g.
String	getSearchPath() The servlet-path for the view of the actual search (enter query and show results).

Field Detail

PARAMETER_CONFIGURATION_URL

static final String PARAMETER_CONFIGURATION_URL

The name of the servlet-parameter for the configuration-URL.

See Also:

Constant Field Values

PARAMETER_SEARCH_PATH

static final String PARAMETER_SEARCH_PATH

The name of the servlet-parameter for the search-path.

See Also:

Constant Field Values

DEFAULT_SEARCH_PATH

static final String DEFAULT_SEARCH_PATH

The default for getSearchPath().

See Also:

Constant Field Values

PARAMETER_DETAILS_PATH

static final String PARAMETER_DETAILS_PATH

The name of the servlet-parameter for the details-path.

See Also:

Constant Field Values

DEFAULT_DETAILS_PATH

static final String DEFAULT_DETAILS_PATH

The default for getDetailsPath().

See Also:

Constant Field Values

PARAMETER_ERROR_PATH

static final String PARAMETER_ERROR_PATH

The name of the servlet-parameter for the error-path.

See Also:

Constant Field Values

PARAMETER_BUNDLE_NAME

static final String PARAMETER_BUNDLE_NAME

The name of the servlet-parameter for the bundle-name.

See Also:

Constant Field Values

DEFAULT_BUNDLE_NAME

static final String DEFAULT_BUNDLE_NAME

The default for getBundleName().

See Also:

Constant Field Values

Method Detail

getSearchPath

String getSearchPath()

The servlet-path for the view of the actual search (enter query and show results).

Returns:

the search path.

See Also:

DEFAULT_SEARCH_PATH

getDetailsPath

String getDetailsPath()

The servlet-path for the view of the details of a particular SearchHit.

Returns:

the search path.

See Also:

DEFAULT_DETAILS_PATH

getErrorPath

String getErrorPath()

This method get the name of the path to dispatch to in case of an error (e.g. "error.jsp") or null to dispatch to the current view even in case of an error.

Returns:

the error view.

getBundleName

String getBundleName()

This method gets the qualified name of the ResourceBundle used if texts for the UI from the configuration are specified in the from {<KEY>}.

Returns:

the bundle-name.

See Also:

NlsTemplateImpl.getName()