Package com.atlassian.jira.plugin.searchrequestview

Interface SearchRequestParams

All Superinterfaces:
IssueViewRequestParams
All Known Implementing Classes:
SearchRequestParamsImpl
public interface SearchRequestParams extends IssueViewRequestParams
This is used by SearchRequestView plugins to provide information about their context.

  • Method Details

    • getSession

      Map getSession()
      Used to access information that may have been stored in the HttpSession. Values stored in the session cannot be modified in any way.
      Returns:
      map containing a shallow copy of the HttpSession

    • getPagerFilter

      PagerFilter getPagerFilter()
      Used to get a handle on a pager filter that will have its start and max values setup based on either system defaults or possibly overridden by request parameters ('tempMax' and 'pager/start').
      Returns:
      PagerFilter with appropriate max and start values set.

    • getUserAgent

      String getUserAgent()
      Returns:
      the user agent string from the request

    • setReturnMax

      void setReturnMax(boolean returnMax)
      Parameters:
      returnMax - true if the search should return up to the maximum number of issues configured for the 'jira.search.views.max.limit' application property, even if a greater value is set as the max on the pager filter.

    • isReturnMax

      boolean isReturnMax()
      Returns:
      true if the search should return up to the maximum number of issues configured for the 'jira.search.views.max.limit' application property, even if a greater value is set as the max on the pager filter.

    • getFileExtension

      String getFileExtension()
      Returns:
      Desired file extension for attachment.