FormSubmitInfo (AEM Forms API)

java.lang.Object
- com.adobe.aemds.guide.model.FormSubmitInfo

```
public class FormSubmitInfo
extends Object
```
Defines the information required during form submission

Since:

6.3

Constructor Summary

Constructors
Constructor and Description

FormSubmitInfo()

Constructors
Constructor and Description
`FormSubmitInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAgreementId()` Returns the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
`String`	`getContentType()` Returns the mime type of the submitted data.
`String`	`getData()` Returns the submitted data of the form
`com.adobe.forms.common.service.FileAttachmentWrapper`	`getDocumentOfRecord()` Returns the document of record as a result of form submission.
`String`	`getFileAttachmentMap()` Returns the String representation of File Attachment map
`List<com.adobe.forms.common.service.FileAttachmentWrapper>`	`getFileAttachments()` Returns the list of `FileAttachmentWrapper` objects.
`String`	`getFormContainerPath()` Returns the path to the form container
`org.apache.sling.api.resource.Resource`	`getFormContainerResource()` Returns the form container resource
`String`	`getFormSubmitter()` Returns the id of the user who submitted the form
`String`	`getLocale()` Returns the form locale
`PortalRecordInfo`	`getPortalRecordInfo()` Returns the information related to form submission, in Forms Portal.
`byte[]`	`getSignData()` Returns the data (represented as byte array), filled by signers, while signing the form.
`void`	`setAgreementId(String agreementId)` Sets the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
`void`	`setContentType(String contentType)` Sets the mime type of the submitted data
`void`	`setData(String data)` Sets the data submitted by the form
`void`	`setDocumentOfRecord(com.adobe.forms.common.service.FileAttachmentWrapper documentOfRecord)` Sets the document of record as a result of form submission.
`void`	`setFileAttachmentMap(String fileAttachmentMap)` Sets the String representation of File Attachment map
`void`	`setFileAttachments(List<com.adobe.forms.common.service.FileAttachmentWrapper> fileAttachments)` Sets the list of `FileAttachmentWrapper` objects
`void`	`setFormContainerPath(String formContainerPath)` Sets the given form container path
`void`	`setFormContainerResource(org.apache.sling.api.resource.Resource formContainerResource)` Sets the form container resource
`void`	`setFormSubmitter(String formSubmitter)` Sets the user id of the user who submitted the form
`void`	`setLocale(String locale)` Sets the form locale
`void`	`setPortalRecordInfo(PortalRecordInfo portalRecordInfo)` Sets the information related to form submission, in Forms Portal.
`void`	`setSignData(byte[] signData)` Sets the data (represented as byte array), filled by signers, while signing the form.

- Constructor Detail
  - FormSubmitInfo
```
public FormSubmitInfo()
```
- Method Detail
  - getFormContainerPath
```
public String getFormContainerPath()
```
    Returns the path to the form container
    
    Returns:
    
    path to the form container
  - setFormContainerPath
```
public void setFormContainerPath(String formContainerPath)
```
    Sets the given form container path
    
    Parameters:
    
    formContainerPath - path to the form container
  - getData
```
public String getData()
```
    Returns the submitted data of the form
    
    Returns:
    
    data submitted
  - setData
```
public void setData(String data)
```
    Sets the data submitted by the form
    
    Parameters:
    
    data - data submitted
  - getFileAttachments
```
public List<com.adobe.forms.common.service.FileAttachmentWrapper> getFileAttachments()
```
    Returns the list of FileAttachmentWrapper objects. This list contains the file attachment submitted
    
    Returns:
    
    list of FileAttachmentWrapper objects
  - setFileAttachments
```
public void setFileAttachments(List<com.adobe.forms.common.service.FileAttachmentWrapper> fileAttachments)
```
    Sets the list of FileAttachmentWrapper objects
    
    Parameters:
    
    fileAttachments - list of FileAttachmentWrapper objects
  - getDocumentOfRecord
