net.sf.mmm.search.view.api

Interface SearchViewRequestParameters

All Known Implementing Classes:

SearchViewRequestParametersBean

public interface SearchViewRequestParameters

This is the interface for accessing request parameters.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_CREATOR
static String	PARAMETER_HITS_PER_PAGE
static String	PARAMETER_ID
static String	PARAMETER_PAGE
static String	PARAMETER_QUERY
static String	PARAMETER_SOURCE
static String	PARAMETER_TITLE
static String	PARAMETER_TOTAL_HIT_COUNT
static String	PARAMETER_TYPE

Method Summary

Modifier and Type	Method and Description
String	getCreator() This method gets the creator from the request parameters.
int	getHitsPerPage() This method gets the number of hits per page from the request parameters.
String	getId() This method gets the ID from the request parameters.
int	getPageNumber() This method gets the page-index from the request parameters.
String	getQuery() This method gets the query from the request parameters.
String	getSource() This method gets the source from the request parameters.
String	getTitle() This method gets the title from the request parameters.
int	getTotalHitCount() This method gets the total number of hits from the request parameters.
String	getType() This method gets the type from the request parameters.

Field Detail

PARAMETER_QUERY

static final String PARAMETER_QUERY

See Also:

getQuery(), Constant Field Values

PARAMETER_PAGE

static final String PARAMETER_PAGE

See Also:

getPageNumber(), Constant Field Values

PARAMETER_HITS_PER_PAGE

static final String PARAMETER_HITS_PER_PAGE

See Also:

getHitsPerPage(), Constant Field Values

PARAMETER_TOTAL_HIT_COUNT

static final String PARAMETER_TOTAL_HIT_COUNT

See Also:

getTotalHitCount(), Constant Field Values

PARAMETER_SOURCE

static final String PARAMETER_SOURCE

See Also:

getSource(), Constant Field Values

PARAMETER_CREATOR

static final String PARAMETER_CREATOR

See Also:

getCreator(), Constant Field Values

PARAMETER_TYPE

static final String PARAMETER_TYPE

See Also:

getType(), Constant Field Values

PARAMETER_TITLE

static final String PARAMETER_TITLE

See Also:

getTitle(), Constant Field Values

PARAMETER_ID

static final String PARAMETER_ID

See Also:

getId(), Constant Field Values

Method Detail

getId

String getId()

This method gets the ID from the request parameters.

Returns:

the id. Will be the empty string if NOT set in request.

getType

String getType()

This method gets the type from the request parameters.

Returns:

the type. Will be the empty string if NOT set in request.

getTitle

String getTitle()

This method gets the title from the request parameters.

Returns:

the title. Will be the empty string if NOT set in request.

getCreator

String getCreator()

This method gets the creator from the request parameters.

Returns:

the creator. Will be the empty string if NOT set in request.

getSource

String getSource()

This method gets the source from the request parameters.

Returns:

the source. Will be the empty string if NOT set in request.

getQuery

String getQuery()

This method gets the query from the request parameters.

Returns:

the query. Will be the empty string if NOT set in request.

getTotalHitCount

int getTotalHitCount()

This method gets the total number of hits from the request parameters.

Returns:

the totalHitCount or -1 if NOT set in request.

getHitsPerPage

int getHitsPerPage()

This method gets the number of hits per page from the request parameters.

Returns:

the hitsPerPage. Will be SearchResultPage.DEFAULT_HITS_PER_PAGE if NOT set in request.

getPageNumber

int getPageNumber()

This method gets the page-index from the request parameters.

Returns:

the pageNumber. Will be 0 if NOT set in request.