Package com.atlassian.jira.web.action.issue

Interface IssueSearchLimits

All Known Implementing Classes:
BaseIssueSearchLimits, LuceneIssueSearchLimits, OpenSearchIssueSearchLimits
public interface IssueSearchLimits
Utility methods that allow you to get the limits that are imposed by JIRA configuration properties.
Since:
v4.3

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_MAX_RESULTS
    The default maximum for the number of issues returned by some functionalities in Jira, e.g.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAggregationBucketLimit()
    Get the bucket limit for aggregations depending on which Search Platform is currently used
    int
    getMaxResults()
    Returns the maximum number of search results that this JIRA instance is configured to allow, by reading it from the
    int
    getSearchPlatformMaxResultWindow()
    Get the maximum number of search results depending on which Search Platform is currently used For Open Search, this returns the max_result_window setting for the Issues index

  • Field Details

    • DEFAULT_MAX_RESULTS

      static final int DEFAULT_MAX_RESULTS
      The default maximum for the number of issues returned by some functionalities in Jira, e.g. Issue Navigator. Note that this is NOT the maximum number of search results that can be returned by the underlying search platform, see getSearchPlatformMaxResultWindow().
      See Also:

  • Method Details

    • getMaxResults

      int getMaxResults()
      Returns the maximum number of search results that this JIRA instance is configured to allow, by reading it from the 
      jpm.xml
      file. If there is a problem reading the configured value, this method returns 1000. Note that this is NOT the maximum number of search results that can be returned by the underlying search platform, see getSearchPlatformMaxResultWindow().
      Returns:
      an int containing the maximum number of search results to return

    • getAggregationBucketLimit

      int getAggregationBucketLimit()
      Get the bucket limit for aggregations depending on which Search Platform is currently used
      Returns:
      aggregation buckets limit for currently used Search Platform

    • getSearchPlatformMaxResultWindow

      int getSearchPlatformMaxResultWindow()
      Get the maximum number of search results depending on which Search Platform is currently used For Open Search, this returns the max_result_window setting for the Issues index
      Returns:
      the maximum number of search results