java.lang.Object
- net.webpdf.wsclient.openapi.OperationSubmitFormActionSubmitForm

```
public class OperationSubmitFormActionSubmitForm
extends Object
```
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.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_CANONICAL_FORMAT`
`static String`	`JSON_PROPERTY_EMBED_FORM`
`static String`	`JSON_PROPERTY_EXCLUDE`
`static String`	`JSON_PROPERTY_EXCLUDE_F_D_F_SOURCE_OR_TARGET_FILE`
`static String`	`JSON_PROPERTY_EXCLUDE_NON_USER_ANNOTATIONS`
`static String`	`JSON_PROPERTY_EXPORT_FORMAT`
`static String`	`JSON_PROPERTY_FIELD`
`static String`	`JSON_PROPERTY_GET_METHOD`
`static String`	`JSON_PROPERTY_INCLUDE_ANNOTATIONS`
`static String`	`JSON_PROPERTY_INCLUDE_APPEND_SAVES`
`static String`	`JSON_PROPERTY_INCLUDE_NO_VALUE_FIELDS`
`static String`	`JSON_PROPERTY_SUBMIT_COORDINATES`
`static String`	`JSON_PROPERTY_SUBMIT_P_D_F`
`static String`	`JSON_PROPERTY_URL`
`static String`	`JSON_PROPERTY_XFDF`

Constructor Summary

Constructors
Constructor Description

OperationSubmitFormActionSubmitForm()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationSubmitFormActionSubmitForm`	`addFieldItem(OperationFormFieldSelection fieldItem)`
`OperationSubmitFormActionSubmitForm`	`canonicalFormat(Boolean canonicalFormat)`
`OperationSubmitFormActionSubmitForm`	`embedForm(Boolean embedForm)`
`boolean`	`equals(Object o)`
`OperationSubmitFormActionSubmitForm`	`exclude(Boolean exclude)`
`OperationSubmitFormActionSubmitForm`	`excludeFDFSourceOrTargetFile(Boolean excludeFDFSourceOrTargetFile)`
`OperationSubmitFormActionSubmitForm`	`excludeNonUserAnnotations(Boolean excludeNonUserAnnotations)`
`OperationSubmitFormActionSubmitForm`	`exportFormat(Boolean exportFormat)`
`OperationSubmitFormActionSubmitForm`	`field(List<OperationFormFieldSelection> field)`
`@Nullable Boolean`	`getCanonicalFormat()`	If this value is set to true, all dates and times will be transmitted in a canonical standard format whenever possible.
`@Nullable Boolean`	`getEmbedForm()`	This value is only relevant if the data should be transmitted in FDF format.
`@Nullable Boolean`	`getExclude()`	If true, then all form fields except the selected ones should be exported.
`@Nullable Boolean`	`getExcludeFDFSourceOrTargetFile()`	This value is only relevant if the data should be transmitted in FDF format.
`@Nullable Boolean`	`getExcludeNonUserAnnotations()`	This value is only relevant if the data should be transmitted in FDF format and \"includeAnnotations\" is set.
`@Nullable Boolean`	`getExportFormat()`	This value is only relevant if \"submitPDF\" and \"xfdf\" are not set.
`@Nullable List<OperationFormFieldSelection>`	`getField()`	Get field
`@Nullable Boolean`	`getGetMethod()`	This value is only relevant if \"exportFormat\" is set and used.
`@Nullable Boolean`	`getIncludeAnnotations()`	This value is only relevant if the data should be transmitted in FDF format.
`@Nullable Boolean`	`getIncludeAppendSaves()`	This value is only relevant if the data should be transmitted in FDF format.
`@Nullable Boolean`	`getIncludeNoValueFields()`	If true, form fields that have not yet been filled out / that do not contain a value will be exported as well.
`OperationSubmitFormActionSubmitForm`	`getMethod(Boolean getMethod)`
`@Nullable Boolean`	`getSubmitCoordinates()`	This value is only relevant if \"exportFormat\" is set and used.
`@Nullable Boolean`	`getSubmitPDF()`	If this value is set to true, the data will be transmitted as a PDF file.
`@Nullable String`	`getUrl()`	The URL to which the data should be transmitted.
`@Nullable Boolean`	`getXfdf()`	This value is only relevant if \"submitPDF\" is not set.
`int`	`hashCode()`
`OperationSubmitFormActionSubmitForm`	`includeAnnotations(Boolean includeAnnotations)`
`OperationSubmitFormActionSubmitForm`	`includeAppendSaves(Boolean includeAppendSaves)`
`OperationSubmitFormActionSubmitForm`	`includeNoValueFields(Boolean includeNoValueFields)`
`void`	`setCanonicalFormat(Boolean canonicalFormat)`
`void`	`setEmbedForm(Boolean embedForm)`
`void`	`setExclude(Boolean exclude)`
`void`	`setExcludeFDFSourceOrTargetFile(Boolean excludeFDFSourceOrTargetFile)`
`void`	`setExcludeNonUserAnnotations(Boolean excludeNonUserAnnotations)`
`void`	`setExportFormat(Boolean exportFormat)`
`void`	`setField(List<OperationFormFieldSelection> field)`
`void`	`setGetMethod(Boolean getMethod)`
`void`	`setIncludeAnnotations(Boolean includeAnnotations)`
`void`	`setIncludeAppendSaves(Boolean includeAppendSaves)`
`void`	`setIncludeNoValueFields(Boolean includeNoValueFields)`
`void`	`setSubmitCoordinates(Boolean submitCoordinates)`
`void`	`setSubmitPDF(Boolean submitPDF)`
`void`	`setUrl(String url)`
`void`	`setXfdf(Boolean xfdf)`
`OperationSubmitFormActionSubmitForm`	`submitCoordinates(Boolean submitCoordinates)`
`OperationSubmitFormActionSubmitForm`	`submitPDF(Boolean submitPDF)`
`String`	`toString()`
`OperationSubmitFormActionSubmitForm`	`url(String url)`
`OperationSubmitFormActionSubmitForm`	`xfdf(Boolean xfdf)`

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

