org.mapfish.print.servlet.job

Class FailedPrintJob

java.lang.Object

org.mapfish.print.servlet.job.PrintJobStatus

org.mapfish.print.servlet.job.FailedPrintJob

public class FailedPrintJob
extends PrintJobStatus

Represents a failed print job.

Constructor Summary

Constructors

Constructor and Description
FailedPrintJob(java.lang.String referenceId, java.lang.String appId, java.util.Date startDate, java.util.Date completionDate, long requestCount, java.lang.String fileName, java.lang.String error, boolean cancelled, AccessAssertion access) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtraParameters(org.json.JSONObject metadata) Add extra information to the metadata object being put in the registry.
boolean	getCancelled()
java.lang.String	getError()
static FailedPrintJob	load(org.json.JSONObject metadata, java.lang.String referenceId, java.lang.String appId, java.util.Date startDate, java.util.Date completionDate, long requestCount, java.lang.String fileName, AccessAssertion reportAccess) Construct a new instance from the values provided.

Methods inherited from class org.mapfish.print.servlet.job.PrintJobStatus

assertAccess, getAccess, getAppId, getCompletionDate, getElapsedTime, getFileName, getReferenceId, getRequestCount, getStartDate, load, setCompletionDate, store

Methods inherited from class java.lang.Object

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

Constructor Detail

FailedPrintJob

public FailedPrintJob(java.lang.String referenceId,
              java.lang.String appId,
              java.util.Date startDate,
              java.util.Date completionDate,
              long requestCount,
              java.lang.String fileName,
              java.lang.String error,
              boolean cancelled,
              AccessAssertion access)

Constructor.

Parameters:

referenceId - reference of the report.

appId - the appId used for loading the configuration.

startDate - the date when the print job started

completionDate - the date when the print job completed

requestCount - the total number of requests made when the job was submitted.

fileName - the fileName to send to the client.

error - the error that occurred during running.

cancelled - if the job was cancelled.

access - the an access control object for downloading this report. Typically this is combined access of the template and the configuration.

Method Detail

addExtraParameters

protected final void addExtraParameters(org.json.JSONObject metadata)
                                 throws org.json.JSONException

Description copied from class: PrintJobStatus

Add extra information to the metadata object being put in the registry.

Specified by:

addExtraParameters in class PrintJobStatus

Parameters:

metadata - the json object that contains the metadata

Throws:

org.json.JSONException

load

public static FailedPrintJob load(org.json.JSONObject metadata,
                  java.lang.String referenceId,
                  java.lang.String appId,
                  java.util.Date startDate,
                  java.util.Date completionDate,
                  long requestCount,
                  java.lang.String fileName,
                  AccessAssertion reportAccess)
                           throws org.json.JSONException

Construct a new instance from the values provided.

Parameters:

metadata - the metadata retrieved from the registry. Only need it to get the extra information that is not stored by parent class.

referenceId - reference of the report.

appId - the appId used for loading the configuration.

startDate - the date when the print job started.

completionDate - the date when the print job completed.

requestCount - the total number of requests made when the job was submitted.

fileName - the fileName to send to the client.

reportAccess - the access/roles required to download this report. Typically this is all the roles in the template and the configuration.

Throws:

org.json.JSONException

getError

public final java.lang.String getError()

getCancelled

public final boolean getCancelled()