Package com.adobe.fd.forms.api

Interface FormsService

@ProviderType
public interface FormsService

Allows the creation of a Java object that invokes operations that belong to the Forms service. Which is used for following operations

• Render PDF Form from a form design (template)
• Export Data from a PDF Form or an XDP
• Import Data into PDF Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.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	Description
Document	exportData(Document pdfOrXdp, DataFormat dataFormat)	export data from a PDF Form or XDP
Document	importData(Document pdf, Document data)	Import data into a PDF Form
Document	renderPDFForm(Document pdfOrXdp, Document data, PDFFormRenderOptions pdfFormRenderOptions)	Renders PDF Form from XDP template created using Adobe LiveCycle Designer When a static PDF Form is rendered the returned document also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method
Document	renderPDFForm(java.lang.String urlOrfilename, Document data, PDFFormRenderOptions pdfFormRenderOptions)	Renders PDF Form from XDP template created using Adobe LiveCycle Designer When a static PDF Form is rendered the returned document also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method
ValidationResult	validate(Document template, Document data, ValidationOptions validationOptions)	Validate submitted data
ValidationResult	validate(java.lang.String template, Document data, ValidationOptions validationOptions)	Validate submitted data

Field Detail

PAGE_COUNT

static final java.lang.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

renderPDFForm

Document renderPDFForm(java.lang.String urlOrfilename,
                       Document data,
                       PDFFormRenderOptions pdfFormRenderOptions)
                throws FormsServiceException

Renders PDF Form from XDP template created using Adobe LiveCycle Designer When a static PDF Form is rendered the returned document also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method

Parameters:

urlOrfilename -

data -

pdfFormRenderOptions -

Returns:

Document

Throws:

FormsServiceException

renderPDFForm

Document renderPDFForm(Document pdfOrXdp,
                       Document data,
                       PDFFormRenderOptions pdfFormRenderOptions)
                throws FormsServiceException

Renders PDF Form from XDP template created using Adobe LiveCycle Designer When a static PDF Form is rendered the returned document also contains an attribute FormsService#PAGE_COUNT which contains number of pages rendered which can retrieved using Document#getAttribute method

Parameters:

pdfOrXdp -

data -

pdfFormRenderOptions -

Returns:

Document

Throws:

FormsServiceException

exportData

Document exportData(Document pdfOrXdp,
                    DataFormat dataFormat)
             throws FormsServiceException

export data from a PDF Form or XDP

Parameters:

pdfOrXdp -

dataFormat -

Returns:

Document object containing exported data xml

Throws:

FormsServiceException

importData

Document importData(Document pdf,
                    Document data)
             throws FormsServiceException

Import data into a PDF Form

Parameters:

pdf -

data -

Returns:

document containing PDF with imported data

Throws:

FormsServiceException

validate

ValidationResult validate(java.lang.String template,
                          Document data,
                          ValidationOptions validationOptions)
                   throws FormsServiceException

Validate submitted data

Parameters:

template - - URL or filename of the template

data - - Document object containing the data

validationOptions - - options for validation

Throws:

FormsServiceException

validate

ValidationResult validate(Document template,
                          Document data,
                          ValidationOptions validationOptions)
                   throws FormsServiceException

Validate submitted data

Parameters:

template - - Document object containing the template

data - - Document object containing the data

validationOptions - - options for validation

Throws:

FormsServiceException