Package net.webpdf.wsclient.schema.operation

Class SubmitFormActionType

  • public class SubmitFormActionType
extends ActionEventType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">When activated, the submitForm action will send the names and values of all selected form fields to the specified URL (Uniform Resource Locator). You can use the "field" element as many times as necessary.</p>

    Java class for SubmitFormActionType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="SubmitFormActionType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}ActionEventType">
       <choice maxOccurs="unbounded">
         <element name="field" type="{http://schema.webpdf.de/1.0/operation}FormFieldSelectionType"/>
       </choice>
       <attribute name="url" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="exclude" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="includeNoValueFields" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="exportFormat" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="getMethod" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="submitCoordinates" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="xfdf" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="includeAppendSaves" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="includeAnnotations" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="submitPDF" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="canonicalFormat" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="excludeNonUserAnnotations" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="excludeFDFSourceOrTargetFile" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="embedForm" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • url

        protected String url
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The URL to which the data should be transmitted.</p>

      • exclude

        protected Boolean exclude
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, then all form fields except the selected ones should be exported. If false, only the selected ones will be.</p>

      • includeNoValueFields

        protected Boolean includeNoValueFields
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, form fields that have not yet been filled out / that do not contain a value will be exported as well.</p>

      • exportFormat

        protected Boolean exportFormat
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "submitPDF" and "xfdf" are not set. If this value is set to true, the data will be exported as an HTML form; otherwise, it will be exported in fdf (Forms Data Format) format.</p>

      • getMethod

        protected Boolean getMethod
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "exportFormat" is set and used. In this case, this value determines whether the names and values will be transmitted with GET (true) or HTTP POST (false) requests.</p>

      • submitCoordinates

        protected Boolean submitCoordinates
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "exportFormat" is set and used. In this case, this value determines whether the position of the mouse click that triggered the export should also be part of the export.</p>

      • xfdf

        protected Boolean xfdf
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "submitPDF" is not set. In this case, this value determines whether the data should be transmitted in XFDF format.</p>

      • includeAppendSaves

        protected Boolean includeAppendSaves
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the transmitted data will reproduce all incremental changes in the form data.</p>

      • includeAnnotations

        protected Boolean includeAnnotations
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the set mark-up annotations should be included in the transmitted data.</p>

      • submitPDF

        protected Boolean submitPDF
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the data will be transmitted as a PDF file.</p>

      • canonicalFormat

        protected Boolean canonicalFormat
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, all dates and times will be transmitted in a canonical standard format whenever possible.</p>

      • excludeNonUserAnnotations

        protected Boolean excludeNonUserAnnotations
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format and "includeAnnotations" is set. In this case, this value determines whether the transmitted data should exclusively contain the annotations set by the user filling out the information (true) or whether it should contain all annotations instead (false).</p>

      • excludeFDFSourceOrTargetFile

        protected Boolean excludeFDFSourceOrTargetFile
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the URL to which the data is being transmitted should be included in the export.</p>

      • embedForm

        protected Boolean embedForm
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the PDF file that contains the form should be integrated into the transmitted data.</p>

    • Constructor Detail

      • SubmitFormActionType

        public SubmitFormActionType()

    • Method Detail

      • getField

        public List<FormFieldSelectionType> getField()
        Gets the value of the field property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the field property.

        For example, to add a new item, do as follows: 

         getField().add(newItem);

        Objects of the following type(s) are allowed in the list FormFieldSelectionType

        Returns:
        The value of the field property.

      • isSetField

        public boolean isSetField()

      • unsetField

        public void unsetField()

      • getUrl

        public String getUrl()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The URL to which the data should be transmitted.</p>
        Returns:
        possible object is String

      • setUrl

        public void setUrl​(String value)
        Sets the value of the url property.
        Parameters:
        value - allowed object is String
        See Also:
        getUrl()

      • isSetUrl

        public boolean isSetUrl()

      • isExclude

        public boolean isExclude()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, then all form fields except the selected ones should be exported. If false, only the selected ones will be.</p>
        Returns:
        possible object is Boolean

      • setExclude

        public void setExclude​(boolean value)
        Sets the value of the exclude property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isExclude()

      • isSetExclude

        public boolean isSetExclude()

      • unsetExclude

        public void unsetExclude()

      • isIncludeNoValueFields

        public boolean isIncludeNoValueFields()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, form fields that have not yet been filled out / that do not contain a value will be exported as well.</p>
        Returns:
        possible object is Boolean

      • setIncludeNoValueFields

        public void setIncludeNoValueFields​(boolean value)
        Sets the value of the includeNoValueFields property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isIncludeNoValueFields()

      • isSetIncludeNoValueFields

        public boolean isSetIncludeNoValueFields()

      • unsetIncludeNoValueFields

        public void unsetIncludeNoValueFields()

      • isExportFormat

        public boolean isExportFormat()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "submitPDF" and "xfdf" are not set. If this value is set to true, the data will be exported as an HTML form; otherwise, it will be exported in fdf (Forms Data Format) format.</p>
        Returns:
        possible object is Boolean

      • setExportFormat

        public void setExportFormat​(boolean value)
        Sets the value of the exportFormat property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isExportFormat()

      • isSetExportFormat

        public boolean isSetExportFormat()

      • unsetExportFormat

        public void unsetExportFormat()

      • isGetMethod

        public boolean isGetMethod()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "exportFormat" is set and used. In this case, this value determines whether the names and values will be transmitted with GET (true) or HTTP POST (false) requests.</p>
        Returns:
        possible object is Boolean

      • setGetMethod

        public void setGetMethod​(boolean value)
        Sets the value of the getMethod property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isGetMethod()

      • isSetGetMethod

        public boolean isSetGetMethod()

      • unsetGetMethod

        public void unsetGetMethod()

      • isSubmitCoordinates

        public boolean isSubmitCoordinates()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "exportFormat" is set and used. In this case, this value determines whether the position of the mouse click that triggered the export should also be part of the export.</p>
        Returns:
        possible object is Boolean

      • setSubmitCoordinates

        public void setSubmitCoordinates​(boolean value)
        Sets the value of the submitCoordinates property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isSubmitCoordinates()

      • isSetSubmitCoordinates

        public boolean isSetSubmitCoordinates()

      • unsetSubmitCoordinates

        public void unsetSubmitCoordinates()

      • isXfdf

        public boolean isXfdf()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if "submitPDF" is not set. In this case, this value determines whether the data should be transmitted in XFDF format.</p>
        Returns:
        possible object is Boolean

      • setXfdf

        public void setXfdf​(boolean value)
        Sets the value of the xfdf property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isXfdf()

      • isSetXfdf

        public boolean isSetXfdf()

      • unsetXfdf

        public void unsetXfdf()

      • isIncludeAppendSaves

        public boolean isIncludeAppendSaves()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the transmitted data will reproduce all incremental changes in the form data.</p>
        Returns:
        possible object is Boolean

      • setIncludeAppendSaves

        public void setIncludeAppendSaves​(boolean value)
        Sets the value of the includeAppendSaves property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isIncludeAppendSaves()

      • isSetIncludeAppendSaves

        public boolean isSetIncludeAppendSaves()

      • unsetIncludeAppendSaves

        public void unsetIncludeAppendSaves()

      • isIncludeAnnotations

        public boolean isIncludeAnnotations()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the set mark-up annotations should be included in the transmitted data.</p>
        Returns:
        possible object is Boolean

      • setIncludeAnnotations

        public void setIncludeAnnotations​(boolean value)
        Sets the value of the includeAnnotations property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isIncludeAnnotations()

      • isSetIncludeAnnotations

        public boolean isSetIncludeAnnotations()

      • unsetIncludeAnnotations

        public void unsetIncludeAnnotations()

      • isSubmitPDF

        public boolean isSubmitPDF()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the data will be transmitted as a PDF file.</p>
        Returns:
        possible object is Boolean

      • setSubmitPDF

        public void setSubmitPDF​(boolean value)
        Sets the value of the submitPDF property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isSubmitPDF()

      • isSetSubmitPDF

        public boolean isSetSubmitPDF()

      • unsetSubmitPDF

        public void unsetSubmitPDF()

      • isCanonicalFormat

        public boolean isCanonicalFormat()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, all dates and times will be transmitted in a canonical standard format whenever possible.</p>
        Returns:
        possible object is Boolean

      • setCanonicalFormat

        public void setCanonicalFormat​(boolean value)
        Sets the value of the canonicalFormat property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isCanonicalFormat()

      • isSetCanonicalFormat

        public boolean isSetCanonicalFormat()

      • unsetCanonicalFormat

        public void unsetCanonicalFormat()

      • isExcludeNonUserAnnotations

        public boolean isExcludeNonUserAnnotations()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format and "includeAnnotations" is set. In this case, this value determines whether the transmitted data should exclusively contain the annotations set by the user filling out the information (true) or whether it should contain all annotations instead (false).</p>
        Returns:
        possible object is Boolean

      • setExcludeNonUserAnnotations

        public void setExcludeNonUserAnnotations​(boolean value)
        Sets the value of the excludeNonUserAnnotations property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isExcludeNonUserAnnotations()

      • isSetExcludeNonUserAnnotations

        public boolean isSetExcludeNonUserAnnotations()

      • unsetExcludeNonUserAnnotations

        public void unsetExcludeNonUserAnnotations()

      • isExcludeFDFSourceOrTargetFile

        public boolean isExcludeFDFSourceOrTargetFile()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the URL to which the data is being transmitted should be included in the export.</p>
        Returns:
        possible object is Boolean

      • setExcludeFDFSourceOrTargetFile

        public void setExcludeFDFSourceOrTargetFile​(boolean value)
        Sets the value of the excludeFDFSourceOrTargetFile property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isExcludeFDFSourceOrTargetFile()

      • isSetExcludeFDFSourceOrTargetFile

        public boolean isSetExcludeFDFSourceOrTargetFile()

      • unsetExcludeFDFSourceOrTargetFile

        public void unsetExcludeFDFSourceOrTargetFile()

      • isEmbedForm

        public boolean isEmbedForm()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This value is only relevant if the data should be transmitted in FDF format. In this case, this value determines whether the PDF file that contains the form should be integrated into the transmitted data.</p>
        Returns:
        possible object is Boolean

      • setEmbedForm

        public void setEmbedForm​(boolean value)
        Sets the value of the embedForm property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isEmbedForm()

      • isSetEmbedForm

        public boolean isSetEmbedForm()

      • unsetEmbedForm

        public void unsetEmbedForm()