Enum 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>
,java.lang.constant.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 ConstantsEnum ConstantDescriptionSort by date ascending.Sort by date descending.Sort by order ascending.Sort by order descending.Sort by title ascending.Sort by title descending. -
Method Summary
Modifier and TypeMethodDescriptionGenerates the suitableI_CmsSearchConfigurationSortOption
for the option.protected String
Returns the locale specific date field to use for sorting.protected String
Returns the locale specific order field to use for sorting.protected String
Returns the locale specific title field to use for sorting.Returns the enum constant of this type with the specified name.values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
DATE_ASC
Sort by date ascending. -
DATE_DESC
Sort by date descending. -
TITLE_ASC
Sort by title ascending. -
TITLE_DESC
Sort by title descending. -
ORDER_ASC
Sort by order ascending. -
ORDER_DESC
Sort by order descending.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
getOption
Generates the suitableI_CmsSearchConfigurationSortOption
for the option.- Parameters:
l
- the locale for which the option should be created- Returns:
- the created
I_CmsSearchConfigurationSortOption
-
getSortDateField
Returns the locale specific date field to use for sorting.- Parameters:
l
- the locale to use, can benull
- Returns:
- the locale specific date field to use for sorting.
-
getSortOrderField
Returns the locale specific order field to use for sorting.- Parameters:
l
- the locale to use, can benull
- Returns:
- the locale specific order field to use for sorting.
-
getSortTitleField
Returns the locale specific title field to use for sorting.- Parameters:
l
- the locale to use, can benull
- Returns:
- the locale specific title field to use for sorting.
-