Package org.opencms.jsp.search.config.parser

Enum Class CmsSimpleSearchConfigurationParser.SortOption

java.lang.Object

java.lang.Enum<CmsSimpleSearchConfigurationParser.SortOption>

org.opencms.jsp.search.config.parser.CmsSimpleSearchConfigurationParser.SortOption

All Implemented Interfaces:

Serializable, Comparable<CmsSimpleSearchConfigurationParser.SortOption>, Constable

Enclosing class:

CmsSimpleSearchConfigurationParser

public static enum CmsSimpleSearchConfigurationParser.SortOption
extends Enum<CmsSimpleSearchConfigurationParser.SortOption>

Sort options that are available by default.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATE_ASC	Sort by date ascending.
DATE_DESC	Sort by date descending.
ORDER_ASC	Sort by order ascending.
ORDER_DESC	Sort by order descending.
TITLE_ASC	Sort by title ascending.
TITLE_DESC	Sort by title descending.

Method Summary

Modifier and Type	Method	Description
I_CmsSearchConfigurationSortOption	getOption(Locale l)	Generates the suitable I_CmsSearchConfigurationSortOption for the option.
protected String	getSortDateField(Locale l)	Returns the locale specific date field to use for sorting.
protected String	getSortOrderField(Locale l)	Returns the locale specific order field to use for sorting.
protected String	getSortTitleField(Locale l)	Returns the locale specific title field to use for sorting.
static CmsSimpleSearchConfigurationParser.SortOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CmsSimpleSearchConfigurationParser.SortOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DATE_ASC

public static final CmsSimpleSearchConfigurationParser.SortOption DATE_ASC

Sort by date ascending.

DATE_DESC

public static final CmsSimpleSearchConfigurationParser.SortOption DATE_DESC

Sort by date descending.

TITLE_ASC

public static final CmsSimpleSearchConfigurationParser.SortOption TITLE_ASC

Sort by title ascending.

TITLE_DESC

public static final CmsSimpleSearchConfigurationParser.SortOption TITLE_DESC

Sort by title descending.

ORDER_ASC

public static final CmsSimpleSearchConfigurationParser.SortOption ORDER_ASC

Sort by order ascending.

ORDER_DESC

public static final CmsSimpleSearchConfigurationParser.SortOption ORDER_DESC

Sort by order descending.

Method Details

values

public static CmsSimpleSearchConfigurationParser.SortOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CmsSimpleSearchConfigurationParser.SortOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getOption

public I_CmsSearchConfigurationSortOption getOption(Locale l)

Generates the suitable I_CmsSearchConfigurationSortOption for the option.

Parameters:

l - the locale for which the option should be created

Returns:

the created I_CmsSearchConfigurationSortOption

getSortDateField

protected String getSortDateField(Locale l)

Returns the locale specific date field to use for sorting.

Parameters:

l - the locale to use, can be null

Returns:

the locale specific date field to use for sorting.

getSortOrderField

protected String getSortOrderField(Locale l)

Returns the locale specific order field to use for sorting.

Parameters:

l - the locale to use, can be null

Returns:

the locale specific order field to use for sorting.

getSortTitleField

protected String getSortTitleField(Locale l)

Returns the locale specific title field to use for sorting.

Parameters:

l - the locale to use, can be null

Returns:

the locale specific title field to use for sorting.