| Package | Description |
|---|---|
| org.opencms.jsp.search.config |
API classes for the configuration of the search form support provided for server-side Solr search.
|
| org.opencms.jsp.search.config.parser |
API classes for the configuration parsers of the search form support provided for server-side Solr search.
|
| org.opencms.jsp.search.state |
API classes for the state of the search form support provided for server-side Solr search.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsSearchConfigurationSortOption
Configuration for a single sort option.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsSearchConfigurationSortOption |
I_CmsSearchConfigurationSorting.getDefaultSortOption()
Returns the sort configuration that is used as default.
|
I_CmsSearchConfigurationSortOption |
CmsSearchConfigurationSorting.getDefaultSortOption() |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsSearchConfigurationSortOption> |
I_CmsSearchConfigurationSorting.getSortOptions()
Returns the configurations of all available sort options.
|
java.util.List<I_CmsSearchConfigurationSortOption> |
CmsSearchConfigurationSorting.getSortOptions() |
| Modifier and Type | Method and Description |
|---|---|
static CmsSearchConfigurationSorting |
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.
|
| Modifier and Type | Method and Description |
|---|---|
static CmsSearchConfigurationSorting |
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.
|
| Constructor and Description |
|---|
CmsSearchConfigurationSorting(java.lang.String sortParam,
java.util.List<I_CmsSearchConfigurationSortOption> options,
I_CmsSearchConfigurationSortOption defaultOption)
Constructor setting all options.
|
| Constructor and Description |
|---|
CmsSearchConfigurationSorting(java.lang.String sortParam,
java.util.List<I_CmsSearchConfigurationSortOption> options,
I_CmsSearchConfigurationSortOption defaultOption)
Constructor setting all options.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsSearchConfigurationSortOption |
CmsSimpleSearchConfigurationParser.SortOption.getOption(java.util.Locale l)
Generates the suitable
I_CmsSearchConfigurationSortOption for the option. |
protected I_CmsSearchConfigurationSortOption |
CmsJSONSearchConfigurationParser.parseSortOption(JSONObject json)
Returns a single sort option configuration as configured via the methods parameter, or null if the parameter does not specify a sort option.
|
| Modifier and Type | Method and Description |
|---|---|
protected java.util.List<I_CmsSearchConfigurationSortOption> |
CmsSimpleSearchConfigurationParser.getSortOptions() |
protected java.util.List<I_CmsSearchConfigurationSortOption> |
CmsJSONSearchConfigurationParser.getSortOptions()
Returns the list of the configured sort options, or the empty list if no sort options are configured.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsSearchConfigurationSortOption |
I_CmsSearchStateSorting.getSelected()
Returns the selected search option.
|
I_CmsSearchConfigurationSortOption |
CmsSearchStateSorting.getSelected() |
| Modifier and Type | Method and Description |
|---|---|
java.util.Map<I_CmsSearchConfigurationSortOption,java.lang.Boolean> |
I_CmsSearchStateSorting.getCheckSelected()
Returns a map from search options to their check state.
|
java.util.Map<I_CmsSearchConfigurationSortOption,java.lang.Boolean> |
CmsSearchStateSorting.getCheckSelected() |
| Modifier and Type | Method and Description |
|---|---|
void |
I_CmsSearchStateSorting.setSelectedOption(I_CmsSearchConfigurationSortOption option)
Setter for the selected search option.
|
void |
CmsSearchStateSorting.setSelectedOption(I_CmsSearchConfigurationSortOption option) |