Package com.atlassian.jira.plugin.searchrequestview

Interface SearchRequestView

All Known Implementing Classes:

AbstractCsvSearchRequestView, AbstractSearchRequestExcelView, AbstractSearchRequestFullContentView, AbstractSearchRequestIssueTableView, AbstractSearchRequestView, SearchRequestChartsView, SearchRequestCsvViewAllFields, SearchRequestCsvViewCurrentFields, SearchRequestCsvWithBomViewAllFields, SearchRequestCsvWithBomViewCurrentFields, SearchRequestExcelViewAllFields, SearchRequestExcelViewCurrentFields, SearchRequestFullContentView, SearchRequestPrintableView, SearchRequestRecentCommentsView, SearchRequestRSSView, SearchRequestWordView, SearchRequestXMLView

@PublicSpi
public interface SearchRequestView

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

See Also:

• SearchRequestViewModuleDescriptor
• SearchRequest

Method Summary

Modifier and Type	Method	Description
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.

Method Details

init

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.

writeSearchResults

void writeSearchResults(SearchRequest searchRequest,
 SearchRequestParams searchRequestParams,
 Writer writer)
                 throws SearchException

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

writeHeaders

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