- Field Detail
  - JSON_PROPERTY_CANONICAL_FORMAT
```
public static final String JSON_PROPERTY_CANONICAL_FORMAT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EMBED_FORM
```
public static final String JSON_PROPERTY_EMBED_FORM
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXCLUDE
```
public static final String JSON_PROPERTY_EXCLUDE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXCLUDE_F_D_F_SOURCE_OR_TARGET_FILE
```
public static final String JSON_PROPERTY_EXCLUDE_F_D_F_SOURCE_OR_TARGET_FILE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXCLUDE_NON_USER_ANNOTATIONS
```
public static final String JSON_PROPERTY_EXCLUDE_NON_USER_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXPORT_FORMAT
```
public static final String JSON_PROPERTY_EXPORT_FORMAT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FIELD
```
public static final String JSON_PROPERTY_FIELD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_GET_METHOD
```
public static final String JSON_PROPERTY_GET_METHOD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INCLUDE_ANNOTATIONS
```
public static final String JSON_PROPERTY_INCLUDE_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INCLUDE_APPEND_SAVES
```
public static final String JSON_PROPERTY_INCLUDE_APPEND_SAVES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INCLUDE_NO_VALUE_FIELDS
```
public static final String JSON_PROPERTY_INCLUDE_NO_VALUE_FIELDS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUBMIT_COORDINATES
```
public static final String JSON_PROPERTY_SUBMIT_COORDINATES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUBMIT_P_D_F
```
public static final String JSON_PROPERTY_SUBMIT_P_D_F
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_URL
```
public static final String JSON_PROPERTY_URL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_XFDF
```
public static final String JSON_PROPERTY_XFDF
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationSubmitFormActionSubmitForm
```
public OperationSubmitFormActionSubmitForm()
```
- Method Detail
  - canonicalFormat
```
public OperationSubmitFormActionSubmitForm canonicalFormat(Boolean canonicalFormat)
```
  - getCanonicalFormat
```
@Nullable
public @Nullable Boolean getCanonicalFormat()
```
    If this value is set to true, all dates and times will be transmitted in a canonical standard format whenever possible.
    
    Returns:
    
    canonicalFormat
  - setCanonicalFormat
```
public void setCanonicalFormat(Boolean canonicalFormat)
```
  - embedForm
```
public OperationSubmitFormActionSubmitForm embedForm(Boolean embedForm)
```
  - getEmbedForm
```
@Nullable
public @Nullable Boolean getEmbedForm()
```
    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.
    
    Returns:
    
    embedForm
  - setEmbedForm
```
public void setEmbedForm(Boolean embedForm)
```
  - exclude
```
public OperationSubmitFormActionSubmitForm exclude(Boolean exclude)
```
  - getExclude
```
@Nullable
public @Nullable Boolean getExclude()
```
    If true, then all form fields except the selected ones should be exported. If false, only the selected ones will be.
    
    Returns:
    
    exclude
  - setExclude
```
public void setExclude(Boolean exclude)
```
  - excludeFDFSourceOrTargetFile
```
public OperationSubmitFormActionSubmitForm excludeFDFSourceOrTargetFile(Boolean excludeFDFSourceOrTargetFile)
```
  - getExcludeFDFSourceOrTargetFile
```
@Nullable
public @Nullable Boolean getExcludeFDFSourceOrTargetFile()
```
    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.
    
    Returns:
    
    excludeFDFSourceOrTargetFile
  - setExcludeFDFSourceOrTargetFile
```
public void setExcludeFDFSourceOrTargetFile(Boolean excludeFDFSourceOrTargetFile)
```
  - excludeNonUserAnnotations
```
public OperationSubmitFormActionSubmitForm excludeNonUserAnnotations(Boolean excludeNonUserAnnotations)
```
  - getExcludeNonUserAnnotations
```
@Nullable
public @Nullable Boolean getExcludeNonUserAnnotations()
```
    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).
    
    Returns:
    
    excludeNonUserAnnotations
  - setExcludeNonUserAnnotations
```
public void setExcludeNonUserAnnotations(Boolean excludeNonUserAnnotations)
```
  - exportFormat
```
public OperationSubmitFormActionSubmitForm exportFormat(Boolean exportFormat)
```
  - getExportFormat
```
@Nullable
public @Nullable Boolean getExportFormat()
```
    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.
    
    Returns:
    
    exportFormat
  - setExportFormat
```
public void setExportFormat(Boolean exportFormat)
```
  - field
```
public OperationSubmitFormActionSubmitForm field(List<OperationFormFieldSelection> field)
```
  - addFieldItem
```
public OperationSubmitFormActionSubmitForm addFieldItem(OperationFormFieldSelection fieldItem)
```
  - getField
```
@Nullable
public @Nullable List<OperationFormFieldSelection> getField()
```
    Get field
    
    Returns:
    
    field
  - setField
```
public void setField(List<OperationFormFieldSelection> field)
```
  - getMethod
```
public OperationSubmitFormActionSubmitForm getMethod(Boolean getMethod)
```
  - getGetMethod
```
@Nullable
public @Nullable Boolean getGetMethod()
```
    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.
    
    Returns:
    
    getMethod
  - setGetMethod
```
public void setGetMethod(Boolean getMethod)
```
  - includeAnnotations
```
public OperationSubmitFormActionSubmitForm includeAnnotations(Boolean includeAnnotations)
```
  - getIncludeAnnotations
```
@Nullable
public @Nullable Boolean getIncludeAnnotations()
```
    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.
    
    Returns:
    
    includeAnnotations
  - setIncludeAnnotations
```
public void setIncludeAnnotations(Boolean includeAnnotations)
```
  - includeAppendSaves
```
public OperationSubmitFormActionSubmitForm includeAppendSaves(Boolean includeAppendSaves)
```
  - getIncludeAppendSaves
```
@Nullable
public @Nullable Boolean getIncludeAppendSaves()
```
    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.
    
    Returns:
    
    includeAppendSaves
  - setIncludeAppendSaves
```
public void setIncludeAppendSaves(Boolean includeAppendSaves)
```
  - includeNoValueFields
```
public OperationSubmitFormActionSubmitForm includeNoValueFields(Boolean includeNoValueFields)
```
  - getIncludeNoValueFields
```
@Nullable
public @Nullable Boolean getIncludeNoValueFields()
```
    If true, form fields that have not yet been filled out / that do not contain a value will be exported as well.
    
    Returns:
    
    includeNoValueFields
  - setIncludeNoValueFields
```
public void setIncludeNoValueFields(Boolean includeNoValueFields)
```
  - submitCoordinates
```
public OperationSubmitFormActionSubmitForm submitCoordinates(Boolean submitCoordinates)
```
  - getSubmitCoordinates
```
@Nullable
public @Nullable Boolean getSubmitCoordinates()
```
    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.
    
    Returns:
    
    submitCoordinates
  - setSubmitCoordinates
```
public void setSubmitCoordinates(Boolean submitCoordinates)
```
  - submitPDF
```
public OperationSubmitFormActionSubmitForm submitPDF(Boolean submitPDF)
```
  - getSubmitPDF
```
@Nullable
public @Nullable Boolean getSubmitPDF()
```
    If this value is set to true, the data will be transmitted as a PDF file.
    
    Returns:
    
    submitPDF
  - setSubmitPDF
```
public void setSubmitPDF(Boolean submitPDF)
```
  - url
```
public OperationSubmitFormActionSubmitForm url(String url)
```
  - getUrl
```
@Nullable
public @Nullable String getUrl()
```
    The URL to which the data should be transmitted.
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
  - xfdf
```
public OperationSubmitFormActionSubmitForm xfdf(Boolean xfdf)
```
  - getXfdf
```
@Nullable
public @Nullable Boolean getXfdf()
```
    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.
    
    Returns:
    
    xfdf
  - setXfdf
```
public void setXfdf(Boolean xfdf)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OperationSubmitFormActionSubmitForm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_CANONICAL_FORMAT

