@PublicSpi
public interface SearchRequestView
SearchRequestViewModuleDescriptor
,
SearchRequest
Modifier and Type | Method and 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.
|
void init(SearchRequestViewModuleDescriptor moduleDescriptor)
ModuleDescriptor
that controls this plugin.moduleDescriptor
- the controller of this plugin.void writeSearchResults(SearchRequest searchRequest, SearchRequestParams searchRequestParams, Writer writer) throws SearchException
searchRequest
- the original search request submitted by the usersearchRequestParams
- stores a shallow copy of the session and a pagerfilter to determine how many results to displaywriter
- The writer used to stream the response.SearchException
- Exceptions occured while trying to peform a search on the SearchRequest
void writeHeaders(SearchRequest searchRequest, RequestHeaders requestHeaders, SearchRequestParams searchRequestParams)
searchRequest
- the original search request submitted by the userrequestHeaders
- subset of HttpServletResponse responsible for setting headers onlysearchRequestParams
- context about the current search requestCopyright © 2002-2015 Atlassian. All Rights Reserved.