org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationSorting

All Known Implementing Classes:

CmsSearchConfigurationSorting

public interface I_CmsSearchConfigurationSorting

The interface a sort configuration must implement.

Method Summary

Modifier and Type	Method and Description
I_CmsSearchConfigurationSortOption	getDefaultSortOption() Returns the sort configuration that is used as default.
java.util.List<I_CmsSearchConfigurationSortOption>	getSortOptions() Returns the configurations of all available sort options.
java.lang.String	getSortParam() Returns the request parameter that should be used to send the currently chosen sort option.

Method Detail

getDefaultSortOption

I_CmsSearchConfigurationSortOption getDefaultSortOption()

Returns the sort configuration that is used as default.

Returns:

The sort configuration that is used as default.

getSortOptions

java.util.List<I_CmsSearchConfigurationSortOption> getSortOptions()

Returns the configurations of all available sort options.

Returns:

The configurations of all available sort options.

getSortParam

java.lang.String getSortParam()

Returns the request parameter that should be used to send the currently chosen sort option.

Returns:

The request parameter that should be used to send the currently chosen sort option.