Package org.opencms.jsp.search.config
Class CmsSearchConfigurationSorting
java.lang.Object
org.opencms.jsp.search.config.CmsSearchConfigurationSorting
- All Implemented Interfaces:
I_CmsSearchConfigurationSorting
public class CmsSearchConfigurationSorting
extends Object
implements I_CmsSearchConfigurationSorting
Configuration for sorting in general.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Default request parameter holding the selected sort option. -
Constructor Summary
ConstructorsConstructorDescriptionCmsSearchConfigurationSorting
(String sortParam, List<I_CmsSearchConfigurationSortOption> options, I_CmsSearchConfigurationSortOption defaultOption) Constructor setting all options. -
Method Summary
Modifier and TypeMethodDescriptioncreate
(String sortParam, List<I_CmsSearchConfigurationSortOption> options, I_CmsSearchConfigurationSortOption defaultOption) Creates a sort configuration iff at least one of the parameters is not null and the options list is not empty.Returns the sort configuration that is used as default.Returns the configurations of all available sort options.Returns the request parameter that should be used to send the currently chosen sort option.
-
Field Details
-
DEFAULT_SORT_PARAM
Default request parameter holding the selected sort option.- See Also:
-
-
Constructor Details
-
CmsSearchConfigurationSorting
public CmsSearchConfigurationSorting(String sortParam, List<I_CmsSearchConfigurationSortOption> options, I_CmsSearchConfigurationSortOption defaultOption) Constructor setting all options.- Parameters:
sortParam
- The request parameter used to send the currently chosen search option.options
- The available sort options.defaultOption
- The default sort option.
-
-
Method Details
-
create
public static CmsSearchConfigurationSorting create(String sortParam, List<I_CmsSearchConfigurationSortOption> options, I_CmsSearchConfigurationSortOption defaultOption) Creates a sort configuration iff at least one of the parameters is not null and the options list is not empty.- Parameters:
sortParam
- The request parameter used to send the currently chosen search option.options
- The available sort options.defaultOption
- The default sort option.- Returns:
- the sort configuration or null, depending on the arguments.
-
getDefaultSortOption
Description copied from interface:I_CmsSearchConfigurationSorting
Returns the sort configuration that is used as default.- Specified by:
getDefaultSortOption
in interfaceI_CmsSearchConfigurationSorting
- Returns:
- The sort configuration that is used as default.
- See Also:
-
getSortOptions
Description copied from interface:I_CmsSearchConfigurationSorting
Returns the configurations of all available sort options.- Specified by:
getSortOptions
in interfaceI_CmsSearchConfigurationSorting
- Returns:
- The configurations of all available sort options.
- See Also:
-
getSortParam
Description copied from interface:I_CmsSearchConfigurationSorting
Returns the request parameter that should be used to send the currently chosen sort option.- Specified by:
getSortParam
in interfaceI_CmsSearchConfigurationSorting
- Returns:
- The request parameter that should be used to send the currently chosen sort option.
- See Also:
-