public class

DefaultAssigneeService

extends Object
implements AssigneeService
java.lang.Object
   ↳ com.atlassian.jira.bc.user.search.DefaultAssigneeService

Class Overview

The main implementation of AssigneeService.

Summary

Public Constructors
DefaultAssigneeService(PermissionContextFactory permissionContextFactory, PermissionSchemeManager permissionSchemeManager, UserHistoryManager userHistoryManager, FeatureManager featureManager, JiraAuthenticationContext authenticationContext, UserKeyService userKeyService)
Public Methods
Collection<User> findAssignableUsers(String query, Issue issue, ActionDescriptor actionDescriptor)
Get assignable Users based on a query string and issue.
Collection<User> findAssignableUsers(String query, Project project)
Get assignable Users based on a query string and project.
List<User> getAssignableUsers(Collection<Issue> issues, ActionDescriptor actionDescriptor)
Get all Users that may have all of the given Issues assigned to them, for a given workflow state.
List<User> getAssignableUsers(Issue issue, ActionDescriptor actionDescriptor)
Get all Users that may have an Issue assigned to them, for a given workflow state.
Set<String> getRecentAssigneeKeysForIssue(Issue issue)
Gets ids of this issue's recent assignees, including the current assignee.
Set<String> getRecentAssigneeKeysForUser(User remoteUser)
Get users keys that the given user has recently assigned issues to.
Set<String> getRecentAssigneeNamesForIssue(Issue issue)
Gets the names of this issue's recent assignees, including the current assignee.
Set<String> getRecentAssigneeNamesForUser(User remoteUser)
Get users names that the given user has recently assigned issues to.
List<User> getSuggestedAssignees(Issue issue, User loggedInUser, List<User> assignableUsers)
Returns a list of suggested Assignee Users for a given Issue and logged-in User.
List<User> getSuggestedAssignees(Set<String> suggestedAssigneeNames, List<User> assignableUsers)
Given a set of suggested names and an ordered list of assignable users, returns an order list of suggested users.
List<User> getSuggestedAssignees(Issue issue, User loggedInUser, ActionDescriptor actionDescriptor)
Returns a list of suggested Assignee Users for a given Issue and logged-in User.
Map<StringBoolean> makeUniqueFullNamesMap(Collection<User> users)
Converts a collection of Users to a Map where the key is the User full name and the value is true or false.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.bc.user.search.AssigneeService

Public Constructors

public DefaultAssigneeService (PermissionContextFactory permissionContextFactory, PermissionSchemeManager permissionSchemeManager, UserHistoryManager userHistoryManager, FeatureManager featureManager, JiraAuthenticationContext authenticationContext, UserKeyService userKeyService)

Public Methods

public Collection<User> findAssignableUsers (String query, Issue issue, ActionDescriptor actionDescriptor)

Get assignable Users based on a query string and issue.

Matches on the start of username, Each word in Full Name & email.

Results are sorted according to the UserCachingComparator.

Parameters
query String to search for.
issue Issue to check Assignee permissions against
actionDescriptor an com.opensymphony.workflow.loader.ActionDescriptor describing the context in which the Assignee is being searched
Returns
  • List of User objects that match criteria.

public Collection<User> findAssignableUsers (String query, Project project)

Get assignable Users based on a query string and project.

Matches on the start of username, Each word in Full Name & email.

Results are sorted according to the UserCachingComparator.

Parameters
query String to search for.
project Project check Assignee permissions against
Returns
  • List of User objects that match criteria.

public List<User> getAssignableUsers (Collection<Issue> issues, ActionDescriptor actionDescriptor)

Get all Users that may have all of the given Issues assigned to them, for a given workflow state.

The ActionDescriptor may be used to check for workflow states that only allow a subset of normally-assignable users.

Note: This method is exactly equivalent to getAssignableUsers(Issue, ActionDescriptor), but returns only those users that are assignable for all of the issues. This is significantly more efficient than calling getAssignableUsers(Issue, ActionDescriptor) multiple times and filtering the lists yourself.

Parameters
issues the Issues to find assignable users for
actionDescriptor workflow action descriptor to filter users on
Returns
  • a list of Users sorted by name

public List<User> getAssignableUsers (Issue issue, ActionDescriptor actionDescriptor)

Get all Users that may have an Issue assigned to them, for a given workflow state.

The ActionDescriptor may be used to check for workflow states that only allow a subset of normally-assignable users.

Parameters
issue the Issue to find assignable users for
actionDescriptor workflow action descriptor to filter users on
Returns
  • a list of Users sorted by name

public Set<String> getRecentAssigneeKeysForIssue (Issue issue)

Gets ids of this issue's recent assignees, including the current assignee.

Parameters
issue an issue to get the change history of
Returns
  • a set of ids

public Set<String> getRecentAssigneeKeysForUser (User remoteUser)

Get users keys that the given user has recently assigned issues to.

Parameters
remoteUser a User
Returns
  • a list of user keys

public Set<String> getRecentAssigneeNamesForIssue (Issue issue)

Gets the names of this issue's recent assignees, including the current assignee.

Parameters
issue an issue to get the change history of
Returns
  • a set of usernames

public Set<String> getRecentAssigneeNamesForUser (User remoteUser)

Get users names that the given user has recently assigned issues to.

Parameters
remoteUser a User
Returns
  • a list of user names

public List<User> getSuggestedAssignees (Issue issue, User loggedInUser, List<User> assignableUsers)

Returns a list of suggested Assignee Users for a given Issue and logged-in User.

This version accepts a pre-populated list of assignable Users to filter.

Parameters
issue Issue to get suggested Assignees for
loggedInUser the user getting the suggestions, whose Assignee history may be queried
assignableUsers a list of Users to filter
Returns
  • List of User objects deemed relevant to the given Issue and User.

public List<User> getSuggestedAssignees (Set<String> suggestedAssigneeNames, List<User> assignableUsers)

Given a set of suggested names and an ordered list of assignable users, returns an order list of suggested users.

Parameters
suggestedAssigneeNames the names of the users to return
assignableUsers a list of Users to filter by the suggested assignee names
Returns
  • a filtered List of assignable Users that are suggested as Assignees

public List<User> getSuggestedAssignees (Issue issue, User loggedInUser, ActionDescriptor actionDescriptor)

Returns a list of suggested Assignee Users for a given Issue and logged-in User.

This version accepts a pre-populated list of assignable Users to filter.

Parameters
issue Issue to get suggested Assignees for
loggedInUser the user getting the suggestions, whose Assignee history may be queried
actionDescriptor workflow action descriptor to filter users on
Returns
  • List of User objects deemed relevant to the given Issue and User, sorted by UserBestNameComparator

public Map<StringBoolean> makeUniqueFullNamesMap (Collection<User> users)

Converts a collection of Users to a Map where the key is the User full name and the value is true or false.

The value will be true if no other user with that exact full name exists. The value will be false if at least one other user with that exact full name exists.

Parameters
users a collection of Users that may contain multiple users with the same full name
Returns
  • a map of user full name Strings to a uniqueness boolean flag