com.atlassian.jira.plugin.assignee

Interface AssigneeResolver

All Known Implementing Classes:

DefaultAssigneeResolver

public interface AssigneeResolver

Used to determine the default assignee for an issue. This class is used when an issue is created or updated (e.g edited or transitioned through workfow, etc) and the user selectes 'Automatic' from the assignee drop down. The implementation of this class is responsible for resolving 'Automatic' to the actual user the issue will be assigned to.

Copyright (c) 2002-2004 All rights reserved.

Method Summary

Modifier and Type	Method and Description
ApplicationUser	getDefaultAssignee(Issue issue, Map fieldValuesHolder) Determines the actual User the issue should be assigned to.
ApplicationUser	getDefaultAssigneeObject(Issue issue, Map fieldValuesHolder) Determines the default User the issue should be assigned to.
ErrorCollection	validateDefaultAssignee(Issue issue, Map fieldValuesHolder) This method is called to validate input when a user selects 'Automatic' during an issue operation, e.g.

Method Detail

validateDefaultAssignee

ErrorCollection validateDefaultAssignee(Issue issue,
                                        Map fieldValuesHolder)

This method is called to validate input when a user selects 'Automatic' during an issue operation, e.g. creating, editing, moving an issue, etc.

This method allows the implementation of this interface to validate the input and report any errors back to the caller (most likely the user interface). Most often the errors reported are if the default assignee does not have the Permissions.ASSIGNABLE_USER permission. This method is called before getDefaultAssignee(com.atlassian.jira.issue.Issue, java.util.Map).

The fieldValuesHolder holds values of issue fields that have been selected during the operation. For exmaple, if an issue is being transitioned through workflow and the Screen for the workflow transition shows 3 fields (e.g. description, fix versions, and assignee) the fieldValuesHolder will hold the values of these 3 issue fields. The keys of fieldValuesHolder are issue field ids that can be found in IssueFieldConstants.

Parameters:

issue - the issue the assignee will be selected for.

fieldValuesHolder - holds values of fields that appear on the Screen of the operation that is being performed. The keys are ids of issue fields. The issue field ids are found in IssueFieldConstants

Returns:

ErrorCollection with errors (if any). Others an empty ErrorCollection is returned.

getDefaultAssignee

ApplicationUser getDefaultAssignee(Issue issue,
                                   Map fieldValuesHolder)

Determines the actual User the issue should be assigned to. This method is invoked when an issue is being created, edited, moved, etc.

This method is invoked to actually deterine the User the issue is assigned to. This method is invoked after validateDefaultAssignee(com.atlassian.jira.issue.Issue, java.util.Map).

Parameters:

issue - the issue the assignee will be selected for.

fieldValuesHolder - is the same as for validateDefaultAssignee(com.atlassian.jira.issue.Issue, java.util.Map). IssueFieldConstants

Returns:

the user the issue should be assigned to.

getDefaultAssigneeObject

ApplicationUser getDefaultAssigneeObject(Issue issue,
                                         Map fieldValuesHolder)

Determines the default User the issue should be assigned to.

This method is invoked when an issue is being created, edited, moved, etc.

When used in GUI operations, this method will be invoked after validateDefaultAssignee(com.atlassian.jira.issue.Issue, java.util.Map). However, it can also be called by itself (eg when creating an issue from an incoming email).

Parameters:

issue - the issue the assignee will be selected for.

fieldValuesHolder - is the same as for validateDefaultAssignee(com.atlassian.jira.issue.Issue, java.util.Map).

Returns:

the user the issue should be assigned to.

Throws:

DefaultAssigneeException - If the default assignee is invalid (eg user does not have assign permission) .