Interface PermissionsFilterGenerator

All Known Implementing Classes:
FeatureFlaggedPermissionFilterGenerator, PermissionsFilterGeneratorImpl

@Deprecated(since="10.4", forRemoval=true) public interface PermissionsFilterGenerator
Deprecated, for removal: This API element is subject to removal in a future version.
since 10.4. Use PermissionsQueryGenerator instead.
Since:
v4.0
  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.search.Query
    Deprecated.
    org.apache.lucene.search.Query
    Deprecated, for removal: This API element is subject to removal in a future version.
    Generates a lucene Query that is the canonical set of permissions for viewable issues for the given user and collection of projects.
  • Method Details

    • getQuery

      org.apache.lucene.search.Query getQuery(ApplicationUser searcher)
      Deprecated.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.