com.atlassian.jira.issue.views.util

Interface SearchRequestViewBodyWriterUtil

All Known Implementing Classes:

DefaultSearchRequestViewBodyWriterUtil

public interface SearchRequestViewBodyWriterUtil

Method Summary

Modifier and Type	Method and Description
List<Integer>	searchAndSort(SearchRequest searchRequest, PagerFilter pagerFilter) Iterates over the issues and applying them all them all to the issue collector.
long	searchCount(SearchRequest searchRequest) Returns the search count
void	writeBody(Writer writer, AbstractIssueView issueView, SearchRequest searchRequest, SingleIssueWriter singleIssueWriter, PagerFilter pagerFilter) Writes the body of a sinlge issue.
void	writeTableBody(Writer writer, IssueTableWriter issueTableWriter, SearchRequest searchRequest, PagerFilter pagerFilter) Writes the body of a single issue in a table view (i.e.: Printable or Excel).

Method Detail

writeBody

void writeBody(Writer writer,
               AbstractIssueView issueView,
               SearchRequest searchRequest,
               SingleIssueWriter singleIssueWriter,
               PagerFilter pagerFilter)
        throws IOException,
               SearchException

Writes the body of a sinlge issue. This is used mostly by the issue full content views. It allows the specific SearchRequestViews (i.e.: Excel, Word, etc) to provide a callback class implementing the SingleIssueWriter interface specifying how a single Issue should be written to the display. It uses the details provided by the AbstractIssueView to write the response.

Parameters:

writer - used to stream the response to.

issueView - contains the details of how a single issue should be written (i.e.: HTML for header, body and footer)

searchRequest - The original searchRequest that defines the issues to be viewed.

singleIssueWriter - Provides a callback method that is defined in the specific SearchRequestViews. It will be invoked to write the issue to the writer.

pagerFilter - Used to limit the number of issues being written.

Throws:

IOException - if things are seriously wrong

SearchException - if there is something wrong with the SearchRequest

writeTableBody

void writeTableBody(Writer writer,
                    IssueTableWriter issueTableWriter,
                    SearchRequest searchRequest,
                    PagerFilter pagerFilter)
             throws IOException,
                    SearchException

Writes the body of a single issue in a table view (i.e.: Printable or Excel). It allows the specific SearchRequestViews (i.e.: Excel, Word, etc) to provide a callback class implementing the IssueTableWriter interface specifying how a single Issue should be written to the display.

Parameters:

writer - used to stream the response to.

issueTableWriter - Defines how a single issue is displayed in a table view.

searchRequest - The original searchRequest that defines the issues to be viewed. be invoked to write the issue to the writer.

pagerFilter - Used to limit the number of issues being written.

Throws:

IOException - if things are seriously wrong

SearchException - if there is something wrong with the SearchRequest

searchAndSort

List<Integer> searchAndSort(SearchRequest searchRequest,
                            PagerFilter pagerFilter)
                     throws SearchException

Iterates over the issues and applying them all them all to the issue collector.

Parameters:

searchRequest - that defines the issues to be viewed.

pagerFilter - Used to limit the number of issues being written

Throws:

SearchException - if there is something wrong with the SearchRequest

searchCount

long searchCount(SearchRequest searchRequest)
          throws SearchException

Returns the search count

Parameters:

searchRequest - The original searchRequest that defines the issues to be viewed.

Returns:

the search count

Throws:

SearchException - if there is something wrong with the SearchRequest