@PublicApi public interface

ProjectSuggestionProvider

com.atlassian.jira.issue.fields.rest.ProjectSuggestionProvider
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

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

Summary

Public Methods
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.
List<SuggestionGroupBean> getProjectPickerSuggestions(Optional<Long> selectedProject, boolean includeRecent)
Returns a list of SuggestionGroupBeans containing all projects.

Public Methods

public 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

public 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