@PublicSpi @PublicApi public class

UserPickerSearcher

extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher SortableCustomFieldSearcher CustomFieldStattable
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
     ↳ com.atlassian.jira.issue.customfields.searchers.UserPickerSearcher

@PublicSpi

This class is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

@PublicApi

This class 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).

Summary

[Expand]
Inherited Fields
From interface com.atlassian.jira.issue.search.searchers.IssueSearcher
Public Constructors
@Deprecated UserPickerSearcher(UserResolver userResolver, JqlOperandResolver operandResolver, JiraAuthenticationContext context, UserConverter userConverter, UserSearchService userSearchService, CustomFieldInputHelper customFieldInputHelper, UserManager userManager, FieldVisibilityManager fieldVisibilityManager)
This constructor is deprecated. since 6.4.9
UserPickerSearcher(UserResolver userResolver, JqlOperandResolver operandResolver, JiraAuthenticationContext context, UserConverter userConverter, UserSearchService userSearchService, CustomFieldInputHelper customFieldInputHelper, UserManager userManager, FieldVisibilityManager fieldVisibilityManager, EmailFormatter emailFormatter)
Public Methods
CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()
Provides an object that can be used to handle the clauses that this searcher generates.
SearcherInformation<CustomField> getSearchInformation()
Provides an object that contains information about the Searcher.
SearchInputTransformer getSearchInputTransformer()
Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.
SearchRenderer getSearchRenderer()
Provides an object that will allow you to render the edit and view html for a searcher.
LuceneFieldSorter getSorter(CustomField customField)
StatisticsMapper getStatisticsMapper(CustomField customField)
void init(CustomField field)
This is the first time the searcher knows what its ID and names are
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
From class java.lang.Object
From interface com.atlassian.jira.issue.customfields.CustomFieldSearcher
From interface com.atlassian.jira.issue.customfields.SortableCustomFieldSearcher
From interface com.atlassian.jira.issue.customfields.statistics.CustomFieldStattable
From interface com.atlassian.jira.issue.search.searchers.IssueSearcher

Public Constructors

@Deprecated public UserPickerSearcher (UserResolver userResolver, JqlOperandResolver operandResolver, JiraAuthenticationContext context, UserConverter userConverter, UserSearchService userSearchService, CustomFieldInputHelper customFieldInputHelper, UserManager userManager, FieldVisibilityManager fieldVisibilityManager)

This constructor is deprecated.
since 6.4.9

public UserPickerSearcher (UserResolver userResolver, JqlOperandResolver operandResolver, JiraAuthenticationContext context, UserConverter userConverter, UserSearchService userSearchService, CustomFieldInputHelper customFieldInputHelper, UserManager userManager, FieldVisibilityManager fieldVisibilityManager, EmailFormatter emailFormatter)

Public Methods

public CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler ()

Provides an object that can be used to handle the clauses that this searcher generates.

Returns
  • an object that can be used to handle the clauses that this searcher generates, can be null.

public SearcherInformation<CustomField> getSearchInformation ()

Provides an object that contains information about the Searcher.

Returns
  • the search information provider for this searcher.

public SearchInputTransformer getSearchInputTransformer ()

Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.

Returns
  • the search input handler for this searcher.

public SearchRenderer getSearchRenderer ()

Provides an object that will allow you to render the edit and view html for a searcher. This also provides methods that indicate if the view and edit methods should be invoked.

Returns
  • the search renderer for this searcher.

public LuceneFieldSorter getSorter (CustomField customField)

public StatisticsMapper getStatisticsMapper (CustomField customField)

public void init (CustomField field)

This is the first time the searcher knows what its ID and names are

Parameters
field the Custom Field for this searcher