```
public com.adobe.forms.common.service.FileAttachmentWrapper getDocumentOfRecord()
```
    Returns the document of record as a result of form submission.
    
    Returns:
    
    FileAttachmentWrapper representing the document of record
  - setDocumentOfRecord
```
public void setDocumentOfRecord(com.adobe.forms.common.service.FileAttachmentWrapper documentOfRecord)
```
    Sets the document of record as a result of form submission.
    
    Parameters:
    
    documentOfRecord - FileAttachmentWrapper representing the document of record
  - getFileAttachmentMap
```
public String getFileAttachmentMap()
```
    Returns the String representation of File Attachment map
    
    Returns:
    
    String representing File Attachment map
  - setFileAttachmentMap
```
public void setFileAttachmentMap(String fileAttachmentMap)
```
    Sets the String representation of File Attachment map
    
    Parameters:
    
    fileAttachmentMap - String representing File Attachment map
  - getFormContainerResource
```
public org.apache.sling.api.resource.Resource getFormContainerResource()
```
    Returns the form container resource
    
    Returns:
    
    form container resource
  - setFormContainerResource
```
public void setFormContainerResource(org.apache.sling.api.resource.Resource formContainerResource)
```
    Sets the form container resource
    
    Parameters:
    
    formContainerResource - resource to the form container
  - getLocale
```
public String getLocale()
```
    Returns the form locale
    
    Returns:
    
    form locale
  - setLocale
```
public void setLocale(String locale)
```
    Sets the form locale
    
    Parameters:
    
    locale - form locale
  - getFormSubmitter
```
public String getFormSubmitter()
```
    Returns the id of the user who submitted the form
    
    Returns:
    
    id of the user
  - setFormSubmitter
```
public void setFormSubmitter(String formSubmitter)
```
    Sets the user id of the user who submitted the form
    
    Parameters:
    
    formSubmitter - user id of the user
  - getContentType
```
public String getContentType()
```
    Returns the mime type of the submitted data. For example, in case of json data, the mime type would be application/json and in case of XML, the mime type would be application/xml.
    
    Returns:
    
    mime type of the data submitted
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the mime type of the submitted data
    
    Parameters:
    
    contentType - mime type of the submitted data
  - getSignData
```
public byte[] getSignData()
```
    Returns the data (represented as byte array), filled by signers, while signing the form.
    
    Returns:
    
    byte[] - data filled by the signers
  - setSignData
```
public void setSignData(byte[] signData)
```
    Sets the data (represented as byte array), filled by signers, while signing the form.
  - getAgreementId
```
public String getAgreementId()
```
    Returns the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
    
    Returns:
    
    String representing Adobe Sign Agreement ID
  - setAgreementId
```
public void setAgreementId(String agreementId)
```
    Sets the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
    
    Parameters:
    
    agreementId - String representing Adobe Sign Agreement ID
  - getPortalRecordInfo
```
public PortalRecordInfo getPortalRecordInfo()
```
    Returns the information related to form submission, in Forms Portal.
    
    Returns:
    
    PortalRecordInfo represents Forms Portal form submission info
  - setPortalRecordInfo
```
public void setPortalRecordInfo(PortalRecordInfo portalRecordInfo)
```
    Sets the information related to form submission, in Forms Portal.
    
    Parameters:
    
    portalRecordInfo - PortalRecordInfo represents Forms Portal form submission info

Class FormSubmitInfo

Constructor Summary

Method Summary

Constructor Detail

FormSubmitInfo

Method Detail

getFormContainerPath

setFormContainerPath

getData

setData

getFileAttachments

setFileAttachments

getDocumentOfRecord

setDocumentOfRecord

getFileAttachmentMap

setFileAttachmentMap

getFormContainerResource

setFormContainerResource

getLocale

setLocale

getFormSubmitter

setFormSubmitter

getContentType

setContentType

getSignData

setSignData

getAgreementId

setAgreementId

getPortalRecordInfo

setPortalRecordInfo