com.adobe.livecycle.output.client
Class OutputResult

java.lang.Object
  com.adobe.livecycle.output.client.OutputResult

All Implemented Interfaces:

java.io.Serializable

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

Contains the results of the OutputClient object's generatePDFOutput, generatePDFOutput2, generatePrintedOutput, and generatePrintedOutput2 methods. Using this object, you can perform tasks such as getting the status of the specific Output service operation or obtain the generated document. For example, after generating a PDF document by invoking the generatePDFOutput method, you can get the PDF document by invoking the OutputResult.getGeneratedDoc() method that belongs to this class.

To see an object of this type used in a code example, see the Creating multiple PDF files using the Java API quick start in Programming with LiveCycle ES4.

See Also:

generatePDFOutput(), generatePrintedOutput(), Serialized Form

Constructor Summary

OutputResult(Document generatedDoc, Document statusDoc, Document metaDataDoc, java.util.List RecordLevelMetaDataList)
For internal use use only.

Method Summary

Document	getGeneratedDoc() Returns the newly generated document that was created by the OutputClient object's generatePDFOutput, generatePDFOutput2, generatePrintedOutput, and generatePrintedOutput2 methods.
Document	getMetaDataDoc() Returns metadata that belongs to the document that was created.
java.util.List	getRecordLevelMetaDataList() Returns a list of record metadata that belongs to the data used to populate the document.
Document	getStatusDoc() Returns the status of the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputResult

public OutputResult(Document generatedDoc,
                    Document statusDoc,
                    Document metaDataDoc,
                    java.util.List RecordLevelMetaDataList)

For internal use use only. Use the return value of the generatePDFOutput() or generatePrintedOutput() methods.

Method Detail

getMetaDataDoc

public Document getMetaDataDoc()

Returns metadata that belongs to the document that was created.

Returns:

A Document object that contains metadata that belongs to the newly generated document.

getGeneratedDoc

public Document getGeneratedDoc()

Returns the newly generated document that was created by the OutputClient object's generatePDFOutput, generatePDFOutput2, generatePrintedOutput, and generatePrintedOutput2 methods. To see this method in a code example, see the Sending a print stream to a network printer using the Java API quick start in Programming with LiveCycle ES4.

Returns:

A Document object that contains the newly generated document.

See Also:

generatePrintedOutput()

getRecordLevelMetaDataList

public java.util.List getRecordLevelMetaDataList()

Returns a list of record metadata that belongs to the data used to populate the document.

Returns:

A java.util.List object that contains record metadata.

getStatusDoc

public Document getStatusDoc()

Returns the status of the operation. If an error occurs, the error message is stored in the returned Document object. To see this method in a code example, see the Creating a PDF document using the Java API quick start in Programming with LiveCycle ES4.

Returns:

A Document object that contains the status of the operation.