com.atlassian.jira.issue.views.csv

Class AbstractCsvSearchRequestView

java.lang.Object

com.atlassian.jira.plugin.searchrequestview.AbstractSearchRequestView

com.atlassian.jira.issue.views.csv.AbstractCsvSearchRequestView

All Implemented Interfaces:

SearchRequestView

Direct Known Subclasses:

SearchRequestCsvViewAllFields, SearchRequestCsvViewCurrentFields

public abstract class AbstractCsvSearchRequestView
extends AbstractSearchRequestView

This is the request view for dealing with the exportation of issues into a Csv format.

Since:

7.2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected CsvIssueExporter	csvIssueExporter

Fields inherited from class com.atlassian.jira.plugin.searchrequestview.AbstractSearchRequestView

descriptor

Constructor Summary

Constructors

Constructor and Description
AbstractCsvSearchRequestView(ApplicationProperties applicationProperties, CsvIssueExporter csvIssueExporter)

Method Summary

Modifier and Type	Method and Description
protected abstract List<Field>	getFieldsToBeExported(SearchRequest searchRequest) Get the fields that should be exported for this Csv export.
void	writeHeaders(SearchRequest searchRequest, RequestHeaders requestHeaders, SearchRequestParams searchRequestParams) By default we don't care about the user agent
void	writeSearchResults(SearchRequest searchRequest, SearchRequestParams searchRequestParams, Writer writer) Responsible for writing out the searchResults including Headers and Footers of the implementing view type.

Methods inherited from class com.atlassian.jira.plugin.searchrequestview.AbstractSearchRequestView

init, writeHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

csvIssueExporter

protected final CsvIssueExporter csvIssueExporter

Constructor Detail

AbstractCsvSearchRequestView

public AbstractCsvSearchRequestView(ApplicationProperties applicationProperties,
                                    CsvIssueExporter csvIssueExporter)

Method Detail

writeHeaders

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

Description copied from class: AbstractSearchRequestView

By default we don't care about the user agent

Specified by:

writeHeaders in interface SearchRequestView

Overrides:

writeHeaders in class AbstractSearchRequestView

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

writeSearchResults

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

Description copied from interface: SearchRequestView

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

Specified by:

writeSearchResults in interface SearchRequestView

Specified by:

writeSearchResults in class AbstractSearchRequestView

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

getFieldsToBeExported

protected abstract List<Field> getFieldsToBeExported(SearchRequest searchRequest)

Get the fields that should be exported for this Csv export.

Parameters:

searchRequest - to do search on

Returns:

fields that will be exported for each issue.