com.atlassian.jira.sharing.search

Interface SharedEntitySearcher<S extends SharedEntity>

All Known Implementing Classes:

DefaultSharedEntitySearcher

public interface SharedEntitySearcher<S extends SharedEntity>

Perform searches for SharedEntity instances.

Since:

v3.13

Method Summary

Methods

Modifier and Type	Method and Description
SharedEntitySearchResult<S>	search(SharedEntitySearchParameters searchParameters) Search for SharedEntity instances that match the passed in searchParameters.
SharedEntitySearchResult<S>	search(SharedEntitySearchParameters searchParameters, ApplicationUser user, int pageOffset, int pageWidth) Search for SharedEntity instances that match the passed in searchParameters.

Method Detail

search

SharedEntitySearchResult<S> search(SharedEntitySearchParameters searchParameters,
                                 ApplicationUser user,
                                 int pageOffset,
                                 int pageWidth)

Search for SharedEntity instances that match the passed in searchParameters.

Parameters:

searchParameters - the search searchParameters for the search.

user - the user to perform the search as.

pageOffset - the page that should be returned by the search. Must be >=0.

pageWidth - the width of the page that should be returned by the search. Can be set to Integer.MAX_VALUE if you want to return all results at one. In this case it is compulsory to set pageOffest to 0.

Returns:

the search results.

search

SharedEntitySearchResult<S> search(SharedEntitySearchParameters searchParameters)

Search for SharedEntity instances that match the passed in searchParameters. Used for system searches. Unpaged and no permissions query performed.

Parameters:

searchParameters - the search searchParameters for the search.

Returns:

the search results.