com.adobe.fd.output.api

Interface OutputService

public interface OutputService

Allows the creation of a Java object that invokes operations that belong to the Output service. Using this object, you can create documents using a form design and data to merge with the form design. For example, you can reference an existing form design and generate a print documents, such as one of the following formats:

• A PDF document.
• An Adobe PostScript Document
• A Printer Control Language (PCL) document.
• A Zebra Programming Language (ZPL) document.

For a complete list of print formats, see the RenderType enumeration value.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE_COUNT Key to be used for retrieving page count from rendered document object using Document#getAttribute method

Method Summary

Modifier and Type	Method and Description
Document	generatePDFOutput(Document inDoc, Document data, PDFOutputOptions pdfOutputOptions) Generates a PDF Document given a template and data to merge The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method
Document	generatePDFOutput(String urlOrFileName, Document data, PDFOutputOptions pdfOutputOptions) Generates a PDF Document given a template and data to merge The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method
BatchResult	generatePDFOutputBatch(Map<String,String> templates, Map<String,Document> data, PDFOutputOptions pdfOutputOptions, BatchOptions batchOptions) Generates a set of PDF Document given a set of template and data to merge
Document	generatePrintedOutput(Document inDoc, Document data, PrintedOutputOptions printedOutputOptions) create a PS/PCL/ZPL document from input xdp or pdf document The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method
Document	generatePrintedOutput(String urlOrFileName, Document data, PrintedOutputOptions printedOutputOptions) create a PS/PCL/ZPL document from input xdp or pdf document The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method
BatchResult	generatePrintedOutputBatch(Map<String,String> templates, Map<String,Document> data, PrintedOutputOptions printedOutputOptions, BatchOptions batchOptions) create PS/PCL/ZPL from a collection of templates and data

Field Detail

PAGE_COUNT

static final String PAGE_COUNT

Key to be used for retrieving page count from rendered document object using Document#getAttribute method

See Also:

Constant Field Values

Method Detail

generatePDFOutput

Document generatePDFOutput(Document inDoc,
                           Document data,
                           PDFOutputOptions pdfOutputOptions)
                    throws OutputServiceException

Generates a PDF Document given a template and data to merge The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method

Parameters:

inDoc - template on which generated pdf document is based. it is created in Adobe LiveCycle Designer it can be and XDP document or a PDF document

data - data xml to be merged with the template

pdfOutputOptions - options to configure the operation

Returns:

Document object containing PDF

Throws:

OutputServiceException

generatePDFOutput

Document generatePDFOutput(String urlOrFileName,
                           Document data,
                           PDFOutputOptions pdfOutputOptions)
                    throws OutputServiceException

Generates a PDF Document given a template and data to merge The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method

Parameters:

urlOrFileName - name or url of template on which generated pdf document is based. it is created in Adobe LiveCycle Designer it can be and XDP document or a PDF document

data - data xml to be merged with the template

pdfOutputOptions - options to configure the operation

Returns:

Document object containing PDF

Throws:

OutputServiceException

generatePDFOutputBatch

BatchResult generatePDFOutputBatch(Map<String,String> templates,
                                   Map<String,Document> data,
                                   PDFOutputOptions pdfOutputOptions,
                                   BatchOptions batchOptions)
                            throws OutputServiceException

Generates a set of PDF Document given a set of template and data to merge

Parameters:

templates - set of names templates, identified by a key

data - set of data documents, identified by key

pdfOutputOptions - options to configure pdf generation

batchOptions - options to configure batch

Returns:

BatchResult instance containg result of the operation

Throws:

OutputServiceException

generatePrintedOutput

Document generatePrintedOutput(Document inDoc,
                               Document data,
                               PrintedOutputOptions printedOutputOptions)
                        throws OutputServiceException

create a PS/PCL/ZPL document from input xdp or pdf document The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method

Parameters:

inDoc -

data -

printedOutputOptions -

Returns:

Document object containing generated print document

Throws:

OutputServiceException

generatePrintedOutput

Document generatePrintedOutput(String urlOrFileName,
                               Document data,
                               PrintedOutputOptions printedOutputOptions)
                        throws OutputServiceException

create a PS/PCL/ZPL document from input xdp or pdf document The returned document object also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method

Parameters:

urlOrFileName -

data -

printedOutputOptions -

Returns:

Document object containing generated print document

Throws:

OutputServiceException

generatePrintedOutputBatch

BatchResult generatePrintedOutputBatch(Map<String,String> templates,
                                       Map<String,Document> data,
                                       PrintedOutputOptions printedOutputOptions,
                                       BatchOptions batchOptions)
                                throws OutputServiceException

create PS/PCL/ZPL from a collection of templates and data

Parameters:

templates -

data -

printedOutputOptions -

Returns:

BatchResult instance containing result of batch operation

Throws:

OutputServiceException