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 java.lang.Object
implements I_CmsSearchConfigurationSorting

Configuration for sorting in general.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_SORT_PARAM	Default request parameter holding the selected sort option.

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationSorting(java.lang.String sortParam, java.util.List<I_CmsSearchConfigurationSortOption> options, I_CmsSearchConfigurationSortOption defaultOption)	Constructor setting all options.

Method Summary

Modifier and Type	Method	Description
static CmsSearchConfigurationSorting	create(java.lang.String sortParam, java.util.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.
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.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SORT_PARAM

public static final java.lang.String DEFAULT_SORT_PARAM

Default request parameter holding the selected sort option.

See Also:

Constant Field Values

Constructor Detail

CmsSearchConfigurationSorting

public CmsSearchConfigurationSorting(java.lang.String sortParam,
                                     java.util.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 Detail

create

public static CmsSearchConfigurationSorting create(java.lang.String sortParam,
                                                   java.util.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

public I_CmsSearchConfigurationSortOption getDefaultSortOption()

Description copied from interface: I_CmsSearchConfigurationSorting

Returns the sort configuration that is used as default.

Specified by:

getDefaultSortOption in interface I_CmsSearchConfigurationSorting

Returns:

The sort configuration that is used as default.

See Also:

I_CmsSearchConfigurationSorting.getDefaultSortOption()

getSortOptions

public java.util.List<I_CmsSearchConfigurationSortOption> getSortOptions()

Description copied from interface: I_CmsSearchConfigurationSorting

Returns the configurations of all available sort options.

Specified by:

getSortOptions in interface I_CmsSearchConfigurationSorting

Returns:

The configurations of all available sort options.

See Also:

I_CmsSearchConfigurationSorting.getSortOptions()

getSortParam

public java.lang.String 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 interface I_CmsSearchConfigurationSorting

Returns:

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

See Also:

I_CmsSearchConfigurationSorting.getSortParam()