@PublicSpi public interface

SearchRequestView

com.atlassian.jira.plugin.searchrequestview.SearchRequestView
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

A specific view of a Search Request. Generally this is a different content type (eg. XML, Word or PDF versions of a search request).

Summary

Public Methods
void init(SearchRequestViewModuleDescriptor moduleDescriptor)
A lifecycle method that will be called by the plugin system that gives access to the ModuleDescriptor that controls this plugin.
void writeHeaders(SearchRequest searchRequest, RequestHeaders requestHeaders, SearchRequestParams searchRequestParams)
Prints the HTML headers for non-typial HTML such as Word or Excel views.
void writeSearchResults(SearchRequest searchRequest, SearchRequestParams searchRequestParams, Writer writer)
Responsible for writing out the searchResults including Headers and Footers of the implementing view type.

Public Methods

public void init (SearchRequestViewModuleDescriptor moduleDescriptor)

A lifecycle method that will be called by the plugin system that gives access to the ModuleDescriptor that controls this plugin.

Parameters
moduleDescriptor the controller of this plugin.

public void writeHeaders (SearchRequest searchRequest, RequestHeaders requestHeaders, SearchRequestParams searchRequestParams)

Prints the HTML headers for non-typial HTML such as Word or Excel views. (e.g.: requestHeaders.addHeader("content-disposition", "attachment;filename="sample.doc";");)

Parameters
searchRequest the original search request submitted by the user
requestHeaders subset of HttpServletResponse responsible for setting headers only
searchRequestParams context about the current search request

public void writeSearchResults (SearchRequest searchRequest, SearchRequestParams searchRequestParams, Writer writer)

Responsible for writing out the searchResults including Headers and Footers of the implementing view type.

Parameters
searchRequest the original search request submitted by the user
searchRequestParams stores a shallow copy of the session and a pagerfilter to determine how many results to display
writer The writer used to stream the response.
Throws
SearchException Exceptions occured while trying to peform a search on the SearchRequest