I_CmsSearchConfigurationSorting (OpenCms Core API, version 18.0)

All Known Implementing Classes:: CmsSearchConfigurationSorting

public interface I_CmsSearchConfigurationSorting

The interface a sort configuration must implement.

Method Summary

Modifier and Type

Method

Description

I_CmsSearchConfigurationSortOption

getDefaultSortOption()

Returns the sort configuration that is used as default.

List<I_CmsSearchConfigurationSortOption>

getSortOptions()

Returns the configurations of all available sort options.

String

getSortParam()

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

Method Details
- getDefaultSortOption
  
  I_CmsSearchConfigurationSortOption getDefaultSortOption()
  
  Returns the sort configuration that is used as default.
  
  Returns:
  
  The sort configuration that is used as default.
- getSortOptions
  
  List<I_CmsSearchConfigurationSortOption> getSortOptions()
  
  Returns the configurations of all available sort options.
  
  Returns:
  
  The configurations of all available sort options.
- getSortParam
  
  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.