com.atlassian.jira.issue.search

Class SearchQuery

java.lang.Object

com.atlassian.jira.issue.search.SearchQuery

public class SearchQuery
extends Object

Encapsulation of all parameters required to match Lucene documents. Includes

• Query
• ApplicationUser
• OverrideSecurity
• Query to further restrict results by anding with an additional Lucene query

Method Summary

Modifier and Type	Method and Description
static SearchQuery	create(Query query, ApplicationUser searcher) Creates basic SearchQuery with default overrideSecurity = false and luceneQuery = null.
boolean	equals(Object o)
org.apache.lucene.search.Query	getLuceneQuery()
Query	getQuery()
ApplicationUser	getUser()
int	hashCode()
boolean	isOverrideSecurity()
SearchQuery	luceneQuery(org.apache.lucene.search.Query luceneQuery) Additional Lucene query that will be anded with query to further restrict search results.
SearchQuery	overrideSecurity(boolean overrideSecurity) Decides if search results should be restricted to those visible to user, or unrestricted.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SearchQuery create(Query query,
                                 ApplicationUser searcher)

Creates basic SearchQuery with default overrideSecurity = false and luceneQuery = null.

Parameters:

query - JQL query to define search results

searcher - ApplicationUser that will be used in search. This has two purposes:

1. security - when overrideSecurity is not set, search results will be restricted to those the user is permitted to see
2. search context - JQL functions will be given this user in QueryCreationContext

Returns:

SearchQuery that can be further adjusted with overrideSecurity(boolean) and luceneQuery(org.apache.lucene.search.Query).

overrideSecurity

public SearchQuery overrideSecurity(boolean overrideSecurity)

Decides if search results should be restricted to those visible to user, or unrestricted. This will be available to JQL functions in QueryCreationContext.

Parameters:

overrideSecurity - true if security restrictions should be ignored

luceneQuery

public SearchQuery luceneQuery(org.apache.lucene.search.Query luceneQuery)

Additional Lucene query that will be anded with query to further restrict search results.

Parameters:

luceneQuery -

getQuery

public Query getQuery()

getLuceneQuery

public org.apache.lucene.search.Query getLuceneQuery()

getUser

@Nullable
public ApplicationUser getUser()

isOverrideSecurity

public boolean isOverrideSecurity()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object