Package org.xwiki.export.pdf.script

Class PDFExportScriptService

java.lang.Object

org.xwiki.export.pdf.script.PDFExportScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Named("export.pdf")
@Singleton
@Unstable
public class PDFExportScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Scripting API to export documents as PDF.

Since:

14.4.2, 14.5

Version:

$Id: c6abf562ce3645c8fefefd494d01ce831267d900 $

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE_HINT	The role hint of this script service.

Constructor Summary

Constructors

Constructor	Description
PDFExportScriptService()

Method Summary

Modifier and Type	Method	Description
PDFExportJobRequest	createRequest()
org.xwiki.job.Job	execute(PDFExportJobRequest request)	Schedule the execution of the given PDF export request.
Exception	getLastError()	Get the error generated while performing the previously called action.

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_HINT

public static final String ROLE_HINT

The role hint of this script service.

See Also:

Constant Field Values

Constructor Detail

PDFExportScriptService

public PDFExportScriptService()

Method Detail

createRequest

public PDFExportJobRequest createRequest()

Returns:

a new PDF export request, initialized based on the current HTTP request

execute

public org.xwiki.job.Job execute(PDFExportJobRequest request)

Schedule the execution of the given PDF export request.

Parameters:

request - the PDF export request to execute

Returns:

the asynchronous background job that has been scheduled to execute the given PDF export request

getLastError

public Exception getLastError()

Get the error generated while performing the previously called action.

Returns:

an eventual exception or null if no exception was thrown