Package com.adobe.livecycle.formsservice.client
Classpublic class FormsServiceClient
InheritanceFormsServiceClient Inheritance Object

Enables the creation of a Java object that invokes operations that belong to the Forms service. Using this object, you can perform tasks such as rendering forms to client devices, (typically web browsers), in order to collect information from end users. After a form is rendered, the user can fill in the form and send information back to the Forms service by clicking a submit button located on the form. You can also use a FormsServiceClient object to process a submitted form. For information, see Rendering Forms.


Public Methods
 MethodDefined by
  
FormsServiceClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a FormsServiceClient object.
FormsServiceClient
  
void addDocument(Document oDoc, String displayName)
Adds a file attachment to the form design that is rendered.
FormsServiceClient
  
ArrayList getDocuments()
Returns a list of all file attachments that were attached to the form.
FormsServiceClient
  
FormsResult processFormSubmission(Document inRequestDoc, String environmentBuffer, String userAgent, RenderOptionsSpec processFormSubmissionOptionsSpec)
Processes the posted content from a client device (typically, a web browser) and returns the results.
FormsServiceClient
  
void removeDocument(String name)
Removes a file attachment from the form.
FormsServiceClient
  
FormsResult renderFormGuide(String formQuery, Document inDataDoc, PDFFormRenderSpec pdfFormRenderSpec, ActivityGuideRenderSpec activityGuideRenderSpec, URLSpec urlSpec)
Renders a form guide to a client device.
FormsServiceClient
  
FormsResult renderHTMLForm(String formQuery, TransformTo transformTo, Document inDataDoc, HTMLRenderSpec htmlRenderSpec, String userAgent, URLSpec urlSpec, Map attachments)
Renders an HTML form to a client device by retrieving the specified form design and transforming it to an HTML form as specified by the transformTo value.
FormsServiceClient
  
FormsResult renderPDFForm(String formQuery, Document inDataDoc, PDFFormRenderSpec pdfFormRenderSpec, URLSpec urlSpec, Map attachments)
Renders a PDF form to a client device by retrieving the specified form design and transforming it to a PDF form.
FormsServiceClient
  
FormsResult renderPDFFormWithUsageRights(String formQuery, Document inDataDoc, PDFFormRenderSpec pdfFormRenderSpec, ReaderExtensionSpec readerExtensionSpec, URLSpec urlSpec)
Renders a rights-enabled PDF form to a client device.
FormsServiceClient
Constructor Detail
FormsServiceClient()
public FormsServiceClient(ServiceClientFactory serviceClientFactory)

A constructor that creates a FormsServiceClient object.

Parameters
serviceClientFactory — A ServiceClientFactory object that contains connection properties. For information about setting connection properties, see Invoking LiveCycle Services.
Method Detail
addDocument()
public void addDocument(Document oDoc, String displayName)

Adds a file attachment to the form design that is rendered.

Parameters

oDoc — A com.adobe.idp.Document object that contains a file that is added as a file attachment.
 
displayName — The name of the file attachment. This value is used as the name of the link that is used to download this file attachment.

getDocuments() 
public ArrayList getDocuments()

Returns a list of all file attachments that were attached to the form. You can retrieve file attachments from the java.util.ArrayList object that is returned by this method. File attachments can be added by using the addDocument method.

Returns
A java.util.ArrayList object that contains file attachments.

See also

(Document, String)
processFormSubmission() 
public FormsResult processFormSubmission(Document inRequestDoc, String environmentBuffer, String userAgent, RenderOptionsSpec processFormSubmissionOptionsSpec)

Processes the posted content from a client device (typically, a web browser) and returns the results. The results are either contents that are written back to the client application or validated XML data. The getAction method, which belongs to the FormsResult, specifies the type of action that the Form service performed. For example, if the action indicates that the Form service is finished processing data, then the result is either validated XML data or PDF data. If the action is not complete, the results are returned to the client device. For example, if the Forms service performs a calculation on data values, the result is sent back to a web browser where it is displayed. If the content type of the data passed to this method is not a supported type, this method returns the data, including the unsupported content type, without processing it. For information about processing a submitted form, see Processing Submitted Forms.

Parameters

inRequestDoc — A com.adobe.idp.Document object that represents the posted content. From within a Java servlet, you can create a com.adobe.idp.Document object by invoking the HttpServletRequest object's getInputStream method: Document myDocument = new Document(req.getInputStream());
 
