Package com.atlassian.jira.plugins.quicksearch.impl

Class ProjectSearcher

java.lang.Object

com.atlassian.jira.plugins.quicksearch.impl.ProjectSearcher

All Implemented Interfaces:

ProductSearcher

@Component
public class ProjectSearcher
extends Object
implements ProductSearcher

Search provider for recent and queried projects

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROJECTS_GROUP_ID

Method Summary

Modifier and Type	Method	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 maximumItemCount, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROJECTS_GROUP_ID

public static final String PROJECTS_GROUP_ID

See Also:

• Constant Field Values

Method Details

getRecentItems

public ResultGroup getRecentItems()

Description copied from interface: ProductSearcher

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.

Specified by:

getRecentItems in interface ProductSearcher

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

public ResultGroup getRecentItems(int maxItemCount)

Description copied from interface: ProductSearcher

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.

Specified by:

getRecentItems in interface ProductSearcher

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

public ResultGroup getSearchedItems(@Nonnull
 String search)
                             throws Exception

Description copied from interface: ProductSearcher

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

Specified by:

getSearchedItems in interface ProductSearcher

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

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

Description copied from interface: ProductSearcher

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

Specified by:

getSearchedItems in interface ProductSearcher

Parameters:

maximumItemCount - 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

public String getSearchTypeLabel()

Description copied from interface: ProductSearcher

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

Specified by:

getSearchTypeLabel in interface ProductSearcher