no.sesat.search.mode.config
Interface SearchConfiguration

All Superinterfaces:

Serializable

All Known Subinterfaces:

BaseSearchConfiguration, FacetedCommandConfig, SearchConfiguration.ModesW3cDomDeserialiser

All Known Implementing Classes:

AbstractWebServiceSearchConfiguration, AbstractXmlSearchConfiguration, AbstractYahooSearchConfiguration, AdvancedFastCommandConfig, BlendingNewsCommandConfig, ClusteringEspFastCommandConfig, CommandConfig, CorrectingFast4CommandConfig, EspFastCommandConfig, FastCommandConfig, MathCommandConfig, MobileCommandConfig, NavigatableEspFastCommandConfig, NewsAggregatorCommandConfig, NewsCommandConfig, NewsEspCommandConfig, NewsMyNewsCommandConfig, OverturePpcCommandConfig, PictureCommandConfig, PlatefoodPpcCommandConfig, PropertiesCommandConfig, SensisCommandConfig, SolrCommandConfig, StaticCommandConfig, StockCommandConfig, WebCommandConfig, YahooIdpCommandConfig, YahooMediaCommandConfig, YahooWebCommandConfig, YoutubeCommandConfig

public interface SearchConfiguration
extends Serializable

Version:

$Id: SearchConfiguration.java 7225 2009-04-09 00:32:20Z ssmiweve $

Nested Class Summary

static interface

SearchConfiguration.ModesW3cDomDeserialiser Interface for SearchConfigurations that uses W3cDomDeserialiser.

Field Summary

static String	DEFAULT_PAGING_PARAMETER Default value associated with getPagingParameter()
static String	DEFAULT_USER_SORT_PARAMETER Default value associated with getUserSortParameter()

Method Summary

void	addResultField(String... resultField)
void	clearFieldFilters() Remove all fieldFilters.
Map<String,String>	getFieldFilterMap() Getter for property fieldFilters.
String	getId() Returns the name of this configuration.
String	getName()
String	getPagingParameter() Return the parameter key that any associated ResultPagingNavigationController should use to fetch the offset value.
String	getQueryParameter()
Map<String,String>	getResultFieldMap()
int	getResultsToReturn() Returns the number of results to return.
String	getStatisticalName()
String	getUserSortParameter() Return the parameter key that any associated PagingNavigationController for sorting should use to fetch the offset value.
boolean	isAlwaysRun()
boolean	isAsynchronous() Is the command used asynchronously, for example by ajax calls.
boolean	isRunBlank()

Field Detail

DEFAULT_PAGING_PARAMETER

static final String DEFAULT_PAGING_PARAMETER

Default value associated with getPagingParameter()

See Also:

Constant Field Values

DEFAULT_USER_SORT_PARAMETER

static final String DEFAULT_USER_SORT_PARAMETER

Default value associated with getUserSortParameter()

See Also:

Constant Field Values

Method Detail

addResultField

void addResultField(String... resultField)

Parameters:

resultField -

getFieldFilterMap

Map<String,String> getFieldFilterMap()

Getter for property fieldFilters.

Returns:

Value of property fieldFilters.

clearFieldFilters

void clearFieldFilters()

Remove all fieldFilters.

getId

String getId()

Returns the name of this configuration.

Returns:

the name of the configuration.

getName

String getName()

getQueryParameter

String getQueryParameter()

Returns:

getResultFieldMap

Map<String,String> getResultFieldMap()

Returns:

getResultsToReturn

int getResultsToReturn()

Returns the number of results to return.

Returns:

getStatisticalName

String getStatisticalName()

Returns:

The statistical name.

getPagingParameter

String getPagingParameter()

Return the parameter key that any associated ResultPagingNavigationController should use to fetch the offset value. Defaults to "offset". Typically used when multiple ResultPagingNavigationControllers are to be configured on the one mode.

Returns:

getUserSortParameter

String getUserSortParameter()

Return the parameter key that any associated PagingNavigationController for sorting should use to fetch the offset value. Defaults to "sort". Typically used when multiple sorting PagingNavigationControllers are to be configured on the one mode.

Returns:

the userSortParameter value

isAlwaysRun

boolean isAlwaysRun()

Returns:

true if the command should always run.

isAsynchronous

boolean isAsynchronous()

Is the command used asynchronously, for example by ajax calls.

Returns:

isRunBlank

boolean isRunBlank()

Returns:

true if the command should run when query string is blank.