Package org.xwiki.export.pdf.job

Class PDFExportJobStatus

java.lang.Object

org.xwiki.job.AbstractJobStatus<R>

org.xwiki.job.DefaultJobStatus<PDFExportJobRequest>

org.xwiki.export.pdf.job.PDFExportJobStatus

All Implemented Interfaces:

org.xwiki.job.event.status.CancelableJobStatus, org.xwiki.job.event.status.JobStatus

@Unstable
public class PDFExportJobStatus
extends org.xwiki.job.DefaultJobStatus<PDFExportJobRequest>

The status of the PDF export job.

Since:

14.4.2, 14.5

Version:

$Id: 3509d61cca736abb9cb9ddbc9957432038d9fd64 $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PDFExportJobStatus.DocumentRenderingResult	The result obtained by rendering a given document.

Nested classes/interfaces inherited from interface org.xwiki.job.event.status.JobStatus

org.xwiki.job.event.status.JobStatus.State

Constructor Summary

Constructors

Constructor	Description
PDFExportJobStatus(String jobType, PDFExportJobRequest request, org.xwiki.observation.ObservationManager observationManager, org.xwiki.logging.LoggerManager loggerManager)	Create a new PDF export job status.

Method Summary

Modifier and Type	Method	Description
List<PDFExportJobStatus.DocumentRenderingResult>	getDocumentRenderingResults()
TemporaryResourceReference	getPDFFileReference()
String	getRequiredSkinExtensions()
void	setRequiredSkinExtensions(String requiredSkinExtensions)	Sets the skin extensions required by the rendered documents.

Methods inherited from class org.xwiki.job.AbstractJobStatus

answered, ask, ask, cancel, getEndDate, getError, getJobType, getLog, getLog, getLoggerTail, getLogTail, getParentJobStatus, getProgress, getQuestion, getQuestionTimeLeft, getRequest, getStartDate, getState, ignoreLogs, isCancelable, isCanceled, isIsolated, isSerialized, isSubJob, setCancelable, setEndDate, setError, setIsolated, setLoggerTail, setStartDate, setState, startListening, stopListening

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFExportJobStatus

public PDFExportJobStatus(String jobType,
                          PDFExportJobRequest request,
                          org.xwiki.observation.ObservationManager observationManager,
                          org.xwiki.logging.LoggerManager loggerManager)

Create a new PDF export job status.

Parameters:

jobType - the job type

request - the request provided when the job was started

observationManager - the observation manager

loggerManager - the logger manager

Method Detail

getDocumentRenderingResults

public List<PDFExportJobStatus.DocumentRenderingResult> getDocumentRenderingResults()

Returns:

the result of rendering each document specified in the PDF export job request

getPDFFileReference

public TemporaryResourceReference getPDFFileReference()

Returns:

the reference of the generated temporary PDF file

getRequiredSkinExtensions

public String getRequiredSkinExtensions()

Returns:

the HTML that needs to be placed in the page head in order to pull the resources (JavaScript, CSS) that were asked during the rendering of the documents specified in the PDF export job request

setRequiredSkinExtensions

public void setRequiredSkinExtensions(String requiredSkinExtensions)

Sets the skin extensions required by the rendered documents.

Parameters:

requiredSkinExtensions - the HTML that needs to be placed in the page head in order to pull the skin extensions (JavaScript, CSS) required by the rendered documents