com.atlassian.jira.issue.search.parameters.lucene

Interface PermissionsFilterGenerator

All Known Implementing Classes:

PermissionsFilterGeneratorImpl

public interface PermissionsFilterGenerator

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Query	getQuery(ApplicationUser searcher) Deprecated. Use getQuery(ApplicationUser, Collection) instead, since 7.10
org.apache.lucene.search.Query	getQuery(ApplicationUser searcher, Collection<Project> projects) Generates a lucene Query that is the canonical set of permissions for viewable issues for the given user and collection of projects.

Method Detail

getQuery

org.apache.lucene.search.Query getQuery(ApplicationUser searcher)

Deprecated. Use getQuery(ApplicationUser, Collection) instead, since 7.10

Generates a lucene Query that is the canonical set of permissions for viewable issues for the given user. This query can then be used to filter out impermissible documents from a lucene search.

Parameters:

searcher - the user performing the search

Returns:

the query; could be null if an error occurred.

getQuery

org.apache.lucene.search.Query getQuery(ApplicationUser searcher,
                                        @Nonnull
                                        Collection<Project> projects)

Generates a lucene Query that is the canonical set of permissions for viewable issues for the given user and collection of projects. This query can then be used to filter out impermissible documents from a lucene search.

Parameters:

searcher - the user performing the search

projects - the projects that are subject to search

Returns:

the query; could be null if an error occurred.