Summary: Methods | [Expand All]
@PublicApi public interface

IndexedChangeHistoryFieldManager

com.atlassian.jira.issue.index.IndexedChangeHistoryFieldManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

allows you to add and remove fields that will be indexed in the change history index

Summary

Public Methods
void addIndexedChangeHistoryField(IndexedChangeHistoryField field)
void deleteIndexedChangeHistoryField(IndexedChangeHistoryField field)
Collection<String> getIndexedChangeHistoryFieldNames()
Collection<IndexedChangeHistoryField> getIndexedChangeHistoryFields()
Set<Operator> getSupportedOperators(String fieldName, Set<Operator> supportedOperators)

Public Methods

public void addIndexedChangeHistoryField (IndexedChangeHistoryField field)

Parameters
field A IndexedChangeHistoryField that describes a field you want to add to the index

public void deleteIndexedChangeHistoryField (IndexedChangeHistoryField field)

Parameters
field A IndexedChangeHistoryField that describes a field you want to delete from being indesed.

public Collection<String> getIndexedChangeHistoryFieldNames ()

Returns
  • a collection that contains all of the field names that will be indexed.

public Collection<IndexedChangeHistoryField> getIndexedChangeHistoryFields ()

Returns

public Set<Operator> getSupportedOperators (String fieldName, Set<Operator> supportedOperators)