com.atlassian.jira.plugins.quicksearch.api

Interface ProductSearcher

All Known Implementing Classes:

IssueSearcher, ProjectSearcher

public interface ProductSearcher

A search provider for a single type of resource to appear in the ultimate search bar, such as projects or issues.

Method Summary

Modifier and Type	Method and Description
ResultGroup	getRecentItems() Retrieves recently viewed items for the current user, contained within a result group.
ResultGroup	getRecentItems(int maxItemCount) Retrieves recently viewed items for the current user, contained within a result group.
ResultGroup	getSearchedItems(int maxItemCount, String search) Retrieves items that match a provided search query, contained within a result group.
ResultGroup	getSearchedItems(String search) Retrieves items that match a provided search query, contained within a result group.
String	getSearchTypeLabel() Returns a label representing type of item this searcher retrieves.

Method Detail

getRecentItems

ResultGroup getRecentItems()

Retrieves recently viewed items for the current user, contained within a result group. If the current user is anonymous, or no recent items exist for this type, an empty list is provided.

Returns:

A result group containing a list of recent items and a view all url for either viewing all items or all recently viewed items of this resource type

getRecentItems

ResultGroup getRecentItems(int maxItemCount)

Retrieves recently viewed items for the current user, contained within a result group. Limits the amount of items returned by the passed parameter If the current user is anonymous, or no recent items exist for this type, an empty list is provided.

Parameters:

maxItemCount - Limits the amount of items returned

Returns:

A result group containing a list of recent items and a view all url for either viewing all items or all recently viewed items of this resource type

getSearchedItems

ResultGroup getSearchedItems(@Nonnull
                             String search)
                      throws Exception

Retrieves items that match a provided search query, contained within a result group.

Parameters:

search - A user submitted search string

Returns:

A result group containing a list of matching items and a view all url for viewing all matching items of this resource type

Throws:

Exception

getSearchedItems

ResultGroup getSearchedItems(int maxItemCount,
                             @Nonnull
                             String search)
                      throws Exception

Retrieves items that match a provided search query, contained within a result group. Limits the amount of items returned by the passed parameter

Parameters:

maxItemCount - Limits the amount of items returned

search - A user submitted search string

Returns:

A result group containing a list of matching items and a view all url for viewing all matching items of this resource type

Throws:

Exception

getSearchTypeLabel

String getSearchTypeLabel()

Returns a label representing type of item this searcher retrieves. This is the same label that is requested through the ultimate search endpoint.