com.atlassian.jira.issue.search.quicksearch
Interface ProjectAwareQuickSearchHandler

All Known Implementing Classes:

ProjectAwareQuickSearchHandlerImpl

public interface ProjectAwareQuickSearchHandler

Helper class to extract projects from the search result context.

Since:

v3.13

Method Summary

void	addProject(String projectId, QuickSearchResult searchResult) Adds a project to the given search.
List	getProjects(QuickSearchResult searchResult) Retrieve the related project generic values from the search result
String	getSingleProjectIdFromSearch(QuickSearchResult searchResult) Retrieves the single project specified in search.

Method Detail

getProjects

List getProjects(QuickSearchResult searchResult)

Retrieve the related project generic values from the search result

Parameters:

searchResult - search result to extract related project information from

Returns:

all projects that may be related to this search

getSingleProjectIdFromSearch

String getSingleProjectIdFromSearch(QuickSearchResult searchResult)

Retrieves the single project specified in search.

Parameters:

searchResult - search result to extract the project from

Returns:

the ID of the single project in search. Null if there is no project of more than 1 project

addProject

void addProject(String projectId,
                QuickSearchResult searchResult)

Adds a project to the given search.

Parameters:

projectId - project id to add

searchResult - search result to add to