|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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).
SearchRequestViewModuleDescriptor
,
SearchRequest
Method Summary | |
---|---|
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)
Deprecated. since v3.13.3 please use writeHeaders(com.atlassian.jira.issue.search.SearchRequest, RequestHeaders, SearchRequestParams) |
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 Detail |
---|
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)
writeHeaders(com.atlassian.jira.issue.search.SearchRequest, RequestHeaders, SearchRequestParams)
searchRequest
- the original search request submitted by the userrequestHeaders
- subset of HttpServletResponse responsible for setting headers onlyvoid 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 request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |