Package com.avoka.fc.core.service

Class SubmissionDataBean

java.lang.Object

com.avoka.fc.core.service.SubmissionDataBean

All Implemented Interfaces:

Serializable

public class SubmissionDataBean
extends Object
implements Serializable

Provides a holder for extracted form submission data from LiveCycle ES.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubmissionDataBean(SubmissionDataBean dataBean, String formXml)	Provides a formXml and submission data bean copy constructor.
SubmissionDataBean(Document document, byte[] submittedData, String contentType)	Create the submission data bean by providing the document.
SubmissionDataBean(Document document, byte[] submittedData, String contentType, boolean encrypted)	Create the submission data bean by providing the document.
SubmissionDataBean(Document document, byte[] submittedData, String contentType, String processState)	Create the submission data bean by providing the document and process state.
SubmissionDataBean(Document document, byte[] submittedData, String contentType, String processState, String validationErrors)	Create the submission data bean by providing the document, process state and validation error.
SubmissionDataBean(Document document, byte[] submittedData, String contentType, String processState, List<EmbeddedAttachment> embeddedAttachments, String validationErrors)	Create the submission data bean by providing the document, process state, embedded attachment and validation errors.

Method Summary

Modifier and Type	Method	Description
String	getContentType()	Return the content type of the data that was submitted
Document	getDocument()	Return the document for the submission data bean.
List<EmbeddedAttachment>	getEmbeddedAttachments()	Return a list of embedded attachment.
Date	getFieldWorkerSubmissionDate()	Return the field worker submission date.
String	getOfflineSubmitKey()	Return the offline submission key.
UserAccount	getOfflineUser()	Return the offline user account.
byte[]	getSubmittedData()	Return the data originally submitted by the user
String	getTaskKey()	Return the task key.
String	getValidationErrors()	Return validation errors.
boolean	isFieldWorkerSubmission()	Return whether it is field worker submission.
boolean	isFormDataEncryptedFlag()
boolean	isInFormAttachmentsFlag()	Return the isInFormAttachmentsFlag.
boolean	isOfflineSubmission()	Return true if it is an offline submission.
boolean	isPdfSubmit()	Return true if a PDF form submission.
void	setEmbeddedAttachments(List<EmbeddedAttachment> embeddedAttachments)	Set embedded attachments.
void	setFieldWorkerSubmission(boolean isFieldWorkerSubmission)	Set whether it is field worker submission.
void	setFieldWorkerSubmissionDate(Date fieldWorkerSubmissionDate)	Set the field worker submission date.
void	setInFormAttachmentsFlag(boolean inFormAttachmentsFlag)	Set the inFormAttachmentsFlag.
void	setOfflineSubmission(boolean offlineSubmission)	Set whether it is an offline submission
void	setOfflineSubmitKey(String offlineSubmitKey)	Set the offline submission key.
void	setOfflineUser(UserAccount offlineUser)	Set the offline user account.
void	setTaskKey(String taskKey)	Set the task key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionDataBean

public SubmissionDataBean(Document document,
                          byte[] submittedData,
                          String contentType,
                          String processState,
                          List<EmbeddedAttachment> embeddedAttachments,
                          String validationErrors)

Create the submission data bean by providing the document, process state, embedded attachment and validation errors.

Parameters:

document - a document

submittedData - the originally submitted data

contentType - the content type

processState - process state (this is no longer used and present only for compatibility reasons)

embeddedAttachments - embedded attachment

validationErrors - validation errors

SubmissionDataBean

public SubmissionDataBean(Document document,
                          byte[] submittedData,
                          String contentType,
                          String processState)

Create the submission data bean by providing the document and process state.

Parameters:

document - a document

submittedData - the originally submitted data

contentType - the content type

processState - process state (this is no longer used and present only for compatibility reasons)

SubmissionDataBean

public SubmissionDataBean(Document document,
                          byte[] submittedData,
                          String contentType,
                          String processState,
                          String validationErrors)

Create the submission data bean by providing the document, process state and validation error.

Parameters:

document - a document

submittedData - the originally submitted data

contentType - the content type

processState - process state (this is no longer used and present only for compatibility reasons)

