Package com.atlassian.jira.lucene.internal.issue.search

Class SearchQuery

java.lang.Object
com.atlassian.jira.lucene.internal.issue.search.SearchQuery
@Deprecated(since="10.4", forRemoval=true) public class SearchQuery extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Use DocumentSearchRequest instead.
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
    Description
    static SearchQuery
    create(Query query, ApplicationUser searcher)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates basic SearchQuery with default overrideSecurity = false and luceneQuery = null.
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    org.apache.lucene.search.Query
    getLuceneQuery()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Query
    getQuery()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ApplicationUser
    getUser()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isOverrideSecurity()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    SearchQuery
    luceneQuery(org.apache.lucene.search.Query luceneQuery)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Additional Lucene query that will be anded with query to further restrict search results.
    SearchQuery
    overrideSecurity(boolean overrideSecurity)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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 Details

    • create

      public static SearchQuery create(Query query, ApplicationUser searcher)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Additional Lucene query that will be anded with query to further restrict search results.
      Parameters:
      luceneQuery -

    • getQuery

      public Query getQuery()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getLuceneQuery

      public org.apache.lucene.search.Query getLuceneQuery()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getUser

      @Nullable public ApplicationUser getUser()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isOverrideSecurity

      public boolean isOverrideSecurity()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object