com.atlassian.jira.bc.user.search

Class DefaultAssigneeService

java.lang.Object

com.atlassian.jira.bc.user.search.DefaultAssigneeService

All Implemented Interfaces:

AssigneeService

public class DefaultAssigneeService
extends Object
implements AssigneeService

The main implementation of AssigneeService.

Since:

v5.0

Constructor Summary

Constructors

Constructor and Description
DefaultAssigneeService(PermissionContextFactory permissionContextFactory, PermissionSchemeManager permissionSchemeManager, UserHistoryManager userHistoryManager, FeatureManager featureManager, JiraAuthenticationContext authenticationContext, UserKeyService userKeyService, UserManager userManager, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method and Description
Collection<ApplicationUser>	findAssignableUsers(String query, Issue issue, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Get assignable Users based on a query string and issue.
Collection<ApplicationUser>	findAssignableUsers(String query, Project project) Get assignable Users based on a query string and project.
List<ApplicationUser>	getAssignableUsers(Collection<Issue> issues, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Get all ApplicationUsers that may have all of the given Issues assigned to them, for a given workflow state.
List<ApplicationUser>	getAssignableUsers(Issue issue, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Get all ApplicationUsers 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(ApplicationUser 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(ApplicationUser remoteUser) Get users names that the given user has recently assigned issues to.
List<ApplicationUser>	getSuggestedAssignees(Issue issue, ApplicationUser loggedInUser, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Returns a list of suggested Assignee ApplicationUsers for a given Issue and logged-in com.atlassian.jira.user.ApplicationUser.
List<ApplicationUser>	getSuggestedAssignees(Issue issue, ApplicationUser loggedInUser, List<ApplicationUser> assignableUsers) Returns a list of suggested Assignee ApplicationUsers for a given Issue and logged-in com.atlassian.jira.user.ApplicationUser.
List<ApplicationUser>	getSuggestedAssignees(Set<String> suggestedAssigneeNames, List<ApplicationUser> assignableUsers) Given a set of suggested names and an ordered list of assignable users, returns an order list of suggested users.
boolean	isAssignable(Issue issue, ApplicationUser user, com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor) Determines if a user is assignable to an issue.
boolean	isAssignable(Project project, ApplicationUser user) Determines if a user is assignable to an issue in a project.
Map<String,Boolean>	makeUniqueFullNamesMap(Collection<ApplicationUser> users) Converts a collection of Users to a Map where the key is the com.atlassian.jira.user.ApplicationUser full name and the value is true or false.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAssigneeService

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

Method Detail

isAssignable

public boolean isAssignable(@Nonnull
                            Issue issue,
                            @Nonnull
                            ApplicationUser user,
                            @Nullable
                            com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Description copied from interface: AssigneeService

Determines if a user is assignable to an issue.

Specified by:

isAssignable in interface AssigneeService

Parameters:

issue - the issue.

user - the user to check.

Returns:

true if user is assignable to the issue, false if not.

isAssignable

public boolean isAssignable(@Nonnull
                            Project project,
                            @Nonnull
                            ApplicationUser user)

Description copied from interface: AssigneeService

Determines if a user is assignable to an issue in a project.

Specified by:

isAssignable in interface AssigneeService

Parameters:

project - the project.

user - the user to check.

Returns:

true if user is assignable to issues in the project, false if not.

getSuggestedAssignees

public List<ApplicationUser> getSuggestedAssignees(Issue issue,
                                                   @Nullable
                                                   ApplicationUser loggedInUser,
                                                   @Nullable
                                                   com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Description copied from interface: AssigneeService

Returns a list of suggested Assignee ApplicationUsers for a given Issue and logged-in com.atlassian.jira.user.ApplicationUser.

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

Specified by:

getSuggestedAssignees in interface AssigneeService

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 ApplicationUser objects deemed relevant to the given Issue and com.atlassian.jira.user.ApplicationUser, sorted by UserBestNameComparator

getSuggestedAssignees

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

Description copied from interface: AssigneeService

Returns a list of suggested Assignee ApplicationUsers for a given Issue and logged-in com.atlassian.jira.user.ApplicationUser.

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

Specified by:

getSuggestedAssignees in interface AssigneeService

Parameters:

issue - Issue to get suggested Assignees for

loggedInUser - the user getting the suggestions, whose Assignee history may be queried

assignableUsers - a list of ApplicationUsers to filter

Returns:

List of ApplicationUser objects deemed relevant to the given Issue and com.atlassian.jira.user.ApplicationUser.

findAssignableUsers

public Collection<ApplicationUser> findAssignableUsers(String query,
                                                       Issue issue,
                                                       @Nullable
                                                       com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Description copied from interface: AssigneeService

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.

Specified by:

findAssignableUsers in interface AssigneeService

Parameters:

query - String to search for.

issue - Issue to check Assignee permissions against

actionDescriptor - an ActionDescriptor describing the context in which the Assignee is being searched

Returns:

List of ApplicationUser objects that match criteria.

findAssignableUsers

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

Description copied from interface: AssigneeService

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.

Specified by:

findAssignableUsers in interface AssigneeService

Parameters:

query - String to search for.

project - Project check Assignee permissions against

Returns:

List of ApplicationUser objects that match criteria.

getSuggestedAssignees

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

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

Specified by:

getSuggestedAssignees in interface AssigneeService

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

getAssignableUsers

public List<ApplicationUser> getAssignableUsers(Issue issue,
                                                com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Description copied from interface: AssigneeService

Get all ApplicationUsers 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.

Specified by:

getAssignableUsers in interface AssigneeService

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

getAssignableUsers

public List<ApplicationUser> getAssignableUsers(Collection<Issue> issues,
                                                com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)

Description copied from interface: AssigneeService

Get all ApplicationUsers 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 AssigneeService.getAssignableUsers(Issue, ActionDescriptor), but returns only those users that are assignable for all of the issues. This is significantly more efficient than calling AssigneeService.getAssignableUsers(Issue, ActionDescriptor) multiple times and filtering the lists yourself.

Specified by:

getAssignableUsers in interface AssigneeService

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

getRecentAssigneeKeysForIssue

public Set<String> getRecentAssigneeKeysForIssue(Issue issue)

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

Specified by:

getRecentAssigneeKeysForIssue in interface AssigneeService

Parameters:

issue - an issue to get the change history of

Returns:

a set of ids

See Also:

AssigneeService.getRecentAssigneeNamesForIssue(com.atlassian.jira.issue.Issue)

getRecentAssigneeNamesForIssue

public Set<String> getRecentAssigneeNamesForIssue(Issue issue)

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

Specified by:

getRecentAssigneeNamesForIssue in interface AssigneeService

Parameters:

issue - an issue to get the change history of

Returns:

a set of usernames

See Also:

AssigneeService.getRecentAssigneeKeysForIssue(com.atlassian.jira.issue.Issue)

makeUniqueFullNamesMap

public Map<String,Boolean> makeUniqueFullNamesMap(Collection<ApplicationUser> users)

Description copied from interface: AssigneeService

Converts a collection of Users to a Map where the key is the com.atlassian.jira.user.ApplicationUser 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.

Specified by:

makeUniqueFullNamesMap in interface AssigneeService

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

getRecentAssigneeNamesForUser

public Set<String> getRecentAssigneeNamesForUser(ApplicationUser remoteUser)

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

Specified by:

getRecentAssigneeNamesForUser in interface AssigneeService

Parameters:

remoteUser - a ApplicationUser

Returns:

a list of user names

getRecentAssigneeKeysForUser

public Set<String> getRecentAssigneeKeysForUser(ApplicationUser remoteUser)

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

Specified by:

getRecentAssigneeKeysForUser in interface AssigneeService

Parameters:

remoteUser - a ApplicationUser

Returns:

a list of user keys