Package com.atlassian.jira.i18n.terminology

Interface TerminologyEntryReader

All Known Implementing Classes:
TerminologyEntryReaderImpl
@ExperimentalApi @ParametersAreNonnullByDefault public interface TerminologyEntryReader
Service that allows getting terminology entries. See TerminologyEntryWriter if you want to set entries.
Since:
v8.14

  • Method Details

    • getTerminologyEntry

      Optional<TerminologyEntry> getTerminologyEntry(String originalName)
      Parameters:
      originalName - of the renamed field. Names that are allowed to be renamed are 'sprint' or 'epic'.
      Returns:
      Optional containing TerminologyEntry, or Optional.empty() if the provided name is not one of allowed names.

    • getAllTerminologyEntries

      Collection<TerminologyEntry> getAllTerminologyEntries()
      Collection of TerminologyEntry active on this instance. For each allowed name the collection contains either an entry created by TerminologyEntryWriter.changeTerminology(com.atlassian.jira.i18n.terminology.TerminologyEntryWriter.TerminologyValidationResult) or a default entry.

      A default entry represents original terminology used in Jira, for example where an original name is 'sprint' and new name is also 'sprint'. It is returned when terminology hasn't been changed.

      Returns:
      Collection of entries. If none entries have been set, a collection of default entries is returned.

    • getHistoricalTerminologyEntries

      Collection<TerminologyEntry> getHistoricalTerminologyEntries(String originalName)
      Collection of all TerminologyEntry that have been applied to the originalName. It includes both active and not active entries. The entries are sorted by a timestamp in descending order.
      Parameters:
      originalName - a name of a renamed field.
      Returns:
      Collection of TerminologyEntry set to the specified original name.