Package com.atlassian.jira.issue.customfields

Interface SortableCustomFieldSearcher

All Superinterfaces:

FieldSortsCustomFieldSearcher, ValueLoaderCustomFieldSearcher

All Known Subinterfaces:

CustomFieldSortable

All Known Implementing Classes:

CustomFieldLabelsSearcher, DateRangeSearcher, DateTimeRangeSearcher, ExactNumberSearcher, GroupPickerSearcher, MultiSelectSearcher, NumberRangeSearcher, ProjectSearcher, SelectSearcher, UserPickerGroupSearcher, UserPickerSearcher, VersionPickerSearcher

@PublicSpi
@Deprecated(since="10.4",
            forRemoval=true)
public interface SortableCustomFieldSearcher
extends FieldSortsCustomFieldSearcher, ValueLoaderCustomFieldSearcher

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4, to be removed in Jira 11. Use FieldSortsCustomFieldSearcher and/or ValueLoaderCustomFieldSearcher instead.

A custom field searcher will implement this interface if the custom field can be sorted. If a custom field wishes to sort itself, it can use the slower method SortableCustomField.

See Also:

• SortableCustomField
• MultiSortableCustomFieldSearcher
• NaturallyOrderedCustomFieldSearcher

Method Summary

Modifier and Type	Method	Description
default List<FieldSort>	getFieldSorts(CustomField customField, FieldSort.Order order)	Deprecated, for removal: This API element is subject to removal in a future version. Get the index field sorts for the provided custom field
LuceneFieldSorter	getSorter(CustomField customField)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.4, use getValueLoader(CustomField) or getFieldSorts(CustomField, FieldSort.Order) instead
default FieldValueLoader<?>	getValueLoader(CustomField customField)	Deprecated, for removal: This API element is subject to removal in a future version. Gets the value loader for the provided custom field.

Method Details

getSorter

@Nonnull
@Deprecated(since="10.4",
            forRemoval=true)
LuceneFieldSorter getSorter(CustomField customField)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4, use getValueLoader(CustomField) or getFieldSorts(CustomField, FieldSort.Order) instead

Returns a LuceneFieldSorter that can be used to sort the values of the custom field.

Parameters:

customField - the custom field to be sorted

Returns:

a LuceneFieldSorter that can be used to load or sort the values of the custom field

getValueLoader

default FieldValueLoader<?> getValueLoader(CustomField customField)

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the value loader for the provided custom field. Replaces getSorter(CustomField).

Replaces getSorter(CustomField).

Specified by:

getValueLoader in interface ValueLoaderCustomFieldSearcher

Returns:

the value loader for the provided custom field

getFieldSorts

default List<FieldSort> getFieldSorts(CustomField customField,
 FieldSort.Order order)

Deprecated, for removal: This API element is subject to removal in a future version.

Get the index field sorts for the provided custom field

Replaces getSorter(CustomField).

Specified by:

getFieldSorts in interface FieldSortsCustomFieldSearcher

Returns:

the index field sorts for the provided custom field