org.mapfish.print.servlet

Interface HandleReportLoadResult<R>

Type Parameters:

R - The return value

public interface HandleReportLoadResult<R>

Called when a report is loaded to be sent to the user.

Method Summary

Methods

Modifier and Type	Method and Description
R	failedPrint(FailedPrintJob failedPrintJob, javax.servlet.http.HttpServletResponse httpServletResponse) Called when a print job failed.
R	printJobPending(javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String referenceId) Called when the print job has not yet completed.
R	successfulPrint(SuccessfulPrintJob successfulPrintResult, javax.servlet.http.HttpServletResponse httpServletResponse, java.net.URI reportURI, ReportLoader loader) Called when a print succeeded.
R	unknownReference(javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String referenceId) Called if the report reference is unknown.
R	unsupportedLoader(javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String referenceId) Called if no loader can be found for loading the report.

Method Detail

unknownReference

R unknownReference(javax.servlet.http.HttpServletResponse httpServletResponse,
                 java.lang.String referenceId)

Called if the report reference is unknown.

Parameters:

httpServletResponse - response object

referenceId - report id

unsupportedLoader

R unsupportedLoader(javax.servlet.http.HttpServletResponse httpServletResponse,
                  java.lang.String referenceId)

Called if no loader can be found for loading the report.

Parameters:

httpServletResponse - response object

referenceId - report id

successfulPrint

R successfulPrint(SuccessfulPrintJob successfulPrintResult,
                javax.servlet.http.HttpServletResponse httpServletResponse,
                java.net.URI reportURI,
                ReportLoader loader)
                  throws java.io.IOException,
                         javax.servlet.ServletException

Called when a print succeeded.

Parameters:

successfulPrintResult - the result

httpServletResponse - the http reponse

reportURI - the uri to the report

loader - the loader for loading the report.

Throws:

java.io.IOException

javax.servlet.ServletException

failedPrint

R failedPrint(FailedPrintJob failedPrintJob,
            javax.servlet.http.HttpServletResponse httpServletResponse)

Called when a print job failed.

Parameters:

failedPrintJob - the failed print job

httpServletResponse - the object for writing response

printJobPending

R printJobPending(javax.servlet.http.HttpServletResponse httpServletResponse,
                java.lang.String referenceId)

Called when the print job has not yet completed.

Parameters:

httpServletResponse - the object for writing response

referenceId - report id