@PublicApi public class

IssuePickerResults

extends Object
java.lang.Object
   ↳ com.atlassian.jira.bc.issue.search.IssuePickerResults

@PublicApi

This class 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

Simple Bean for returning back the results of an Issue Picker provider

Summary

Public Constructors
IssuePickerResults(Collection<Issue> issues, int total, Collection<String> keyTerms, Collection<String> summaryTerms, String label, String id)
Full constructor for results
Public Methods
String getId()
Collection<Issue> getIssues()
Collection<String> getKeyTerms()
String getLabel()
Collection<String> getSummaryTerms()
int getTotalIssues()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public IssuePickerResults (Collection<Issue> issues, int total, Collection<String> keyTerms, Collection<String> summaryTerms, String label, String id)

Full constructor for results

Parameters
issues The issues that were selected
total The total number of issues that match criteria
keyTerms The terms that searched for in the key
summaryTerms The terms that were searched for in the summary
label The section label
id The unique id of the section

Public Methods

public String getId ()

public Collection<Issue> getIssues ()

public Collection<String> getKeyTerms ()

public String getLabel ()

public Collection<String> getSummaryTerms ()

public int getTotalIssues ()