com.adobe.livecycle.generatepdf.client
Class CreatePDFResult

java.lang.Object
  com.adobe.livecycle.generatepdf.client.CreatePDFResult

All Implemented Interfaces:

java.io.Serializable

public class CreatePDFResult
extends java.lang.Object
implements java.io.Serializable

Provides methods for getting the PDF document and log that is created by some of the methods in this package.

See Also:

Serialized Form

Constructor Summary

CreatePDFResult()
The default constructor.

Method Summary

Document	getCreatedDocument() Returns the Document object containing the result of the operation to create a PDF document, or null if no result has been generated.
Document	getLogDocument() Returns the Document object containing the logs generated while converting a PostScript file.
void	setCreatedDocument(Document createdDocument) For internal use only.
void	setLogDocument(Document logDocument) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreatePDFResult

public CreatePDFResult()

The default constructor.

Method Detail

getCreatedDocument

public Document getCreatedDocument()

Returns the Document object containing the result of the operation to create a PDF document, or null if no result has been generated.

Returns:

The Document object containing the PDF document that has been created.

getLogDocument

public Document getLogDocument()

Returns the Document object containing the logs generated while converting a PostScript file. It returns null if no logs have been generated.

The log file is a plain text file which contains the output from the Distiller service. The log file is not generated under all circumstances. The presence of a log file does not necessarily point to an error in the conversion, since a log file might contain diagnostic messages only.

Returns:

Any logs that may have been generated during conversion.

setCreatedDocument

public void setCreatedDocument(Document createdDocument)

For internal use only. Do not use.

Sets the Document object containing the result of the operation to create a PDF document.

Parameters:

createdDocument - The Document object containing the PDF document that has been created.

setLogDocument

public void setLogDocument(Document logDocument)

For internal use only. Do not use.

Sets the Document object containing the logs generated while converting a PostScript file.

Parameters:

logDocument - The Document containing the logs that have been created.