com.atlassian.jira.issue.fields.rest

Interface ProjectSuggestionProvider

All Known Implementing Classes:

ProjectSuggestionProviderImpl

@PublicApi
public interface ProjectSuggestionProvider

Provides suggestion groups needed to render a project picker client-side.

Since:

v7.0

Method Summary

Modifier and Type	Method and Description
List<SuggestionGroupBean>	getProjectPickerSuggestions(Optional<Long> selectedProject, boolean includeRecent) Returns a list of SuggestionGroupBeans containing all projects.
List<SuggestionGroupBean>	getProjectPickerSuggestions(ProjectPermissionKey permission, Optional<Long> selectedProject, boolean includeRecent) Returns a list of SuggestionGroupBeans containing all the projects the current user can access with the provided permission.

Method Detail

getProjectPickerSuggestions

List<SuggestionGroupBean> getProjectPickerSuggestions(Optional<Long> selectedProject,
                                                      boolean includeRecent)

Returns a list of SuggestionGroupBeans containing all projects.

Parameters:

selectedProject - Used to highlight the currently selected project

includeRecent - True if the result should contain a separate group for the most recent projects first

Returns:

A list of suggestions to render a project picker

getProjectPickerSuggestions

List<SuggestionGroupBean> getProjectPickerSuggestions(ProjectPermissionKey permission,
                                                      Optional<Long> selectedProject,
                                                      boolean includeRecent)

Returns a list of SuggestionGroupBeans containing all the projects the current user can access with the provided permission.

Parameters:

permission - the permission to use to retrieve projects for the current user

selectedProject - Used to highlight the currently selected project

includeRecent - True if the result should contain a separate group for the most recent projects first

Returns:

A list of suggestions to render a project picker