PDFExportJobStatus.DocumentRenderingResult (XWiki Platform - Export - PDF - API 14.8-rc-1 API)

java.lang.Object
- org.xwiki.export.pdf.job.PDFExportJobStatus.DocumentRenderingResult

Enclosing class:

PDFExportJobStatus
```
public static class PDFExportJobStatus.DocumentRenderingResult
extends Object
```
The result obtained by rendering a given document.

Version:

$Id: 3509d61cca736abb9cb9ddbc9957432038d9fd64 $

Constructor Summary

Constructors
Constructor	Description
`DocumentRenderingResult(org.xwiki.model.reference.DocumentReference documentReference, org.xwiki.rendering.block.XDOM xdom, String html)`	Create a new rendering result for the specified document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.xwiki.model.reference.DocumentReference`	`getDocumentReference()`
`String`	`getHTML()`
`org.xwiki.rendering.block.XDOM`	`getXDOM()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentRenderingResult
```
public DocumentRenderingResult(org.xwiki.model.reference.DocumentReference documentReference,
                               org.xwiki.rendering.block.XDOM xdom,
                               String html)
```
    Create a new rendering result for the specified document.
    
    Parameters:
    
    documentReference - the document that has been rendered
    
    xdom - the XDOM obtained by rendering the specified document
    
    html - the HTML obtained by rendering the specified document
- Method Detail
  - getDocumentReference
```
public org.xwiki.model.reference.DocumentReference getDocumentReference()
```
    Returns:
    
    the document that has been rendered
  - getXDOM
```
public org.xwiki.rendering.block.XDOM getXDOM()
```
    Returns:
    
    the XDOM obtained by rendering the specified document, after executing the rendering transformations; this is needed in order to generate the table of contents for the PDF export
  - getHTML
```
public String getHTML()
```
    Returns:
    
    the HTML obtained by rendering the specified document; the PDF sheet aggregates the HTML from all the exported documents in order to produce the PDF file