JSON_PROPERTY_EMBED_FORM

JSON_PROPERTY_EXCLUDE

JSON_PROPERTY_EXCLUDE_F_D_F_SOURCE_OR_TARGET_FILE

JSON_PROPERTY_EXCLUDE_NON_USER_ANNOTATIONS

JSON_PROPERTY_EXPORT_FORMAT

JSON_PROPERTY_FIELD

JSON_PROPERTY_GET_METHOD

JSON_PROPERTY_INCLUDE_ANNOTATIONS

JSON_PROPERTY_INCLUDE_APPEND_SAVES

JSON_PROPERTY_INCLUDE_NO_VALUE_FIELDS

JSON_PROPERTY_SUBMIT_COORDINATES

JSON_PROPERTY_SUBMIT_P_D_F

JSON_PROPERTY_URL

JSON_PROPERTY_XFDF

Constructor Detail

OperationSubmitFormActionSubmitForm

Method Detail

canonicalFormat

getCanonicalFormat

setCanonicalFormat

embedForm

getEmbedForm

setEmbedForm

exclude

getExclude

setExclude

excludeFDFSourceOrTargetFile

getExcludeFDFSourceOrTargetFile

setExcludeFDFSourceOrTargetFile

excludeNonUserAnnotations

getExcludeNonUserAnnotations

setExcludeNonUserAnnotations

exportFormat

getExportFormat

setExportFormat

field

addFieldItem

getField

setField

getMethod

getGetMethod

setGetMethod

includeAnnotations

getIncludeAnnotations

setIncludeAnnotations

includeAppendSaves

getIncludeAppendSaves

setIncludeAppendSaves

includeNoValueFields

getIncludeNoValueFields

setIncludeNoValueFields

submitCoordinates

getSubmitCoordinates

setSubmitCoordinates

submitPDF

getSubmitPDF

setSubmitPDF

url

getUrl

setUrl

xfdf

getXfdf

setXfdf

equals

hashCode

toString