Package org.opencms.jsp.search.config

Class CmsSearchConfigurationSortOption

java.lang.Object

org.opencms.jsp.search.config.CmsSearchConfigurationSortOption

All Implemented Interfaces:

I_CmsSearchConfigurationSortOption

public class CmsSearchConfigurationSortOption
extends java.lang.Object
implements I_CmsSearchConfigurationSortOption

Configuration for a single sort option.

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationSortOption(java.lang.String label, java.lang.String paramValue, java.lang.String solrValue)	Constructor setting all options.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getLabel()	Returns the label that can be used to display the sort option in the form.
java.lang.String	getParamValue()	Returns the request parameter's value that has to be send to choose that sort option.
java.lang.String	getSolrValue()	Returns the sort value as send to Solr.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchConfigurationSortOption

public CmsSearchConfigurationSortOption(java.lang.String label,
                                        java.lang.String paramValue,
                                        java.lang.String solrValue)

Constructor setting all options.

Parameters:

label - The label shown when the sort option is displayed.

paramValue - The value send in the request that identifies the option.

solrValue - The sort option as given to Solr.

Method Detail

getLabel

public java.lang.String getLabel()

Description copied from interface: I_CmsSearchConfigurationSortOption

Returns the label that can be used to display the sort option in the form.

Specified by:

getLabel in interface I_CmsSearchConfigurationSortOption

Returns:

The label that can be used to display the sort option in the form.

See Also:

I_CmsSearchConfigurationSortOption.getLabel()

getParamValue

public java.lang.String getParamValue()

Description copied from interface: I_CmsSearchConfigurationSortOption

Returns the request parameter's value that has to be send to choose that sort option.

Specified by:

getParamValue in interface I_CmsSearchConfigurationSortOption

Returns:

The request parameter's value that has to be send to choose that sort option.

See Also:

I_CmsSearchConfigurationSortOption.getParamValue()

getSolrValue

public java.lang.String getSolrValue()

Description copied from interface: I_CmsSearchConfigurationSortOption

Returns the sort value as send to Solr.

Specified by:

getSolrValue in interface I_CmsSearchConfigurationSortOption

Returns:

The sort value as send to Solr.

See Also:

I_CmsSearchConfigurationSortOption.getSolrValue()