@PublicApi public interface

AssigneeService

com.atlassian.jira.bc.user.search.AssigneeService
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

Service that retrieves issue-assignable User objects.

Assignees may be filtered on a search string or on recent issue or user history.

Summary

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)
Returns the keys of Users that the given Issue has recently been assigned to.
Set<String> getRecentAssigneeKeysForUser(User remoteUser)
Returns the keys of Users that have recently been assigned to issues by the specified User.
Set<String> getRecentAssigneeNamesForIssue(Issue issue)
Returns the names of Users that the given Issue has recently been assigned to.
Set<String> getRecentAssigneeNamesForUser(User user)
Returns the names of Users that have recently been assigned to issues by the specified User.
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)
Converts a set of suggested assignee name Strings to a list of suggested User objects.
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.

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)

Returns the keys of Users that the given Issue has recently been assigned to.

The current assignee should be included in the returned list.

Parameters
issue Issue to get recent assignees for
Returns
  • a Set of assignee keys

public Set<String> getRecentAssigneeKeysForUser (User remoteUser)

Returns the keys of Users that have recently been assigned to issues by the specified User.

Parameters
remoteUser User to check for assignees in history manager
Returns
  • a Set of assignee usernames

public Set<String> getRecentAssigneeNamesForIssue (Issue issue)

Returns the names of Users that the given Issue has recently been assigned to.

The current assignee should be included in the returned list.

Parameters
issue Issue to get recent assignees for
Returns
  • a Set of assignee usernames

public Set<String> getRecentAssigneeNamesForUser (User user)

Returns the names of Users that have recently been assigned to issues by the specified User.

Parameters
user User to check for assignees in history manager
Returns
  • a Set of assignee usernames

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)

Converts a set of suggested assignee name Strings to a list of suggested User objects.

Suggested user names may not be returned as suggested users if they are not in the assignable user list.

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