validationErrors - validation errors

SubmissionDataBean

public SubmissionDataBean(Document document,
                          byte[] submittedData,
                          String contentType)

Create the submission data bean by providing the document.

Parameters:

document - a document

submittedData - the originally submitted data

contentType - the content type

SubmissionDataBean

public SubmissionDataBean(Document document,
                          byte[] submittedData,
                          String contentType,
                          boolean encrypted)

Create the submission data bean by providing the document.

Parameters:

document - a document

submittedData - the originally submitted data

contentType - the content type

encrypted - the form XML data was client encrypted

Since:

5.0

SubmissionDataBean

public SubmissionDataBean(SubmissionDataBean dataBean,
                          String formXml)

Provides a formXml and submission data bean copy constructor.

Parameters:

dataBean - the original submission data bean (required)

formXml - the modified form XML data (required)

Since:

5.0

Method Detail

getContentType

public String getContentType()

Return the content type of the data that was submitted

Returns:

the content type

getDocument

public Document getDocument()

Return the document for the submission data bean.

Returns:

the document

getSubmittedData

public byte[] getSubmittedData()

Return the data originally submitted by the user

Returns:

the submitted data

getEmbeddedAttachments

public List<EmbeddedAttachment> getEmbeddedAttachments()

Return a list of embedded attachment.

Returns:

a list of embedded attachment

getValidationErrors

public String getValidationErrors()

Return validation errors.

Returns:

validation errors

setEmbeddedAttachments

public void setEmbeddedAttachments(List<EmbeddedAttachment> embeddedAttachments)

Set embedded attachments.

Parameters:

embeddedAttachments - embedded attachments

isFieldWorkerSubmission

public boolean isFieldWorkerSubmission()

Return whether it is field worker submission.

Returns:

whether it is field worker submission

setFieldWorkerSubmission

public void setFieldWorkerSubmission(boolean isFieldWorkerSubmission)

Set whether it is field worker submission.

Parameters:

isFieldWorkerSubmission - whether it is field worker submission

getFieldWorkerSubmissionDate

public Date getFieldWorkerSubmissionDate()

Return the field worker submission date.

Returns:

the field worker submission date

setFieldWorkerSubmissionDate

public void setFieldWorkerSubmissionDate(Date fieldWorkerSubmissionDate)

Set the field worker submission date.

Parameters:

fieldWorkerSubmissionDate - the field worker submission date

isOfflineSubmission

public boolean isOfflineSubmission()

Return true if it is an offline submission.

Returns:

true if it is an offline submission

setOfflineSubmission

public void setOfflineSubmission(boolean offlineSubmission)

Set whether it is an offline submission

Parameters:

offlineSubmission - whether it is an offline submission

getTaskKey

public String getTaskKey()

Return the task key.

Returns:

the task key.

setTaskKey

public void setTaskKey(String taskKey)

Set the task key.

Parameters:

taskKey - the task key.

getOfflineSubmitKey

public String getOfflineSubmitKey()

Return the offline submission key.

Returns:

the offline submission key.

setOfflineSubmitKey

public void setOfflineSubmitKey(String offlineSubmitKey)

Set the offline submission key.

Parameters:

offlineSubmitKey - the offline submission key

getOfflineUser

public UserAccount getOfflineUser()

Return the offline user account.

Returns:

the offline user account

setOfflineUser

public void setOfflineUser(UserAccount offlineUser)

Set the offline user account.

Parameters:

offlineUser - the offline user account

isPdfSubmit

public boolean isPdfSubmit()

Return true if a PDF form submission.

Returns:

true if a PDF form submission

Since:

4.0.0

isInFormAttachmentsFlag

public boolean isInFormAttachmentsFlag()

Return the isInFormAttachmentsFlag.

Returns:

the isInFormAttachmentsFlag

setInFormAttachmentsFlag

public void setInFormAttachmentsFlag(boolean inFormAttachmentsFlag)

Set the inFormAttachmentsFlag.

Parameters:

inFormAttachmentsFlag - the inFormAttachmentsFlag

isFormDataEncryptedFlag

public boolean isFormDataEncryptedFlag()

Returns:

true if the form data was encrypted

Since:

5.0