com.atlassian.jira.mention

Class SortedMentionableUserSearcher

java.lang.Object

com.atlassian.jira.mention.SortedMentionableUserSearcher

All Implemented Interfaces:

MentionableUserSearcher

public class SortedMentionableUserSearcher
extends Object
implements MentionableUserSearcher

Constructor Summary

Constructors

Constructor and Description
SortedMentionableUserSearcher(I18nHelper i18n, GlobalPermissionManager globalPermissionManager, CommentService commentService, WatcherService watcherService, VoteService voteService, UserSearchService userSearchService, DCFeatureLicenseChecker licenseChecker)

Method Summary

Modifier and Type	Method and Description
List<UserIssueRelevance>	findRelatedUsersToMention(String query, Issue issue, ApplicationUser requestingUser, int maxResults) Calculates a list of users that are relevant to the issue so that they can be mentioned
List<UserIssueRelevance>	findRelatedUsersToMention(String query, Issue issue, ApplicationUser requestingUser, int maxResults, java.util.function.Supplier<List<ApplicationUser>> userSupplier) Calculates a list of users that are relevant to the issue so that they can be mentioned

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SortedMentionableUserSearcher

public SortedMentionableUserSearcher(I18nHelper i18n,
                                     GlobalPermissionManager globalPermissionManager,
                                     CommentService commentService,
                                     WatcherService watcherService,
                                     VoteService voteService,
                                     UserSearchService userSearchService,
                                     DCFeatureLicenseChecker licenseChecker)

Method Detail

findRelatedUsersToMention

public List<UserIssueRelevance> findRelatedUsersToMention(String query,
                                                          Issue issue,
                                                          ApplicationUser requestingUser,
                                                          int maxResults)

Description copied from interface: MentionableUserSearcher

Calculates a list of users that are relevant to the issue so that they can be mentioned

Specified by:

findRelatedUsersToMention in interface MentionableUserSearcher

Parameters:

query - the filter string to match the user, or role, against

issue - the issue we are looking for users to mention on (to determine relevance)

requestingUser - what user is making the request, for authorisation

maxResults - the maximum number of results that will be returned. We assume it has been validated before reaching here.

Returns:

A list of users, ordered by relevance to the issue.

findRelatedUsersToMention

public List<UserIssueRelevance> findRelatedUsersToMention(@Nonnull
                                                          String query,
                                                          Issue issue,
                                                          ApplicationUser requestingUser,
                                                          int maxResults,
                                                          java.util.function.Supplier<List<ApplicationUser>> userSupplier)

Description copied from interface: MentionableUserSearcher

Calculates a list of users that are relevant to the issue so that they can be mentioned

Specified by:

findRelatedUsersToMention in interface MentionableUserSearcher

Parameters:

query - the filter string to match the user, or role, against

issue - the issue we are looking for users to mention on (to determine relevance)

requestingUser - what user is making the request, for authorisation

maxResults - the maximum number of results that will be returned. We assume it has been validated before reaching here.

userSupplier - the supplier providing additional users if there will be not enough relevant ones

Returns:

A list of users, ordered by relevance to the issue.