Package com.atlassian.jira.issue.customfields

Interface NaturallyOrderedCustomFieldSearcher

All Known Implementing Classes:
AbstractDateRangeSearcher, CustomFieldLabelsSearcher, DateRangeSearcher, DateTimeRangeSearcher, ExactNumberSearcher, ExactTextSearcher, NumberRangeSearcher, SlowTextSearcher, TextSearcher
@PublicSpi public interface NaturallyOrderedCustomFieldSearcher
This interface indicates the values stored in the Lucene index for this searcher are naturally ordered and as a result natural sorting can be used allowing for best sort performance.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getSortField(CustomField customField)
    Return the name of the field to use for ordering.

  • Method Details

    • getSortField

      String getSortField(CustomField customField)
      Return the name of the field to use for ordering. This will normally be just the field, .i.e customField.getId() but some searchers, e.g. TextSearcher, store additional fields to support sorting.
      Parameters:
      customField - The custom field to be searched
      Returns:
      The field name to use for ordering.