SubmitFormActionType (webPDF - Web service client library 2.0.1 API)

java.lang.Object
- net.webpdf.wsclient.schema.operation.ActionEventType
- - net.webpdf.wsclient.schema.operation.SubmitFormActionType

public class SubmitFormActionType
extends ActionEventType

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 Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`canonicalFormat`
`protected Boolean`	`embedForm`
`protected Boolean`	`exclude`
`protected Boolean`	`excludeFDFSourceOrTargetFile`
`protected Boolean`	`excludeNonUserAnnotations`
`protected Boolean`	`exportFormat`
`protected List<FormFieldSelectionType>`	`field`
`protected Boolean`	`getMethod`
`protected Boolean`	`includeAnnotations`
`protected Boolean`	`includeAppendSaves`
`protected Boolean`	`includeNoValueFields`
`protected Boolean`	`submitCoordinates`
`protected Boolean`	`submitPDF`
`protected String`	`url`
`protected Boolean`	`xfdf`

Constructor Summary

Constructors
Constructor and Description

SubmitFormActionType()

Constructors
Constructor and Description
`SubmitFormActionType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<FormFieldSelectionType>`	`getField()` Gets the value of the field property.
`String`	`getUrl()` Gets the value of the url property.
`boolean`	`isCanonicalFormat()` Gets the value of the canonicalFormat property.
`boolean`	`isEmbedForm()` Gets the value of the embedForm property.
`boolean`	`isExclude()` Gets the value of the exclude property.
`boolean`	`isExcludeFDFSourceOrTargetFile()` Gets the value of the excludeFDFSourceOrTargetFile property.
`boolean`	`isExcludeNonUserAnnotations()` Gets the value of the excludeNonUserAnnotations property.
`boolean`	`isExportFormat()` Gets the value of the exportFormat property.
`boolean`	`isGetMethod()` Gets the value of the getMethod property.
`boolean`	`isIncludeAnnotations()` Gets the value of the includeAnnotations property.
`boolean`	`isIncludeAppendSaves()` Gets the value of the includeAppendSaves property.
`boolean`	`isIncludeNoValueFields()` Gets the value of the includeNoValueFields property.
`boolean`	`isSetCanonicalFormat()`
`boolean`	`isSetEmbedForm()`
`boolean`	`isSetExclude()`
`boolean`	`isSetExcludeFDFSourceOrTargetFile()`
`boolean`	`isSetExcludeNonUserAnnotations()`
`boolean`	`isSetExportFormat()`
`boolean`	`isSetField()`
`boolean`	`isSetGetMethod()`
`boolean`	`isSetIncludeAnnotations()`
`boolean`	`isSetIncludeAppendSaves()`
`boolean`	`isSetIncludeNoValueFields()`
`boolean`	`isSetSubmitCoordinates()`
`boolean`	`isSetSubmitPDF()`
`boolean`	`isSetUrl()`
`boolean`	`isSetXfdf()`
`boolean`	`isSubmitCoordinates()` Gets the value of the submitCoordinates property.
`boolean`	`isSubmitPDF()` Gets the value of the submitPDF property.
`boolean`	`isXfdf()` Gets the value of the xfdf property.
`void`	`setCanonicalFormat(boolean value)` Sets the value of the canonicalFormat property.
`void`	`setEmbedForm(boolean value)` Sets the value of the embedForm property.
`void`	`setExclude(boolean value)` Sets the value of the exclude property.
`void`	`setExcludeFDFSourceOrTargetFile(boolean value)` Sets the value of the excludeFDFSourceOrTargetFile property.
`void`	`setExcludeNonUserAnnotations(boolean value)` Sets the value of the excludeNonUserAnnotations property.
`void`	`setExportFormat(boolean value)` Sets the value of the exportFormat property.
`void`	`setGetMethod(boolean value)` Sets the value of the getMethod property.
`void`	`setIncludeAnnotations(boolean value)` Sets the value of the includeAnnotations property.
`void`	`setIncludeAppendSaves(boolean value)` Sets the value of the includeAppendSaves property.
`void`	`setIncludeNoValueFields(boolean value)` Sets the value of the includeNoValueFields property.
`void`	`setSubmitCoordinates(boolean value)` Sets the value of the submitCoordinates property.
`void`	`setSubmitPDF(boolean value)` Sets the value of the submitPDF property.
`void`	`setUrl(String value)` Sets the value of the url property.
`void`	`setXfdf(boolean value)` Sets the value of the xfdf property.
`void`	`unsetCanonicalFormat()`
`void`	`unsetEmbedForm()`
`void`	`unsetExclude()`
`void`	`unsetExcludeFDFSourceOrTargetFile()`
`void`	`unsetExcludeNonUserAnnotations()`
`void`	`unsetExportFormat()`
`void`	`unsetField()`
`void`	`unsetGetMethod()`
`void`	`unsetIncludeAnnotations()`
`void`	`unsetIncludeAppendSaves()`
`void`	`unsetIncludeNoValueFields()`
`void`	`unsetSubmitCoordinates()`
`void`	`unsetSubmitPDF()`
`void`	`unsetXfdf()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - field
```
protected List<FormFieldSelectionType> field
```
  - url
```
protected String url
```
  - exclude
```
protected Boolean exclude
```
  - includeNoValueFields
```
protected Boolean includeNoValueFields
```
  - exportFormat
```
protected Boolean exportFormat
```
  - getMethod
```
protected Boolean getMethod
```
  - submitCoordinates
```
protected Boolean submitCoordinates
```
  - xfdf
```
protected Boolean xfdf
```
  - includeAppendSaves
```
protected Boolean includeAppendSaves
```
  - includeAnnotations
```
protected Boolean includeAnnotations
```
  - submitPDF
```
protected Boolean submitPDF
```
  - canonicalFormat
```
protected Boolean canonicalFormat
```
  - excludeNonUserAnnotations
```
protected Boolean excludeNonUserAnnotations
```
  - excludeFDFSourceOrTargetFile
```
protected Boolean excludeFDFSourceOrTargetFile
```
  - embedForm
```
protected Boolean embedForm
```
- 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
  - isSetField
```
public boolean isSetField()
```
  - unsetField
```
public void unsetField()
```
  - getUrl
```
public String getUrl()
```
    Gets the value of the url property.
    
    Returns:
    
    possible object is String
  - setUrl
```
public void setUrl(String value)
```
    Sets the value of the url property.
    
    Parameters:
    
    value - allowed object is String
  - isSetUrl
```
public boolean isSetUrl()
```
  - isExclude
```
public boolean isExclude()
```
    Gets the value of the exclude property.
    
    Returns:
    
    possible object is Boolean
  - setExclude
```
public void setExclude(boolean value)
```
    Sets the value of the exclude property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetExclude
```
public boolean isSetExclude()
```
  - unsetExclude
```
public void unsetExclude()
```
  - isIncludeNoValueFields
```
public boolean isIncludeNoValueFields()
```
    Gets the value of the includeNoValueFields property.
    
    Returns:
    
    possible object is Boolean
  - setIncludeNoValueFields
```
public void setIncludeNoValueFields(boolean value)
```
    Sets the value of the includeNoValueFields property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetIncludeNoValueFields
```
public boolean isSetIncludeNoValueFields()
```
  - unsetIncludeNoValueFields
```
public void unsetIncludeNoValueFields()
```
  - isExportFormat
```
public boolean isExportFormat()
```
    Gets the value of the exportFormat property.
    
    Returns:
    
    possible object is Boolean
  - setExportFormat
```
public void setExportFormat(boolean value)
```
    Sets the value of the exportFormat property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetExportFormat
```
public boolean isSetExportFormat()
```
  - unsetExportFormat
```
public void unsetExportFormat()
```
  - isGetMethod
```
public boolean isGetMethod()
```
    Gets the value of the getMethod property.
    
    Returns:
    
    possible object is Boolean
  - setGetMethod
```
public void setGetMethod(boolean value)
```
    Sets the value of the getMethod property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetGetMethod
```
public boolean isSetGetMethod()
```
  - unsetGetMethod
```
public void unsetGetMethod()
```
  - isSubmitCoordinates
```
public boolean isSubmitCoordinates()
```
    Gets the value of the submitCoordinates property.
    
    Returns:
    
    possible object is Boolean
  - setSubmitCoordinates
```
public void setSubmitCoordinates(boolean value)
```
    Sets the value of the submitCoordinates property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetSubmitCoordinates
```
public boolean isSetSubmitCoordinates()
```
  - unsetSubmitCoordinates
```
public void unsetSubmitCoordinates()
```
  - isXfdf
```
public boolean isXfdf()
```
    Gets the value of the xfdf property.
    
    Returns:
    
    possible object is Boolean
  - setXfdf
```
public void setXfdf(boolean value)
```
    Sets the value of the xfdf property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetXfdf
```
public boolean isSetXfdf()
```
  - unsetXfdf
```
public void unsetXfdf()
```
  - isIncludeAppendSaves
```
public boolean isIncludeAppendSaves()
```
    Gets the value of the includeAppendSaves property.
    
    Returns:
    
    possible object is Boolean
  - setIncludeAppendSaves
```
public void setIncludeAppendSaves(boolean value)
```
    Sets the value of the includeAppendSaves property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetIncludeAppendSaves
```
public boolean isSetIncludeAppendSaves()
```
  - unsetIncludeAppendSaves
```
public void unsetIncludeAppendSaves()
```
  - isIncludeAnnotations
```
public boolean isIncludeAnnotations()
```
    Gets the value of the includeAnnotations property.
    
    Returns:
    
    possible object is Boolean
  - setIncludeAnnotations
```
public void setIncludeAnnotations(boolean value)
```
    Sets the value of the includeAnnotations property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetIncludeAnnotations
```
public boolean isSetIncludeAnnotations()
```
  - unsetIncludeAnnotations
```
public void unsetIncludeAnnotations()
```
  - isSubmitPDF
```
public boolean isSubmitPDF()
```
    Gets the value of the submitPDF property.
    
    Returns:
    
    possible object is Boolean
  - setSubmitPDF
```
public void setSubmitPDF(boolean value)
```
    Sets the value of the submitPDF property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetSubmitPDF
```
public boolean isSetSubmitPDF()
```
  - unsetSubmitPDF
```
public void unsetSubmitPDF()
```
  - isCanonicalFormat
```
public boolean isCanonicalFormat()
```
    Gets the value of the canonicalFormat property.
    
    Returns:
    
    possible object is Boolean
  - setCanonicalFormat
```
public void setCanonicalFormat(boolean value)
```
    Sets the value of the canonicalFormat property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetCanonicalFormat
```
public boolean isSetCanonicalFormat()
```
  - unsetCanonicalFormat
```
public void unsetCanonicalFormat()
```
  - isExcludeNonUserAnnotations
```
public boolean isExcludeNonUserAnnotations()
```
    Gets the value of the excludeNonUserAnnotations property.
    
    Returns:
    
    possible object is Boolean
  - setExcludeNonUserAnnotations
```
public void setExcludeNonUserAnnotations(boolean value)
```
    Sets the value of the excludeNonUserAnnotations property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetExcludeNonUserAnnotations
```
public boolean isSetExcludeNonUserAnnotations()
```
  - unsetExcludeNonUserAnnotations
```
public void unsetExcludeNonUserAnnotations()
```
  - isExcludeFDFSourceOrTargetFile
```
public boolean isExcludeFDFSourceOrTargetFile()
```
    Gets the value of the excludeFDFSourceOrTargetFile property.
    
    Returns:
    
    possible object is Boolean
  - setExcludeFDFSourceOrTargetFile
```
public void setExcludeFDFSourceOrTargetFile(boolean value)
```
    Sets the value of the excludeFDFSourceOrTargetFile property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetExcludeFDFSourceOrTargetFile
```
public boolean isSetExcludeFDFSourceOrTargetFile()
```
  - unsetExcludeFDFSourceOrTargetFile
```
public void unsetExcludeFDFSourceOrTargetFile()
```
  - isEmbedForm
```
public boolean isEmbedForm()
```
    Gets the value of the embedForm property.
    
    Returns:
    
    possible object is Boolean
  - setEmbedForm
```
public void setEmbedForm(boolean value)
```
    Sets the value of the embedForm property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSetEmbedForm
```
public boolean isSetEmbedForm()
```
  - unsetEmbedForm
```
public void unsetEmbedForm()
```

Class SubmitFormActionType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

field

url

exclude

includeNoValueFields

exportFormat

getMethod

submitCoordinates

xfdf

includeAppendSaves

includeAnnotations

submitPDF

canonicalFormat

excludeNonUserAnnotations

excludeFDFSourceOrTargetFile

embedForm

Constructor Detail

SubmitFormActionType

Method Detail

getField

isSetField

unsetField

getUrl

setUrl

isSetUrl

isExclude

setExclude

isSetExclude

unsetExclude

isIncludeNoValueFields

setIncludeNoValueFields

isSetIncludeNoValueFields

unsetIncludeNoValueFields

isExportFormat

setExportFormat

isSetExportFormat

unsetExportFormat

isGetMethod

setGetMethod

isSetGetMethod

unsetGetMethod

isSubmitCoordinates

setSubmitCoordinates

isSetSubmitCoordinates

unsetSubmitCoordinates

isXfdf

setXfdf

isSetXfdf

unsetXfdf

isIncludeAppendSaves

setIncludeAppendSaves

isSetIncludeAppendSaves

unsetIncludeAppendSaves

isIncludeAnnotations

setIncludeAnnotations

isSetIncludeAnnotations

unsetIncludeAnnotations

isSubmitPDF

setSubmitPDF

isSetSubmitPDF

unsetSubmitPDF

isCanonicalFormat

setCanonicalFormat

isSetCanonicalFormat

unsetCanonicalFormat

isExcludeNonUserAnnotations

setExcludeNonUserAnnotations

isSetExcludeNonUserAnnotations

unsetExcludeNonUserAnnotations

isExcludeFDFSourceOrTargetFile

setExcludeFDFSourceOrTargetFile

isSetExcludeFDFSourceOrTargetFile

unsetExcludeFDFSourceOrTargetFile

isEmbedForm

setEmbedForm