environmentBuffer — Specifies environment variables included all relevant HTTP headers. The following format is valid: HTTP_REFERER=referrer&HTTP_CONNECTION=keep-alive. If you want to set your own environment variables, you must assign values to these variables:
  • HTTP_USER_AGENT
  • CONTENT_TYPE
  • CONTENT_LENGTH In this situation, other environment variables, such as HTTP_CONNECTION, use default values. In addition to setting the required variables previously specified, you can override an environment variable's default value by assigning a new value. The CONTENT_TYPE variable accepts the following content types:
  • text/xml
  • application/xml
  • application/vnd.adobe.xdp
    		•
     
    userAgent — The HTTP header User-Agent that provides information about the target device (a target device is a client application, such as a web browser). This value takes precedence over what may exist in environment variables. The default value is Mozilla/3.*.
     
    processFormSubmissionOptionsSpec — A RenderOptionsSpec object that represents run-time options that are used when a form is processed. The following table lists run-time options that you can set for this method:
    Runtime optionMethod
    OutputTypesetOutputType()
    CharSetsetCharset()
    LocalesetLocale()
    XMLDatasetXMLData()
    CacheEnabledsetCacheEnabled()
    ValidationBordersetValidationBorder()
    ValidationReportingsetValidationReporting()
    ValidationUIsetValidationUI()
    PDFToXDPsetPDF2XDP()
    GetImageURLsetImageURL()
    ExportDataFormatsetExportDataFormat()
    XDCURIsetXDCURI()
    XCIsetXCI()
    XCIURIsetXCIURI()
    FontMapURIsetFontMapURI()

    Returns
    A FormsResult object containing the results of the form submission.

    Throws
    ProcessFormSubmissionException
     
    DSCException
    removeDocument() 
    public void removeDocument(String name)

    Removes a file attachment from the form.

    Parameters

    name — A string value that represents the file attachment to remove from the form.

    renderFormGuide() 
    public FormsResult renderFormGuide(String formQuery, Document inDataDoc, PDFFormRenderSpec pdfFormRenderSpec, ActivityGuideRenderSpec activityGuideRenderSpec, URLSpec urlSpec)

    Renders a form guide to a client device. Form guides are Adobe Flash-based representations of a form design that provide a more visually engaging and streamlined method for capturing data during form filling. This can help reduce data entry errors through improved usability by simplifying the amount of information presented to a user at a given time. The results are returned in a FormsResult object.

    Parameters

    formQuery — The name of the form design or PDF document to render. This parameter references a form design that is saved as either an XDP or a PDF file. The form design is typically created in Adobe LiveCycle Designer. For information, see the LiveCycle Designer Help.
     
    inDataDoc — A com.adobe.idp.Document object representing data to merge with the form design during rendering.
     
    pdfFormRenderSpec — A PDFFormRenderSpec object that represents run-time options that are used when rendering a PDF form.
     
    activityGuideRenderSpec — An ActivityGuideRenderSpec object that represents run-time options that are required to render a form guide.
     
    urlSpec — A URLSpec object that represents URI values that are required by the Forms service while rendering a form. This object defines URI values such as the location of the form design and the URI location to where form data is posted.

    Returns
    A FormsResult object containing the results of the request. Using this object, you can perform tasks, such as writing a data stream that represents the form, to a client web browser. For information, see Rendering Forms.
    renderHTMLForm() 
    public FormsResult renderHTMLForm(String formQuery, TransformTo transformTo, Document inDataDoc, HTMLRenderSpec htmlRenderSpec, String userAgent, URLSpec urlSpec, Map attachments)

    Renders an HTML form to a client device by retrieving the specified form design and transforming it to an HTML form as specified by the transformTo value. The results are returned in a FormsResult object.

    Parameters

    formQuery — The name of the form design to render. This parameter references a form design that is saved as an XDP. You cannot use a PDF file to render an HTML form. The form design is typically created in Adobe LiveCycle Designer. For information, see the LiveCycle Designer Help.
     
    transformTo — A TransformTo that specifies the type of HTML form to render. The following table lists valid HTML values:
    HTML valueDescription
    XHTMLCompatible accessibility enhanced browsers (currently Internet Explorer 5 or later). Compliant with XHTML 1.0.
    AUTOThe Forms service determines the best HTML transformation using the userAgent value.
    NoScriptXHTMLCompatible with the CSS2 specification. Compliant with XHTML 1.0. No scripts are associated with this transformation type.
    HTML4Compatible with older browsers that do not support absolute positioning of HTML elements.
    MSDHTMLDynamic HTML for Internet Explorer 5.0 or later.
    StaticHTMLProduces a non-interactive HTML form.
     
    inDataDoc — A com.adobe.idp.Document object representing data to merge with the form design during rendering.
     
    htmlRenderSpec — A HTMLRenderSpec object that represents run-time options that are used when rendering an HTML form.
     
    userAgent — The HTTP_USER_AGENT header that provides information about the target device. This parameter is used when formPreference is set to AUTO. The default is Mozilla/3.*.
     
    urlSpec — A URLSpec object that represents URI values that are required by the Forms service while rendering a form. This object defines URI values such as the location of the form design and the URI location to where form data is posted.
     
    attachments — A java.util.Map object that contains file attachments that are rendered with the form. This Map object requires a name-value pair where the name is a string value that represents the file name and the value is a com.adobe.idp.Document object that contains file data.

    Returns
    A FormsResult object containing the results of the request. Using this object, you can perform tasks, such as writing a data stream that represents the HTML form, to a client web browser. For information, see Rendering Forms.
    renderPDFForm() 
    public FormsResult renderPDFForm(String formQuery, Document inDataDoc, PDFFormRenderSpec pdfFormRenderSpec, URLSpec urlSpec, Map attachments)

    Renders a PDF form to a client device by retrieving the specified form design and transforming it to a PDF form. The results are returned in a FormsResult object.

    Parameters

    formQuery — The name of the form design or PDF document to render. This parameter references a form design that is saved as either an XDP or a PDF file. The form design is typically created in Adobe LiveCycle Designer. For information, see the LiveCycle Designer Help.
     
    inDataDoc — A com.adobe.idp.Document object representing data to merge with the form design during rendering.
     
    pdfFormRenderSpec — A PDFFormRenderSpec object that represents run-time options that are used when rendering a PDF form.
     
    urlSpec — A URLSpec object that represents URI values that are required by the Forms service while rendering a form. This object defines URI values such as the location of the form design and the URI location to where form data is posted.
     
    attachments — A java.util.Map object that contains file attachments that are rendered with the form. This Map object requires a name-value pair where the name is a string value that represents the file name and the value is a com.adobe.idp.Document object that contains file data.

    Returns
    A FormsResult object containing the results of the request. Using this object, you can perform tasks, such as writing a data stream that represents the form, to a client web browser. For information, see Rendering Forms.
    renderPDFFormWithUsageRights() 
    public FormsResult renderPDFFormWithUsageRights(String formQuery, Document inDataDoc, PDFFormRenderSpec pdfFormRenderSpec, ReaderExtensionSpec readerExtensionSpec, URLSpec urlSpec)

    Renders a rights-enabled PDF form to a client device. Usage rights pertain to functionality that is available by default in Acrobat but not in Adobe Reader, such as the ability to add comments to a form or to fill in form fields and save the form. A PDF form that has usage rights applied to it is called a rights-enabled form. The results are returned in a FormsResult object.

    Parameters

    formQuery — The name of the form design or PDF document to render. This parameter references a form design that is saved as either an XDP or a PDF file. The form design is typically created in Adobe LiveCycle Designer. For information, see the LiveCycle Designer Help.
     
    inDataDoc — A com.adobe.idp.Document object representing data to merge with the form design during rendering.
     
    pdfFormRenderSpec — A PDFFormRenderSpec object that represents run-time options that are used when rendering a PDF form.
     
    readerExtensionSpec — A ReaderExtensionSpec object that represents run-time options that are required to render a rights-enabled form.
     
    urlSpec — A URLSpec object that represents URI values that are required by the Forms service while rendering a form. This object defines URI values such as the location of the form design and the URI location to where form data is posted. requires a name-value pair where the name is a string value that represents the file name and the value is a com.adobe.idp.Document object that contains file data.

    Returns
    A FormsResult object containing the results of the request. Using this object, you can perform tasks, such as writing a data stream that represents the form, to a client web browser. For information, see Rendering Forms.



    © 2004-2006 Adobe Systems Incorporated. All rights reserved.
    Thu Sep 27 2007, 8:38 AM GMT-07:00

     

    Send me an e-mail when comments are added to this page | Comment Report

    Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/formsservice/client/FormsServiceClient.html