com.adobe.aemds.guide.model

Class FormSubmitInfo

java.lang.Object

com.adobe.aemds.guide.model.FormSubmitInfo

public class FormSubmitInfo
extends java.lang.Object

Defines the information required during form submission

Since:

6.3

Constructor Summary

Constructors

Constructor and Description
FormSubmitInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgreementId() Returns the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
java.lang.String	getContentType() Returns the mime type of the submitted data.
java.lang.String	getData() Returns the submitted data of the form
FileAttachmentWrapper	getDocumentOfRecord() Returns the document of record as a result of form submission.
java.lang.String	getFileAttachmentMap() Returns the String representation of File Attachment map
java.util.List<FileAttachmentWrapper>	getFileAttachments() Returns the list of FileAttachmentWrapper objects.
java.lang.String	getFormContainerPath() Returns the path to the form container
Resource	getFormContainerResource() Returns the form container resource
java.lang.String	getFormSubmitter() Returns the id of the user who submitted the form
java.lang.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(java.lang.String agreementId) Sets the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
void	setContentType(java.lang.String contentType) Sets the mime type of the submitted data
void	setData(java.lang.String data) Sets the data submitted by the form
void	setDocumentOfRecord(FileAttachmentWrapper documentOfRecord) Sets the document of record as a result of form submission.
void	setFileAttachmentMap(java.lang.String fileAttachmentMap) Sets the String representation of File Attachment map
void	setFileAttachments(java.util.List<FileAttachmentWrapper> fileAttachments) Sets the list of FileAttachmentWrapper objects
void	setFormContainerPath(java.lang.String formContainerPath) Sets the given form container path
void	setFormContainerResource(Resource formContainerResource) Sets the form container resource
void	setFormSubmitter(java.lang.String formSubmitter) Sets the user id of the user who submitted the form
void	setLocale(java.lang.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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormSubmitInfo

public FormSubmitInfo()

Method Detail

getFormContainerPath

public java.lang.String getFormContainerPath()

Returns the path to the form container

Returns:

path to the form container

setFormContainerPath

public void setFormContainerPath(java.lang.String formContainerPath)

Sets the given form container path

Parameters:

formContainerPath - path to the form container

getData

public java.lang.String getData()

Returns the submitted data of the form

Returns:

data submitted

setData

public void setData(java.lang.String data)

Sets the data submitted by the form

Parameters:

data - data submitted

getFileAttachments

public java.util.List<FileAttachmentWrapper> getFileAttachments()

Returns the list of FileAttachmentWrapper objects. This list contains the file attachment submitted

Returns:

list of FileAttachmentWrapper objects

setFileAttachments

public void setFileAttachments(java.util.List<FileAttachmentWrapper> fileAttachments)

Sets the list of FileAttachmentWrapper objects

Parameters:

fileAttachments - list of FileAttachmentWrapper objects

getDocumentOfRecord

public FileAttachmentWrapper getDocumentOfRecord()

Returns the document of record as a result of form submission.

Returns:

FileAttachmentWrapper representing the document of record

setDocumentOfRecord

public void setDocumentOfRecord(FileAttachmentWrapper documentOfRecord)

Sets the document of record as a result of form submission.

Parameters:

documentOfRecord - FileAttachmentWrapper representing the document of record

getFileAttachmentMap

public java.lang.String getFileAttachmentMap()

Returns the String representation of File Attachment map

Returns:

String representing File Attachment map

setFileAttachmentMap

public void setFileAttachmentMap(java.lang.String fileAttachmentMap)

Sets the String representation of File Attachment map

Parameters:

fileAttachmentMap - String representing File Attachment map

getFormContainerResource

public Resource getFormContainerResource()

Returns the form container resource

Returns:

form container resource

setFormContainerResource

public void setFormContainerResource(Resource formContainerResource)

Sets the form container resource

Parameters:

formContainerResource - resource to the form container

getLocale

public java.lang.String getLocale()

Returns the form locale

Returns:

form locale

setLocale

public void setLocale(java.lang.String locale)

Sets the form locale

Parameters:

locale - form locale

getFormSubmitter

public java.lang.String getFormSubmitter()

Returns the id of the user who submitted the form

Returns:

id of the user

setFormSubmitter

public void setFormSubmitter(java.lang.String formSubmitter)

Sets the user id of the user who submitted the form

Parameters:

formSubmitter - user id of the user

getContentType

public java.lang.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(java.lang.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 java.lang.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(java.lang.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