java.lang.Object
- org.apache.cayenne.PersistentObject
- - org.apache.cayenne.BaseDataObject
  - - org.apache.cayenne.CayenneDataObject
    - - com.avoka.core.entity.BaseEntity
      - com.avoka.fc.core.entity.auto._Submission
        
        com.avoka.fc.core.entity.Submission

All Implemented Interfaces:

IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
```
public class Submission
extends _Submission
```
Provides an entity containing data submitted by the user along with additional information and status values.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ABANDONMENT_REASON_PROPERTY`	Provides the 'abandonmentReason' property name.
`static String[]`	`ATTACHMENT_STATUS_VALUES`	The set of attachment status values
`static String`	`CLIENT_CODE_PROPERTY`	Provides the 'clientCode' property name.
`static String`	`CLIENT_NAME_PROPERTY`	Provides the 'clientName' property name.
`static String`	`DATA_VALIDATION_MESSAGE_PROPERTY`	Provides the 'dataValidationMessage' property name.
`static String`	`DELIVERY_EMAIL`	Indicates that the delivery method is standard email
`static String`	`DELIVERY_EMAIL_SECURE`	Indicates that the delivery method is secure email
`static String`	`DELIVERY_MANUAL`	Indicates that delivery was manually set to completed
`static String`	`DELIVERY_PROCESS`	Indicates that the delivery method is LiveCycle process delivery
`static String[]`	`DELIVERY_STATUS_VALUES`	The set of delivery status values
`static String`	`DELIVERY_WEB_SERVICE_PULL`	Indicates that the delivery method is web service pull
`static String[]`	`DIGITAL_SIGNATURE_STATUS_VALUES`	The set of possible digital signature status values
`static String[]`	`EMAIL_VERIFICATION_STATUS_VALUES`	The set of email verification status values
`static String`	`FORM_CODE_PROPERTY`	Provides the 'formCode' property name.
`static String`	`FORM_NAME_PROPERTY`	Provides the 'formName' property name.
`static String[]`	`FORM_STATUS_VALUES`	The set of form status values
`static String`	`HOST_CONTEXT_FieldWorker`	The 'FieldWorker' form host context.
`static String`	`HOST_CONTEXT_IFRAME`	The 'IFrame' form host context.
`static String`	`HOST_CONTEXT_PAGE`	The 'Page' form host context.
`static String`	`IP_ADDRESS_PROPERTY`	Provides the 'ipAddress' property name.
`static int`	`JOB_PROCESS_IMMEDIATE_FILTER`	The bit filter for job-related submissions with immediate processing turned on
`static int`	`LC_DIGITAL_SIGNATURES_FILTER`	The bit filter for LC Digital Signatures
`static int`	`LC_FORMS_FILTER`	The bit filter for LC Forms
`static int`	`LC_OUTPUT_FILTER`	The bit filter for LC Output
`static int`	`LC_PROCESS_MANAGEMENT_FILTER`	The bit filter for LC Process Management
`static int`	`LC_READER_EXTENSIONS_FILTER`	The bit filter for LC Reader Extensions
`static String[]`	`PAYMENT_STATUS_VALUES`	The set of payment status values
`static String`	`PAYMENT_TYPE_BPAY`	Indicates that the payment method "BPAY" was selected
`static String`	`PAYMENT_TYPE_CreditCard`	Indicates that the payment method "Credit/Debit Card" was selected
`static String`	`PAYMENT_TYPE_EFT`	Indicates that the payment method "EFT" was selected
`static String`	`PAYMENT_TYPE_Hosted`	Indicates that the payment method "Hosted" was selected
`static String`	`PAYMENT_TYPE_Manual`	Indicates that the payment was completed manually.
`static String[]`	`PAYMENT_TYPE_VALUES`	The set of payment type values
`static String`	`PERCENTAGE_COMPLETED_PROPERTY`	Provides the 'percentageCompleted' property name.
`static String`	`PROCESSING_STATUS_PROPERTY`	Provides the 'processingStatus' property name.
`static String`	`PROCESSING_STATUS_TIME_PROPERTY`	Provides the 'processingStatusTime' property name.
`static String[]`	`RECEIPT_STATUS_VALUES`	The set of receipt status values
`static String`	`REFERER_PROPERTY`	Provides the 'referer' property name.
`static String`	`REQUEST_COOKIE_PROPERTY`	Provides the 'requestCookie' property name.
`static String`	`REQUEST_URL_PROPERTY`	Provides the 'requestUrl' property name.
`static String`	`SAVED_MESSAGE_PROPERTY`	Provides the 'savedMessage' property name.
`static String[]`	`SIGNATURE_STATUS_VALUES`	The set of possible signature status values
`static String`	`SIGNATURE_TYPE_DIGITAL`	Indicates that the form is to be digitally signed
`static String`	`SIGNATURE_TYPE_ESIGNATURE`	Deprecated.
`static String[]`	`SIGNATURE_TYPE_VALUES`	The set of signature type values
`static String`	`SIGNATURE_TYPE_WET`	Indicates that the form is to be signed with wet ink
`static String`	`STATUS_Abandoned`	Provides an "Abandoned" status
`static String`	`STATUS_Assigned`	Provides an "Assigned" status
`static String`	`STATUS_Cancelled`	Provides a "Cancelled" status
`static String`	`STATUS_Completed`	Provides a "Completed" status
`static String`	`STATUS_COMPLETED_MANUALLY`	Provides a "Completed - Deliver Manually" status
`static String`	`STATUS_COMPLETED_UPLOAD`	Provides a "Completed - Upload Scanned Copy" status
`static String`	`STATUS_DetailsRequired`	Provides a "Details Required" status
`static String`	`STATUS_Error`	Provides an "Error" status
`static String`	`STATUS_Error_No_Data`	Provides an "Error - No Data" status
`static String`	`STATUS_Expired`	Provides an "Expired" status
`static String`	`STATUS_In_Progress`	Provides an "In Progress" status
`static String`	`STATUS_Ineligible`	Provides an "Ineligible" status
`static String`	`STATUS_NotReady`	Provides a "Not Ready" status
`static String`	`STATUS_NotRequired`	Provides a "Not Ready" status
`static String`	`STATUS_Opened`	Provides a "Opended" status
`static String`	`STATUS_Optional`	Provides an "Optional" status
`static String`	`STATUS_PaymentRequired`	Provides a "Payment Required" status
`static String`	`STATUS_Pending`	Provides an "Pending" status
`static String`	`STATUS_Ready`	Provides a "Ready" status
`static String`	`STATUS_Required`	Provides a "Required" status
`static String`	`STATUS_Saved`	Provides a "Saved" status
`static String`	`STATUS_Sent_Email`	Provides a "Sent Email" status
`static String`	`STATUS_Submitted`	Provides a "Submitted" status
`static String`	`STATUS_Undeliverable`	Provides an "Undeliverable" status
`static String[]`	`SUBMISSION_FORM_STATUS_VALUES`	The set of searchable submission form status values (the same as `FORM_STATUS_VALUES` excluding Assigned and Opened )
`static String`	`SUBMISSION_GROUP_NAMES_PROPERTY`	An auxiliary property listing the names of all groups associated with a submission
`static String`	`SUBMISSION_MESSAGE_PROPERTY`	Provides the 'submissionMessage' property name.
`static String`	`TASK_EMAIL_MESSAGE_PROPERTY`	Provides the 'taskEmailMessage' property name.
`static String`	`TASK_EMAIL_SUBJECT_PROPERTY`	Provides the 'taskEmailSubject' property name.
`static String`	`TASK_GROUP_NAME_PROPERTY`	Deprecated. as of TM 4.1, tasks can be associated with multiple groups.
`static String`	`TASK_MESSAGE_PROPERTY`	Provides the 'taskMessage' property name.
`static String[]`	`TASK_STATUS_VALUES`	The set of form status values relevant to tasks
`static String`	`TASK_TYPE_FORM`	The Constant 'Form' Task Type.
`static String`	`TASK_TYPE_REVIEW`	The Constant 'Review' Task Type.
`static String[]`	`TASK_TYPE_VALUES`	The set of task type values.
`static String`	`USER_AGENT_BROWSER_PROPERTY`	An auxiliary property combining all available information about the user's browser
`static String`	`USER_AGENT_BROWSER_TYPE_PROPERTY`	Provides the 'userAgentBrowserType' property name.
`static String`	`USER_AGENT_BROWSER_VERSION_PROPERTY`	Provides the 'userAgentBrowserVersion' property name.
`static String`	`USER_AGENT_OS_PROPERTY`	An auxiliary property combining all available information about the user's operating system
`static String`	`USER_AGENT_OS_TYPE_PROPERTY`	Provides the 'userAgentOsType' property name.
`static String`	`USER_AGENT_OS_VERSION_PROPERTY`	Provides the 'userAgentOsVersion' property name.
`static String`	`USER_AGENT_PROPERTY`	Provides the 'userAgent' property name.
`static String[]`	`WET_SIGNATURE_STATUS_VALUES`	The set of possible wet signature status values

Fields inherited from class com.avoka.fc.core.entity.auto._Submission
ABANDONMENT_FORM_STATUS, ABANDONMENT_FORM_STATUS_PROPERTY, ABANDONMENT_TIMESTAMP, ABANDONMENT_TIMESTAMP_PROPERTY, ABANDONMENT_TYPE, ABANDONMENT_TYPE_PROPERTY, ADOBE_VERSION, ADOBE_VERSION_PROPERTY, ASYNC_MSGS, ASYNC_MSGS_PROPERTY, ATTACHMENTS, ATTACHMENTS_PROPERTY, ATTACHMENTS_STATUS, ATTACHMENTS_STATUS_PROPERTY, ATTRIBUTES, ATTRIBUTES_PROPERTY, AUDIT_LOGS, AUDIT_LOGS_PROPERTY, AUTHENTICATION_STATUS, AUTHENTICATION_STATUS_PROPERTY, BPAY_BILLER_CODE, BPAY_BILLER_CODE_PROPERTY, BPAY_REFERENCE_NUMBER, BPAY_REFERENCE_NUMBER_PROPERTY, CLIENT, CLIENT_PROPERTY, COMMENTS, COMMENTS_PROPERTY, CONTACT_AGE, CONTACT_AGE_PROPERTY, CONTACT_EMAIL_ADDRESS, CONTACT_EMAIL_ADDRESS_PROPERTY, CONTACT_GENDER, CONTACT_GENDER_PROPERTY, CONTACT_PHONE, CONTACT_PHONE_PROPERTY, CONTACT_POSTCODE, CONTACT_POSTCODE_PROPERTY, CREATED_USERNAME, CREATED_USERNAME_PROPERTY, DATA_VALIDATION_STATUS, DATA_VALIDATION_STATUS_PROPERTY, DELETED_FLAG, DELETED_FLAG_PROPERTY, DELETED_TIMESTAMP, DELETED_TIMESTAMP_PROPERTY, DELIVERY_CHECKPOINTS, DELIVERY_CHECKPOINTS_PROPERTY, DELIVERY_DETAILS, DELIVERY_DETAILS_PROPERTY, DELIVERY_ERROR_LOG, DELIVERY_ERROR_LOG_PROPERTY, DELIVERY_FUNCTIONS, DELIVERY_FUNCTIONS_PROPERTY, DELIVERY_INVOCATION_ID, DELIVERY_INVOCATION_ID_PROPERTY, DELIVERY_MESSAGE, DELIVERY_MESSAGE_PROPERTY, DELIVERY_METHOD, DELIVERY_METHOD_PROPERTY, DELIVERY_PROCESS_ATTEMPTS, DELIVERY_PROCESS_ATTEMPTS_PROPERTY, DELIVERY_PROCESS_ID, DELIVERY_PROCESS_ID_PROPERTY, DELIVERY_STATUS, DELIVERY_STATUS_PROPERTY, DELIVERY_TIME, DELIVERY_TIME_PROPERTY, EMAIL_QUEUE_ITEMS, EMAIL_QUEUE_ITEMS_PROPERTY, EMAIL_VERIFICATION_ATTEMPTS, EMAIL_VERIFICATION_ATTEMPTS_PROPERTY, EMAIL_VERIFICATION_EMAIL_TIME, EMAIL_VERIFICATION_EMAIL_TIME_PROPERTY, EMAIL_VERIFICATION_KEY, EMAIL_VERIFICATION_KEY_PROPERTY, EMAIL_VERIFICATION_STATUS, EMAIL_VERIFICATION_STATUS_PROPERTY, ERROR_LOG, ERROR_LOG_PROPERTY, EVENT_LOG, EVENT_LOG_PROPERTY, EXTERNAL_PROFILE_ID, EXTERNAL_PROFILE_ID_PROPERTY, EXTERNAL_USER_ID, EXTERNAL_USER_ID_PROPERTY, EXTRACT_JSON, EXTRACT_JSON_PROPERTY, EXTRACT_SEARCH, EXTRACT_SEARCH_PROPERTY, FIELD_WORKER_FLAG, FIELD_WORKER_FLAG_PROPERTY, FILE_UPLOADS, FILE_UPLOADS_PROPERTY, FORM, FORM_PROPERTY, FORM_STARTED_FLAG, FORM_STARTED_FLAG_PROPERTY, FORM_STATUS, FORM_STATUS_PROPERTY, FORM_SUBMIT_HASH, FORM_SUBMIT_HASH_PROPERTY, FORM_TYPE, FORM_TYPE_PROPERTY, FORM_XML_HASH, FORM_XML_HASH_PROPERTY, GROOVY_SERVICE_LOG, GROOVY_SERVICE_LOG_PROPERTY, HOST_CONTEXT, HOST_CONTEXT_PROPERTY, IN_FORM_ATTACHMENTS_FLAG, IN_FORM_ATTACHMENTS_FLAG_PROPERTY, INSIGHTS_FLAG, INSIGHTS_FLAG_PROPERTY, INTERNAL_TXN_FLAG, INTERNAL_TXN_FLAG_PROPERTY, JOB, JOB_ACTION, JOB_ACTION_PROPERTY, JOB_DELIVERY_REQUIRED_FLAG, JOB_DELIVERY_REQUIRED_FLAG_PROPERTY, JOB_PROPERTY, KEYSTORE, KEYSTORE_PROPERTY, MAX_DELIVERY_ATTEMPTS, MAX_DELIVERY_ATTEMPTS_PROPERTY, MILESTONES, MILESTONES_PROPERTY, NEXT_DELIVERY_TIME, NEXT_DELIVERY_TIME_PROPERTY, NEXT_RECEIPT_RENDER_TIME, NEXT_RECEIPT_RENDER_TIME_PROPERTY, PAYMENT_ITEMS, PAYMENT_ITEMS_PROPERTY, PAYMENT_STATUS, PAYMENT_STATUS_PROPERTY, PAYMENT_TOTAL, PAYMENT_TOTAL_PROPERTY, PAYMENT_TYPE, PAYMENT_TYPE_PROPERTY, PAYMENTS, PAYMENTS_PROPERTY, PDF_SUBMIT_FLAG, PDF_SUBMIT_FLAG_PROPERTY, PORTAL, PORTAL_PROPERTY, PREVIOUS_SUBMISSION, PREVIOUS_SUBMISSION_PROPERTY, PROCESSING_STATUSES, PROCESSING_STATUSES_PROPERTY, PROPERTY_SEARCH, PROPERTY_SEARCH_PROPERTY, PURGE_TIME, PURGE_TIME_DATA_DELIVERED, PURGE_TIME_DATA_DELIVERED_PROPERTY, PURGE_TIME_PROPERTY, RECEIPT_NUMBER, RECEIPT_NUMBER_PROPERTY, RECEIPT_RENDER_ATTEMPTS, RECEIPT_RENDER_ATTEMPTS_PROPERTY, RECEIPT_RENDER_DURATION, RECEIPT_RENDER_DURATION_PROPERTY, RECEIPT_RENDER_TIME, RECEIPT_RENDER_TIME_PROPERTY, RECEIPT_STATUS, RECEIPT_STATUS_PROPERTY, REQUEST_LOGS, REQUEST_LOGS_PROPERTY, REQUIRED_ATTACHMENTS, REQUIRED_ATTACHMENTS_PROPERTY, REVISION_NUMBER, REVISION_NUMBER_PROPERTY, SAVE_ABANDON_SCHEDULED_TIME, SAVE_ABANDON_SCHEDULED_TIME_PROPERTY, SAVE_CHALLENGE_FAILURES, SAVE_CHALLENGE_FAILURES_PROPERTY, SAVE_CHALLENGE_HASH, SAVE_CHALLENGE_HASH_PROPERTY, SAVE_CHALLENGE_LAST_FAILURE, SAVE_CHALLENGE_LAST_FAILURE_PROPERTY, SAVE_CHALLENGE_RENDER_FLAG, SAVE_CHALLENGE_RENDER_FLAG_PROPERTY, SAVE_CHALLENGE_TIMEOUT, SAVE_CHALLENGE_TIMEOUT_PROPERTY, SENT_COMPLETED_EMAIL_TO, SENT_COMPLETED_EMAIL_TO_PROPERTY, SENT_SAVED_EMAIL_TO, SENT_SAVED_EMAIL_TO_PROPERTY, SESSION_ID, SESSION_ID_PROPERTY, SIGNATURE_COMPLETED_TIME, SIGNATURE_COMPLETED_TIME_PROPERTY, SIGNATURE_RECEIPT_FLAG, SIGNATURE_RECEIPT_FLAG_PROPERTY, SIGNATURE_STATUS, SIGNATURE_STATUS_PROPERTY, SIGNATURE_TYPE, SIGNATURE_TYPE_PROPERTY, STORAGE_ENCODING_FORM_XML, STORAGE_ENCODING_FORM_XML_PROPERTY, STORAGE_ENCODING_RECEIPT, STORAGE_ENCODING_RECEIPT_PROPERTY, STORAGE_ENCODING_SIGNATURE, STORAGE_ENCODING_SIGNATURE_PROPERTY, STORAGE_SERVICE, STORAGE_SERVICE_PROPERTY, STORAGE_URL_FORM_XML, STORAGE_URL_FORM_XML_PROPERTY, STORAGE_URL_RECEIPT, STORAGE_URL_RECEIPT_PROPERTY, STORAGE_URL_SIGNATURE, STORAGE_URL_SIGNATURE_PROPERTY, SUBMISSION_DATA, SUBMISSION_DATA_PROPERTY, SUBMISSION_EXPIRY_DATE, SUBMISSION_EXPIRY_DATE_PROPERTY, SUBMISSION_EXTRACT_DATA, SUBMISSION_EXTRACT_DATA_PROPERTY, SUBMISSION_GROUP, SUBMISSION_GROUP_PROPERTY, SUBMISSION_HISTORY, SUBMISSION_HISTORY_PROPERTY, SUBMISSION_OID_PK_COLUMN, SUBMISSION_PROPERTIES, SUBMISSION_PROPERTIES_PROPERTY, SUBMISSION_SERVICE_LOGS, SUBMISSION_SERVICE_LOGS_PROPERTY, SUBMISSION_VALIDATION_ERRORS, SUBMISSION_VALIDATION_ERRORS_PROPERTY, SUBMIT_KEY, SUBMIT_KEY_PROPERTY, SUBMITTED_OFFLINE_FLAG, SUBMITTED_OFFLINE_FLAG_PROPERTY, SUBSEQUENT_SUBMISSIONS, SUBSEQUENT_SUBMISSIONS_PROPERTY, TASK_ADDRESS, TASK_ADDRESS_PROPERTY, TASK_ALLOW_CLAIM_FLAG, TASK_ALLOW_CLAIM_FLAG_PROPERTY, TASK_ASSIGNED_TIMESTAMP, TASK_ASSIGNED_TIMESTAMP_PROPERTY, TASK_CLAIMED_FLAG, TASK_CLAIMED_FLAG_PROPERTY, TASK_CLAIMED_TIMESTAMP, TASK_CLAIMED_TIMESTAMP_PROPERTY, TASK_CREATED_TIMESTAMP, TASK_CREATED_TIMESTAMP_PROPERTY, TASK_EMAIL_FLAG, TASK_EMAIL_FLAG_PROPERTY, TASK_EXPIRY_PROCESS_ATTEMPTS, TASK_EXPIRY_PROCESS_ATTEMPTS_PROPERTY, TASK_EXPIRY_PROCESS_STATUS, TASK_EXPIRY_PROCESS_STATUS_PROPERTY, TASK_EXPIRY_TIMESTAMP, TASK_EXPIRY_TIMESTAMP_PROPERTY, TASK_KEY, TASK_KEY_PROPERTY, TASK_LATITUDE, TASK_LATITUDE_PROPERTY, TASK_LONGITUDE, TASK_LONGITUDE_PROPERTY, TASK_SCHEDULED_TIMESTAMP, TASK_SCHEDULED_TIMESTAMP_PROPERTY, TASK_SEQUENCE, TASK_SEQUENCE_PROPERTY, TASK_SUBJECT, TASK_SUBJECT_PROPERTY, TASK_TYPE, TASK_TYPE_PROPERTY, TASK_USER_DELETABLE_FLAG, TASK_USER_DELETABLE_FLAG_PROPERTY, TEST_MODE, TEST_MODE_PROPERTY, TIME_EMAIL_VERIFICATION_COMPLETED, TIME_EMAIL_VERIFICATION_COMPLETED_PROPERTY, TIME_FORM_COMPLETED, TIME_FORM_COMPLETED_PROPERTY, TIME_LAST_USER_ACTIVITY, TIME_LAST_USER_ACTIVITY_PROPERTY, TIME_REQUEST, TIME_REQUEST_PROPERTY, TIME_SUBMISSION, TIME_SUBMISSION_PROPERTY, TIME_TO_SUBMIT_SEC, TIME_TO_SUBMIT_SEC_PROPERTY, TRACKING_NUMBER, TRACKING_NUMBER_PROPERTY, TRANS_HISTORY_CREATED_FLAG, TRANS_HISTORY_CREATED_FLAG_PROPERTY, TRANS_REF_NUMBER, TRANS_REF_NUMBER_PROPERTY, TRANSACTION_SCORE, TRANSACTION_SCORE_PROPERTY, TRANSACTION_VALUE, TRANSACTION_VALUE_PROPERTY, USER, USER_AGENT_DEVICE_TYPE, USER_AGENT_DEVICE_TYPE_PROPERTY, USER_LOGIN_NAME, USER_LOGIN_NAME_PROPERTY, USER_PROFILE, USER_PROFILE_PROPERTY, USER_PROPERTY, USER_SAVED_FLAG, USER_SAVED_FLAG_PROPERTY, VERSION, VERSION_PROPERTY

Fields inherited from class com.avoka.core.entity.BaseEntity
ID_PROPERTY

Fields inherited from class org.apache.cayenne.CayenneDataObject
values

Fields inherited from class org.apache.cayenne.BaseDataObject
snapshotVersion

Fields inherited from class org.apache.cayenne.PersistentObject
objectContext, objectId, persistenceState

Fields inherited from interface org.apache.cayenne.DataObject
DEFAULT_VERSION

Constructor Summary

Constructors
Constructor Description

Submission()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getAbandonmentReason()`	Return the abandonmentReason value.
`String`	`getClientCode()`	Return the clientCode value.
`String`	`getClientName()`	Return the clientName value.
`String`	`getContentLength()`	Return the contentLength value.
`String`	`getContentType()`	Return the contentType value.
`RequestLog`	`getCurrentFormRequestLog()`	Return the most recent form request log associated with the submission.
`RequestLog`	`getCurrentRequestLog()`	Return the most recent form or receipt request log associated with the submission.
`Map<String,String>`	`getDataExtractMap()`	Return submission data extract map (name/value).
`String`	`getDataValidationMessage()`	Return the dataValidationMessage value.
`ServerNode`	`getDeliveryServer()`	Deprecated.
`Integer`	`getDurationClientResponse()`	Return the durationClientResponse value.
`Integer`	`getDurationRender()`	Return the durationRender value.
`Integer`	`getDurationTotal()`	Return the durationTotal value.
`Date`	`getFieldworkerSyncTime()`	Deprecated.
`String`	`getFormAbandonmentType()`	Return the form abandonment type [ Bounced \| Started \| Cancelled \| Submitted \| Saved \| Assigned \| Expired] if the form status is "Abandoned", or null otherwise
`String`	`getFormCode()`	Return the formCode value.
`Map<String,String>`	`getFormDataMap()`	Return the Form Data Map for the submission based on the submission extract data.
`String`	`getFormName()`	Return the formName value.
`String`	`getIpAddress()`	Return the ipAddress value.
`String`	`getOfflineSubmitKey()`	Return the offlineSubmitKey value.
`Integer`	`getPercentageCompleted()`	Return the percentageCompleted value.
`ServerNode`	`getPortalServer()`	Deprecated.
`String`	`getPortalServerName()`	Deprecated.
`String`	`getProcessingStatus()`	Return the processingStatus value.
`Date`	`getProcessingStatusTime()`	Return the processingStatusTime value.
`String`	`getReferer()`	Return the referer value.
`String`	`getRequestCookie()`	Return the requestCookie value.
`String`	`getRequestUrl()`	Return the requestUrl value.
`Map<String,RequiredAttachment>`	`getRequiredAttachmentMap()`	Return a map of submission required attachments (attachment name/required attachment).
`String`	`getSavedMessage()`	Return the savedMessage value.
`SubmissionData`	`getSubmissionData()`	Deprecated.
`String`	`getSubmissionGroupNames()`	Return the submission group names, sorted ascending.
`Set<String>`	`getSubmissionGroupNameSet()`	Return the set of names of the group(s) associated with the submission, or null if no group is assigned
`String`	`getSubmissionMessage()`	Return the submissionMessage value.
`String`	`getSubmissionPropertyValue(String name)`	Return the named submission property with the value or null if not defined.
`List<Submission>`	`getSubsequentTasks()`	Deprecated.
`String`	`getTaskEmailMessage()`	Return the taskEmailMessage value.
`String`	`getTaskEmailSubject()`	Return the taskEmailSubject value.
`String`	`getTaskGroupName()`	Deprecated. as of TM 4.1, tasks can be associated with multiple groups.
`String`	`getTaskMessage()`	Return the taskMessage value.
`String`	`getTrackingCode()`	Return the submission tracking number.
`String`	`getUrlSafeFormCode()`	Return the url encoded formCode value.
`String`	`getUserAgent()`	Return the userAgent value.
`String`	`getUserAgentBrowser()`
`String`	`getUserAgentBrowserType()`	Return the userAgentBrowserType value.Provided for backward compatibility.
`String`	`getUserAgentBrowserVersion()`	Return the userAgentBrowserVersion value.
`String`	`getUserAgentOs()`
`String`	`getUserAgentOsType()`	Return the userAgentOsType value.
`String`	`getUserAgentOsVersion()`	Return the userAgentOsVersion value.
`boolean`	`hasSaveChallengeHash()`
`boolean`	`hasSaveChallengeTimedOut()`	Return true if a save challenge timeout is defined and its value has timed out.
`void`	`incrementDeliveryProcessAttempts()`	Increment the number of delivery process attempts by one.
`void`	`incrementReceiptRenderAttempts()`	Increment the number of delivery process attempts by one.
`boolean`	`isAbandonmentTypeIneligible()`	Return whether this submission has been marked as ineligible.
`boolean`	`isAssociatedWithPortal(Portal portal)`	Return whether the submission is associated with the given portal
`boolean`	`isAttachmentsCompleted()`	Return whether attachments have been completed
`boolean`	`isAttachmentsOptional()`	Return whether all mandatory attachments have been completed. Note: Even after completing mandatory attachments, the user has to explicitly confirm that have finished working on the attachments - otherwise, the submission will not progress.
`boolean`	`isAttachmentsOutstanding()`	Return whether attachments are still outstanding
`boolean`	`isAuthenticationCancelled()`	Return whether the user has rejected an unauthenticated submission
`boolean`	`isAuthenticationCompleted()`	Return whether the user has logged on to acknowledge a submission
`boolean`	`isAuthenticationRequired()`	Return whether the user needs to log on to acknowledge a submission
`boolean`	`isDataValidationError()`	Return true if a submission data validation error has occurred.
`boolean`	`isDeliveryCompleted()`	Return whether submission delivery has been completed
`boolean`	`isDeliveryConfigured()`	Return whether delivery details are configured for the submission.
`boolean`	`isDeliveryError()`	Return whether an error occurred during submission delivery
`boolean`	`isDeliveryInProgress()`	Return whether the submission is delivery is in progress
`boolean`	`isDeliveryNotReady()`	Return whether the submission is not ready for delivery (generally due to outstanding user work)
`boolean`	`isDeliveryNotRequired()`	Return whether the submission delivery is not required
`boolean`	`isDeliveryPending()`	Return whether the submission is delivery is pending
`boolean`	`isDeliveryReady()`	Return whether the submission is ready to be delivered
`boolean`	`isEmailVerificationAbandoned()`	Return whether submission email verification has been abandoned
`boolean`	`isEmailVerificationCompleted()`	Return whether submission email verification has been completed
`boolean`	`isEmailVerificationOutstanding()`	Return whether submission email verification is outstanding
`boolean`	`isEmailVerificationRequired()`	Return whether submission email verification is required (meaning the initial email has not yet been sent)
`boolean`	`isESignatureCancelled()`	Deprecated.
`boolean`	`isESignatureCompleted()`	Deprecated.
`boolean`	`isESignatureRequired()`	Deprecated.
`boolean`	`isFormAbandoned()`	Return whether the form status is abandoned
`boolean`	`isFormAssigned()`	Return whether the submission is currently assigned.
`boolean`	`isFormCancelledByAdministrator()`	Return true if the Undeliverable flag was used to force submissions to be cancelled
`boolean`	`isFormCompleted()`	Return whether the form status is completed
`boolean`	`isFormExpired()`	Return whether the form status is expired
`boolean`	`isFormOpenAbandoned()`	Return true if the form status is Abandoned and form abandonment status is Opened.
`boolean`	`isFormOpened()`	Return whether the form is currently opened.
`boolean`	`isFormSaved()`	Return whether the form is currently saved.
`boolean`	`isFormStartAbandoned()`	Return true if the form status is Abandoned and form abandonment status is Saved and is not user save.
`boolean`	`isFormSubmitted()`	Return whether the form has been submitted
`boolean`	`isFormTaskSubmission()`	Return whether this submission is based on a form task
`boolean`	`isHostContextIFrame()`	Return whether the form host context is 'IFrame'
`boolean`	`isJobFormEditable()`	Return true if submission job form is editable.
`boolean`	`isJobSubmissionWithProcessImmediate()`	Deprecated. do not use; this will be removed in a future release Please instead use this check: getJob() != null && getJob().isProcessImmediateFlag()
`boolean`	`isLcDsigSubmission()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isLcFormsSubmission()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isLcOutputSubmission()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isLcProcessManagementSubmission()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isLcReaderExtensionsSubmission()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isPaymentCompleted()`	Return whether the payment has been completed
`boolean`	`isPaymentError()`	Return whether an error occurred during payment
`boolean`	`isPaymentOutstanding()`	Return whether payment is still outstanding
`boolean`	`isPaymentPending()`	Return whether the payment is pending confirmation
`boolean`	`isPaymentRequired()`	Return whether the submission requires payment
`boolean`	`isPaymentTypeBPAY()`	Return whether the submission payment type is "BPAY"
`boolean`	`isPaymentTypeCreditCard()`	Return whether the submission payment type is "Credit/Debit Card"
`boolean`	`isPaymentTypeEFT()`	Return whether the submission payment type is "EFT"
`boolean`	`isPaymentTypeHosted()`	Returns whether this submission requires payment via a hosted service (e.g.
`boolean`	`isReceiptCompleted()`	Return whether a receipt has been created for the submission
`boolean`	`isReceiptError()`	Return whether an error occurred during receipt generation
`boolean`	`isReceiptInProgress()`	Return whether the submission is in the process of being rendered by a background job
`boolean`	`isReceiptReady()`	Return whether the submission is ready for its receipt to be rendered
`boolean`	`isReviewTaskSubmission()`	Return whether this submission is based on a review task
`boolean`	`isSaveChallengeRender()`
`boolean`	`isSavedFormChallengeAnswerCorrect(String proposedAnswer)`	Compares a proposed challenge answer to the answer stored for the submission.
`boolean`	`isSignatureCompleted()`	Return whether signatures have been completed
`boolean`	`isSubmissionExpired()`	Return true if the submission expiry date is defined and this value is older than the current time.
`boolean`	`isTaskSubmission()`	Return whether this submission is based on a task
`boolean`	`isUndeliverable()`	Return whether the submission has been marked as undeliverable
`boolean`	`isUserWorkCompleted()`	Return whether the user has completed everything about the submission (i.e.
`boolean`	`isUserWorkCompletedExcludingAuthentication()`	TODO: LP to check-in proper method
`boolean`	`isWetSignatureRequired()`	Return whether wet signatures are required
`void`	`setAbandonmentReason(String abandonmentReason)`	Set the abandonmentReason value.
`void`	`setDataValidationMessage(String dataValidationMessage)`	Set the dataValidationMessage value.
`void`	`setJobSubmissionWithProcessImmediate(boolean isJobWithImmediateProcessing)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcDsigSubmission(boolean isLcDsigSubmission)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcFormsSubmission(boolean isLcFormsSubmission)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcOutputSubmission(boolean isLcOutputSubmission)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcProcessManagementSubmission(boolean isLcPmSubmission)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcReaderExtensionsSubmission(boolean isLcReSubmission)`	Deprecated. do not use; this will be removed in a future release
`void`	`setReceiptErrorProgressiveRetryDelay()`	Set the receipt render error progressive retry delay.
`void`	`setSaveChallengeAnswer(String rawChallengeAnswer)`	Processes the challenge answer and stores the hash value.
`void`	`setSavedMessage(String savedMessage)`	Set the savedMessage value.
`void`	`setSubmissionData(SubmissionData submissionData)`	Deprecated.
`void`	`setSubmissionMessage(String submissionMessage)`	Set the submissionMessage value.
`void`	`setSubmissionPropertyValue(String name, String value)`	Deprecated.
`void`	`setSubmissionPropertyValue(String name, String value, boolean encrypted)`	Set the named submission property with the given value, or create a new submission property if it does not exist.
`void`	`setTaskEmailMessage(String taskEmailMessage)`	Set the taskEmailMessage value.
`void`	`setTaskEmailSubject(String taskEmailSubject)`	Set the taskEmailSubject value.
`void`	`setTaskMessage(String taskMessage)`	Set the taskMessage value.
`void`	`setTrackingNumber(String trackingNumber)`	Set the trackingNumber value, trimming and converting any value to upper case.
`void`	`setVersion(TemplateVersion version)`	Set the form version.

Methods inherited from class com.avoka.fc.core.entity.auto._Submission
addToAsyncMsgs, addToAttachments, addToAttributes, addToAuditLogs, addToComments, addToDeliveryCheckpoints, addToDeliveryFunctions, addToEmailQueueItems, addToErrorLog, addToEventLog, addToExtractSearch, addToFileUploads, addToGroovyServiceLog, addToMilestones, addToPaymentItems, addToPayments, addToProcessingStatuses, addToPropertySearch, addToRequestLogs, addToRequiredAttachments, addToSubmissionExtractData, addToSubmissionGroup, addToSubmissionHistory, addToSubmissionProperties, addToSubmissionServiceLogs, addToSubmissionValidationErrors, addToSubsequentSubmissions, getAbandonmentFormStatus, getAbandonmentTimestamp, getAbandonmentType, getAdobeVersion, getAsyncMsgs, getAttachments, getAttachmentsStatus, getAttributes, getAuditLogs, getAuthenticationStatus, getBpayBillerCode, getBpayReferenceNumber, getClient, getComments, getContactAge, getContactEmailAddress, getContactGender, getContactPhone, getContactPostcode, getCreatedUsername, getDataValidationStatus, getDeletedTimestamp, getDeliveryCheckpoints, getDeliveryDetails, getDeliveryErrorLog, getDeliveryFunctions, getDeliveryInvocationId, getDeliveryMessage, getDeliveryMethod, getDeliveryProcessAttempts, getDeliveryProcessId, getDeliveryStatus, getDeliveryTime, getEmailQueueItems, getEmailVerificationAttempts, getEmailVerificationEmailTime, getEmailVerificationKey, getEmailVerificationStatus, getErrorLog, getEventLog, getExternalProfileId, getExternalUserId, getExtractJson, getExtractSearch, getFileUploads, getForm, getFormStatus, getFormSubmitHash, getFormType, getFormXmlHash, getGroovyServiceLog, getHostContext, getJob, getJobAction, getKeystore, getMaxDeliveryAttempts, getMilestones, getNextDeliveryTime, getNextReceiptRenderTime, getPaymentItems, getPayments, getPaymentStatus, getPaymentTotal, getPaymentType, getPortal, getPreviousSubmission, getProcessingStatuses, getPropertySearch, getPurgeTime, getPurgeTimeDataDelivered, getReceiptNumber, getReceiptRenderAttempts, getReceiptRenderDuration, getReceiptRenderTime, getReceiptStatus, getRequestLogs, getRequiredAttachments, getRevisionNumber, getSaveAbandonScheduledTime, getSaveChallengeFailures, getSaveChallengeHash, getSaveChallengeLastFailure, getSaveChallengeRenderFlag, getSaveChallengeTimeout, getSentCompletedEmailTo, getSentSavedEmailTo, getSessionId, getSignatureCompletedTime, getSignatureStatus, getSignatureType, getStorageEncodingFormXml, getStorageEncodingReceipt, getStorageEncodingSignature, getStorageService, getStorageUrlFormXml, getStorageUrlReceipt, getStorageUrlSignature, getSubmissionExpiryDate, getSubmissionExtractData, getSubmissionGroup, getSubmissionHistory, getSubmissionProperties, getSubmissionServiceLogs, getSubmissionValidationErrors, getSubmitKey, getSubsequentSubmissions, getTaskAddress, getTaskAssignedTimestamp, getTaskClaimedTimestamp, getTaskCreatedTimestamp, getTaskExpiryProcessAttempts, getTaskExpiryProcessStatus, getTaskExpiryTimestamp, getTaskKey, getTaskLatitude, getTaskLongitude, getTaskScheduledTimestamp, getTaskSequence, getTaskSubject, getTaskType, getTimeEmailVerificationCompleted, getTimeFormCompleted, getTimeLastUserActivity, getTimeRequest, getTimeSubmission, getTimeToSubmitSec, getTrackingNumber, getTransactionScore, getTransactionValue, getTransRefNumber, getUser, getUserAgentDeviceType, getUserLoginName, getUserProfile, getVersion, isDeletedFlag, isFieldWorkerFlag, isFormStartedFlag, isInFormAttachmentsFlag, isInsightsFlag, isInternalTxnFlag, isJobDeliveryRequiredFlag, isPdfSubmitFlag, isSignatureReceiptFlag, isSubmittedOfflineFlag, isTaskAllowClaimFlag, isTaskClaimedFlag, isTaskEmailFlag, isTaskUserDeletableFlag, isTestMode, isTransHistoryCreatedFlag, isUserSavedFlag, removeFromAsyncMsgs, removeFromAttachments, removeFromAttributes, removeFromAuditLogs, removeFromComments, removeFromDeliveryCheckpoints, removeFromDeliveryFunctions, removeFromEmailQueueItems, removeFromErrorLog, removeFromEventLog, removeFromExtractSearch, removeFromFileUploads, removeFromGroovyServiceLog, removeFromMilestones, removeFromPaymentItems, removeFromPayments, removeFromProcessingStatuses, removeFromPropertySearch, removeFromRequestLogs, removeFromRequiredAttachments, removeFromSubmissionExtractData, removeFromSubmissionGroup, removeFromSubmissionHistory, removeFromSubmissionProperties, removeFromSubmissionServiceLogs, removeFromSubmissionValidationErrors, removeFromSubsequentSubmissions, setAbandonmentFormStatus, setAbandonmentTimestamp, setAbandonmentType, setAdobeVersion, setAttachmentsStatus, setAuthenticationStatus, setBpayBillerCode, setBpayReferenceNumber, setClient, setContactAge, setContactEmailAddress, setContactGender, setContactPhone, setContactPostcode, setCreatedUsername, setDataValidationStatus, setDeletedFlag, setDeletedTimestamp, setDeliveryDetails, setDeliveryErrorLog, setDeliveryInvocationId, setDeliveryMessage, setDeliveryMethod, setDeliveryProcessAttempts, setDeliveryProcessId, setDeliveryStatus, setDeliveryTime, setEmailVerificationAttempts, setEmailVerificationEmailTime, setEmailVerificationKey, setEmailVerificationStatus, setExternalProfileId, setExternalUserId, setExtractJson, setFieldWorkerFlag, setForm, setFormStartedFlag, setFormStatus, setFormSubmitHash, setFormType, setFormXmlHash, setHostContext, setInFormAttachmentsFlag, setInsightsFlag, setInternalTxnFlag, setJob, setJobAction, setJobDeliveryRequiredFlag, setKeystore, setMaxDeliveryAttempts, setNextDeliveryTime, setNextReceiptRenderTime, setPaymentStatus, setPaymentTotal, setPaymentType, setPdfSubmitFlag, setPortal, setPreviousSubmission, setPurgeTime, setPurgeTimeDataDelivered, setReceiptNumber, setReceiptRenderAttempts, setReceiptRenderDuration, setReceiptRenderTime, setReceiptStatus, setRevisionNumber, setSaveAbandonScheduledTime, setSaveChallengeFailures, setSaveChallengeHash, setSaveChallengeLastFailure, setSaveChallengeRenderFlag, setSaveChallengeTimeout, setSentCompletedEmailTo, setSentSavedEmailTo, setSessionId, setSignatureCompletedTime, setSignatureReceiptFlag, setSignatureStatus, setSignatureType, setStorageEncodingFormXml, setStorageEncodingReceipt, setStorageEncodingSignature, setStorageService, setStorageUrlFormXml, setStorageUrlReceipt, setStorageUrlSignature, setSubmissionExpiryDate, setSubmitKey, setSubmittedOfflineFlag, setTaskAddress, setTaskAllowClaimFlag, setTaskAssignedTimestamp, setTaskClaimedFlag, setTaskClaimedTimestamp, setTaskCreatedTimestamp, setTaskEmailFlag, setTaskExpiryProcessAttempts, setTaskExpiryProcessStatus, setTaskExpiryTimestamp, setTaskKey, setTaskLatitude, setTaskLongitude, setTaskScheduledTimestamp, setTaskSequence, setTaskSubject, setTaskType, setTaskUserDeletableFlag, setTestMode, setTimeEmailVerificationCompleted, setTimeFormCompleted, setTimeLastUserActivity, setTimeRequest, setTimeSubmission, setTimeToSubmitSec, setTransactionScore, setTransactionValue, setTransHistoryCreatedFlag, setTransRefNumber, setUser, setUserAgentDeviceType, setUserLoginName, setUserProfile, setUserSavedFlag

Methods inherited from class com.avoka.core.entity.BaseEntity
appendProperties, getId, getValuesMap, isNew, setId, toString

Methods inherited from class org.apache.cayenne.CayenneDataObject
makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState

Methods inherited from class org.apache.cayenne.BaseDataObject
addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized

Methods inherited from class org.apache.cayenne.PersistentObject
getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId

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

Methods inherited from interface org.apache.cayenne.Persistent
getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

- Field Detail
  - ABANDONMENT_REASON_PROPERTY
```
public static final String ABANDONMENT_REASON_PROPERTY
```
    Provides the 'abandonmentReason' property name.
    
    See Also:
    
    Constant Field Values
  - CLIENT_CODE_PROPERTY
```
public static final String CLIENT_CODE_PROPERTY
```
    Provides the 'clientCode' property name.
    
    See Also:
    
    Constant Field Values
  - CLIENT_NAME_PROPERTY
```
public static final String CLIENT_NAME_PROPERTY
```
    Provides the 'clientName' property name.
    
    See Also:
    
    Constant Field Values
  - DATA_VALIDATION_MESSAGE_PROPERTY
```
public static final String DATA_VALIDATION_MESSAGE_PROPERTY
```
    Provides the 'dataValidationMessage' property name.
    
    See Also:
    
    Constant Field Values
  - FORM_CODE_PROPERTY
```
public static final String FORM_CODE_PROPERTY
```
    Provides the 'formCode' property name.
    
    See Also:
    
    Constant Field Values
  - FORM_NAME_PROPERTY
```
public static final String FORM_NAME_PROPERTY
```
    Provides the 'formName' property name.
    
    See Also:
    
    Constant Field Values
  - IP_ADDRESS_PROPERTY
```
public static final String IP_ADDRESS_PROPERTY
```
    Provides the 'ipAddress' property name.
    
    See Also:
    
    Constant Field Values
  - PERCENTAGE_COMPLETED_PROPERTY
```
public static final String PERCENTAGE_COMPLETED_PROPERTY
```
    Provides the 'percentageCompleted' property name.
    
    See Also:
    
    Constant Field Values
  - PROCESSING_STATUS_PROPERTY
```
public static final String PROCESSING_STATUS_PROPERTY
```
    Provides the 'processingStatus' property name.
    
    See Also:
    
    Constant Field Values
  - PROCESSING_STATUS_TIME_PROPERTY
```
public static final String PROCESSING_STATUS_TIME_PROPERTY
```
    Provides the 'processingStatusTime' property name.
    
    See Also:
    
    Constant Field Values
  - REFERER_PROPERTY
```
public static final String REFERER_PROPERTY
```
    Provides the 'referer' property name.
    
    See Also:
    
    Constant Field Values
  - REQUEST_COOKIE_PROPERTY
```
public static final String REQUEST_COOKIE_PROPERTY
```
    Provides the 'requestCookie' property name.
    
    See Also:
    
    Constant Field Values
  - REQUEST_URL_PROPERTY
```
public static final String REQUEST_URL_PROPERTY
```
    Provides the 'requestUrl' property name.
    
    See Also:
    
    Constant Field Values
  - SAVED_MESSAGE_PROPERTY
```
public static final String SAVED_MESSAGE_PROPERTY
```
    Provides the 'savedMessage' property name.
    
    See Also:
    
    Constant Field Values
  - SUBMISSION_MESSAGE_PROPERTY
```
public static final String SUBMISSION_MESSAGE_PROPERTY
```
    Provides the 'submissionMessage' property name.
    
    See Also:
    
    Constant Field Values
  - TASK_EMAIL_SUBJECT_PROPERTY
```
public static final String TASK_EMAIL_SUBJECT_PROPERTY
```
    Provides the 'taskEmailSubject' property name.
    
    See Also:
    
    Constant Field Values
  - TASK_EMAIL_MESSAGE_PROPERTY
```
public static final String TASK_EMAIL_MESSAGE_PROPERTY
```
    Provides the 'taskEmailMessage' property name.
    
    See Also:
    
    Constant Field Values
  - TASK_MESSAGE_PROPERTY
```
public static final String TASK_MESSAGE_PROPERTY
```
    Provides the 'taskMessage' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_PROPERTY
```
public static final String USER_AGENT_PROPERTY
```
    Provides the 'userAgent' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_BROWSER_TYPE_PROPERTY
```
public static final String USER_AGENT_BROWSER_TYPE_PROPERTY
```
    Provides the 'userAgentBrowserType' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_BROWSER_VERSION_PROPERTY
```
public static final String USER_AGENT_BROWSER_VERSION_PROPERTY
```
    Provides the 'userAgentBrowserVersion' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_OS_TYPE_PROPERTY
```
public static final String USER_AGENT_OS_TYPE_PROPERTY
```
    Provides the 'userAgentOsType' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_OS_VERSION_PROPERTY
```
public static final String USER_AGENT_OS_VERSION_PROPERTY
```
    Provides the 'userAgentOsVersion' property name.
    
    See Also:
    
    Constant Field Values
  - TASK_GROUP_NAME_PROPERTY
```
@Deprecated
public static final String TASK_GROUP_NAME_PROPERTY
```
    Deprecated.
    as of TM 4.1, tasks can be associated with multiple groups. Use SUBMISSION_GROUP_NAMES_PROPERTY instead.
    
    An auxiliary property combining the name of the assignee group for task submissions
    
    See Also:
    
    Constant Field Values
  - SUBMISSION_GROUP_NAMES_PROPERTY
```
public static final String SUBMISSION_GROUP_NAMES_PROPERTY
```
    An auxiliary property listing the names of all groups associated with a submission
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_BROWSER_PROPERTY
```
public static final String USER_AGENT_BROWSER_PROPERTY
```
    An auxiliary property combining all available information about the user's browser
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_OS_PROPERTY
```
public static final String USER_AGENT_OS_PROPERTY
```
    An auxiliary property combining all available information about the user's operating system
    
    See Also:
    
    Constant Field Values
  - STATUS_Assigned
```
public static final String STATUS_Assigned
```
    Provides an "Assigned" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Opened
```
public static final String STATUS_Opened
```
    Provides a "Opended" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Saved
```
public static final String STATUS_Saved
```
    Provides a "Saved" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Abandoned
```
public static final String STATUS_Abandoned
```
    Provides an "Abandoned" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Submitted
```
public static final String STATUS_Submitted
```
    Provides a "Submitted" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Required
```
public static final String STATUS_Required
```
    Provides a "Required" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Optional
```
public static final String STATUS_Optional
```
    Provides an "Optional" status
    
    See Also:
    
    Constant Field Values
  - STATUS_In_Progress
```
public static final String STATUS_In_Progress
```
    Provides an "In Progress" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Pending
```
public static final String STATUS_Pending
```
    Provides an "Pending" status
    
    See Also:
    
    Constant Field Values
  - STATUS_NotReady
```
public static final String STATUS_NotReady
```
    Provides a "Not Ready" status
    
    See Also:
    
    Constant Field Values
  - STATUS_NotRequired
```
public static final String STATUS_NotRequired
```
    Provides a "Not Ready" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Ready
```
public static final String STATUS_Ready
```
    Provides a "Ready" status
    
    See Also:
    
    Constant Field Values
  - STATUS_DetailsRequired
```
public static final String STATUS_DetailsRequired
```
    Provides a "Details Required" status
    
    See Also:
    
    Constant Field Values
  - STATUS_PaymentRequired
```
public static final String STATUS_PaymentRequired
```
    Provides a "Payment Required" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Sent_Email
```
public static final String STATUS_Sent_Email
```
    Provides a "Sent Email" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Completed
```
public static final String STATUS_Completed
```
    Provides a "Completed" status
    
    See Also:
    
    Constant Field Values
  - STATUS_COMPLETED_UPLOAD
```
public static final String STATUS_COMPLETED_UPLOAD
```
    Provides a "Completed - Upload Scanned Copy" status
    
    See Also:
    
    Constant Field Values
  - STATUS_COMPLETED_MANUALLY
```
public static final String STATUS_COMPLETED_MANUALLY
```
    Provides a "Completed - Deliver Manually" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Expired
```
public static final String STATUS_Expired
```
    Provides an "Expired" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Cancelled
```
public static final String STATUS_Cancelled
```
    Provides a "Cancelled" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Undeliverable
```
public static final String STATUS_Undeliverable
```
    Provides an "Undeliverable" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Error
```
public static final String STATUS_Error
```
    Provides an "Error" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Error_No_Data
```
public static final String STATUS_Error_No_Data
```
    Provides an "Error - No Data" status
    
    See Also:
    
    Constant Field Values
  - STATUS_Ineligible
```
public static final String STATUS_Ineligible
```
    Provides an "Ineligible" status
    
    See Also:
    
    Constant Field Values
  - TASK_TYPE_FORM
```
public static final String TASK_TYPE_FORM
```
    The Constant 'Form' Task Type.
    
    See Also:
    
    Constant Field Values
  - TASK_TYPE_REVIEW
```
public static final String TASK_TYPE_REVIEW
```
    The Constant 'Review' Task Type.
    
    See Also:
    
    Constant Field Values
  - PAYMENT_TYPE_BPAY
```
public static final String PAYMENT_TYPE_BPAY
```
    Indicates that the payment method "BPAY" was selected
    
    See Also:
    
    Constant Field Values
  - PAYMENT_TYPE_CreditCard
```
public static final String PAYMENT_TYPE_CreditCard
```
    Indicates that the payment method "Credit/Debit Card" was selected
    
    See Also:
    
    Constant Field Values
  - PAYMENT_TYPE_Hosted
```
public static final String PAYMENT_TYPE_Hosted
```
    Indicates that the payment method "Hosted" was selected
    
    See Also:
    
    Constant Field Values
  - PAYMENT_TYPE_EFT
```
public static final String PAYMENT_TYPE_EFT
```
    Indicates that the payment method "EFT" was selected
    
    See Also:
    
    Constant Field Values
  - PAYMENT_TYPE_Manual
```
public static final String PAYMENT_TYPE_Manual
```
    Indicates that the payment was completed manually.
    
    See Also:
    
    Constant Field Values
  - SIGNATURE_TYPE_DIGITAL
```
public static final String SIGNATURE_TYPE_DIGITAL
```
    Indicates that the form is to be digitally signed
    
    See Also:
    
    Constant Field Values
  - SIGNATURE_TYPE_ESIGNATURE
```
@Deprecated
public static final String SIGNATURE_TYPE_ESIGNATURE
```
    Deprecated.
    
    Indicates that the form is to be signed with eSignatures
    
    See Also:
    
    Constant Field Values
  - SIGNATURE_TYPE_WET
```
public static final String SIGNATURE_TYPE_WET
```
    Indicates that the form is to be signed with wet ink
    
    See Also:
    
    Constant Field Values
  - FORM_STATUS_VALUES
```
public static final String[] FORM_STATUS_VALUES
```
    The set of form status values
  - SUBMISSION_FORM_STATUS_VALUES
```
public static final String[] SUBMISSION_FORM_STATUS_VALUES
```
    The set of searchable submission form status values (the same as FORM_STATUS_VALUES excluding Assigned and Opened )
  - TASK_STATUS_VALUES
```
public static final String[] TASK_STATUS_VALUES
```
    The set of form status values relevant to tasks
  - ATTACHMENT_STATUS_VALUES
```
public static final String[] ATTACHMENT_STATUS_VALUES
```
    The set of attachment status values
  - PAYMENT_STATUS_VALUES
```
public static final String[] PAYMENT_STATUS_VALUES
```
    The set of payment status values
  - SIGNATURE_STATUS_VALUES
```
public static final String[] SIGNATURE_STATUS_VALUES
```
    The set of possible signature status values
  - DIGITAL_SIGNATURE_STATUS_VALUES
```
public static final String[] DIGITAL_SIGNATURE_STATUS_VALUES
```
    The set of possible digital signature status values
  - WET_SIGNATURE_STATUS_VALUES
```
public static final String[] WET_SIGNATURE_STATUS_VALUES
```
    The set of possible wet signature status values
  - RECEIPT_STATUS_VALUES
```
public static final String[] RECEIPT_STATUS_VALUES
```
    The set of receipt status values
  - DELIVERY_STATUS_VALUES
```
public static final String[] DELIVERY_STATUS_VALUES
```
    The set of delivery status values
  - EMAIL_VERIFICATION_STATUS_VALUES
```
public static final String[] EMAIL_VERIFICATION_STATUS_VALUES
```
    The set of email verification status values
  - TASK_TYPE_VALUES
```
public static final String[] TASK_TYPE_VALUES
```
    The set of task type values.
  - PAYMENT_TYPE_VALUES
```
public static final String[] PAYMENT_TYPE_VALUES
```
    The set of payment type values
  - SIGNATURE_TYPE_VALUES
```
public static final String[] SIGNATURE_TYPE_VALUES
```
    The set of signature type values
  - DELIVERY_WEB_SERVICE_PULL
```
public static final String DELIVERY_WEB_SERVICE_PULL
```
    Indicates that the delivery method is web service pull
    
    See Also:
    
    Constant Field Values
  - DELIVERY_EMAIL
```
public static final String DELIVERY_EMAIL
```
    Indicates that the delivery method is standard email
    
    See Also:
    
    Constant Field Values
  - DELIVERY_EMAIL_SECURE
```
public static final String DELIVERY_EMAIL_SECURE
```
    Indicates that the delivery method is secure email
    
    See Also:
    
    Constant Field Values
  - DELIVERY_PROCESS
```
public static final String DELIVERY_PROCESS
```
    Indicates that the delivery method is LiveCycle process delivery
    
    See Also:
    
    Constant Field Values
  - DELIVERY_MANUAL
```
public static final String DELIVERY_MANUAL
```
    Indicates that delivery was manually set to completed
    
    See Also:
    
    Constant Field Values
  - HOST_CONTEXT_FieldWorker
```
public static final String HOST_CONTEXT_FieldWorker
```
    The 'FieldWorker' form host context.
    
    See Also:
    
    Constant Field Values
  - HOST_CONTEXT_IFRAME
```
public static final String HOST_CONTEXT_IFRAME
```
    The 'IFrame' form host context.
    
    See Also:
    
    Constant Field Values
  - HOST_CONTEXT_PAGE
```
public static final String HOST_CONTEXT_PAGE
```
    The 'Page' form host context.
    
    See Also:
    
    Constant Field Values
  - LC_OUTPUT_FILTER
```
public static final int LC_OUTPUT_FILTER
```
    The bit filter for LC Output
    
    See Also:
    
    Constant Field Values
  - LC_FORMS_FILTER
```
public static final int LC_FORMS_FILTER
```
    The bit filter for LC Forms
    
    See Also:
    
    Constant Field Values
  - LC_DIGITAL_SIGNATURES_FILTER
```
public static final int LC_DIGITAL_SIGNATURES_FILTER
```
    The bit filter for LC Digital Signatures
    
    See Also:
    
    Constant Field Values
  - LC_READER_EXTENSIONS_FILTER
```
public static final int LC_READER_EXTENSIONS_FILTER
```
    The bit filter for LC Reader Extensions
    
    See Also:
    
    Constant Field Values
  - LC_PROCESS_MANAGEMENT_FILTER
```
public static final int LC_PROCESS_MANAGEMENT_FILTER
```
    The bit filter for LC Process Management
    
    See Also:
    
    Constant Field Values
  - JOB_PROCESS_IMMEDIATE_FILTER
```
public static final int JOB_PROCESS_IMMEDIATE_FILTER
```
    The bit filter for job-related submissions with immediate processing turned on
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Submission
```
public Submission()
```
- Method Detail
  - getTaskGroupName
```
@Deprecated
public String getTaskGroupName()
```
    Deprecated.
    as of TM 4.1, tasks can be associated with multiple groups. Please use getSubmissionGroupNameSet instead (which returns all group names regardless whether the submission is a task), or getSubmissionGroupNames.
    
    Return the name of the assignee group for task submissions, or null if no group is assigned or the submission is not based on a task
    
    Returns:
    
    the name of the task group
    
    Since:
    
    4.0.0
  - getSubmissionGroupNameSet
```
public Set<String> getSubmissionGroupNameSet()
```
    Return the set of names of the group(s) associated with the submission, or null if no group is assigned
    
    Returns:
    
    the set of group names
    
    Since:
    
    4.1.0
  - getSubmissionGroupNames
```
public String getSubmissionGroupNames()
```
    Return the submission group names, sorted ascending.
    
    Returns:
    
    the submission group names.
    
    Since:
    
    4.0.0
  - getUserAgentBrowser
```
public String getUserAgentBrowser()
```
    Returns:
    
    information about the user's browser
  - getUserAgentOs
```
public String getUserAgentOs()
```
    Returns:
    
    information about the user's os
  - isESignatureRequired
```
@Deprecated
public boolean isESignatureRequired()
```
    Deprecated.
    
    Returns:
    
    false
  - isESignatureCompleted
```
@Deprecated
public boolean isESignatureCompleted()
```
    Deprecated.
    
    Return whether electronic signatures have been completed
    
    Returns:
    
    true if the signature type is SIGNATURE_TYPE_ESIGNATURE and the signature status is STATUS_Completed
  - isESignatureCancelled
```
@Deprecated
public boolean isESignatureCancelled()
```
    Deprecated.
    
    Return whether electronic signatures have been cancelled
    
    Returns:
    
    true if the signature type is SIGNATURE_TYPE_ESIGNATURE and the signature status is STATUS_Cancelled
  - isWetSignatureRequired
```
public boolean isWetSignatureRequired()
```
    Return whether wet signatures are required
    
    Returns:
    
    true if the signature type is SIGNATURE_TYPE_WET and the signature status is STATUS_Required
  - isSignatureCompleted
```
public boolean isSignatureCompleted()
```
    Return whether signatures have been completed
    
    Returns:
    
    true if the signature status is STATUS_Completed, STATUS_COMPLETED_UPLOAD or STATUS_COMPLETED_MANUALLY
  - isEmailVerificationOutstanding
```
public boolean isEmailVerificationOutstanding()
```
    Return whether submission email verification is outstanding
    
    Returns:
    
    true if the email verification status is STATUS_Required, STATUS_Pending or STATUS_Error
  - isEmailVerificationRequired
```
public boolean isEmailVerificationRequired()
```
    Return whether submission email verification is required (meaning the initial email has not yet been sent)
    
    Returns:
    
    true if the email verification status is STATUS_Required
  - isEmailVerificationCompleted
```
public boolean isEmailVerificationCompleted()
```
    Return whether submission email verification has been completed
    
    Returns:
    
    true if the email verification status is STATUS_Completed
  - isEmailVerificationAbandoned
```
public boolean isEmailVerificationAbandoned()
```
    Return whether submission email verification has been abandoned
    
    Returns:
    
    true if the email verification status is STATUS_Abandoned
  - isDataValidationError
```
public boolean isDataValidationError()
```
    Return true if a submission data validation error has occurred.
    
    Returns:
    
    true if a submission data validation error has occurred
    
    Since:
    
    4.2.0
  - isFormCancelledByAdministrator
```
public boolean isFormCancelledByAdministrator()
```
    Return true if the Undeliverable flag was used to force submissions to be cancelled
    
    Returns:
    
    true if the delivery status is STATUS_Undeliverable and the form status is not STATUS_Completed
  - isFormAssigned
```
public boolean isFormAssigned()
```
    Return whether the submission is currently assigned.
    
    Returns:
    
    true if the form status is STATUS_Assigned
  - isFormOpened
```
public boolean isFormOpened()
```
    Return whether the form is currently opened.
    
    Returns:
    
    true if the form status is STATUS_Opened
  - isFormSaved
```
public boolean isFormSaved()
```
    Return whether the form is currently saved.
    
    Returns:
    
    true if the form status is STATUS_Saved
  - isFormSubmitted
```
public boolean isFormSubmitted()
```
    Return whether the form has been submitted
    
    Returns:
    
    true if the form status is STATUS_Submitted
  - isFormCompleted
```
public boolean isFormCompleted()
```
    Return whether the form status is completed
    
    Returns:
    
    true if the form status is STATUS_Completed
  - isFormExpired
```
public boolean isFormExpired()
```
    Return whether the form status is expired
    
    Returns:
    
    true if the form status is STATUS_Expired
  - isFormAbandoned
```
public boolean isFormAbandoned()
```
    Return whether the form status is abandoned
    
    Returns:
    
    true if the form status is STATUS_Abandoned
  - isFormOpenAbandoned
```
public boolean isFormOpenAbandoned()
```
    Return true if the form status is Abandoned and form abandonment status is Opened.
    
    Returns:
    
    true if the form status is Abandoned and form abandonment status is Opened
    
    Since:
    
    4.2.0
  - isFormStartAbandoned
```
public boolean isFormStartAbandoned()
```
    Return true if the form status is Abandoned and form abandonment status is Saved and is not user save.
    
    Returns:
    
    true if the form status is Abandoned and form abandonment status is Saved and is not user save.
    
    Since:
    
    4.3.3
  - getFormAbandonmentType
```
public String getFormAbandonmentType()
```
    Return the form abandonment type [ Bounced | Started | Cancelled | Submitted | Saved | Assigned | Expired] if the form status is "Abandoned", or null otherwise
    
    Returns:
    
    the form abandonment type [ Bounced | Started | Cancelled | Submitted | Saved | Assigned | Expired ]
    
    Since:
    
    5.0.0
  - isHostContextIFrame
```
public boolean isHostContextIFrame()
```
    Return whether the form host context is 'IFrame'
    
    Returns:
    
    true if the form host context is HOST_CONTEXT_IFRAME
  - isReceiptReady
```
public boolean isReceiptReady()
```
    Return whether the submission is ready for its receipt to be rendered
    
    Returns:
    
    true if the receipt status is STATUS_Ready
  - isReceiptInProgress
```
public boolean isReceiptInProgress()
```
    Return whether the submission is in the process of being rendered by a background job
    
    Returns:
    
    true if the receipt status is STATUS_In_Progress
    
    Since:
    
    4.3.4
  - isReceiptCompleted
```
public boolean isReceiptCompleted()
```
    Return whether a receipt has been created for the submission
    
    Returns:
    
    true if the receipt status is STATUS_Completed
  - isReceiptError
```
public boolean isReceiptError()
```
    Return whether an error occurred during receipt generation
    
    Returns:
    
    true if the receipt status is STATUS_Error
  - isPaymentRequired
```
public boolean isPaymentRequired()
```
    Return whether the submission requires payment
    
    Returns:
    
    true if the payment status is STATUS_Required
  - isPaymentError
```
public boolean isPaymentError()
```
    Return whether an error occurred during payment
    
    Returns:
    
    true if the payment status is STATUS_Error
  - isPaymentCompleted
```
public boolean isPaymentCompleted()
```
    Return whether the payment has been completed
    
    Returns:
    
    true if the payment status is STATUS_Completed
  - isPaymentPending
```
public boolean isPaymentPending()
```
    Return whether the payment is pending confirmation
    
    Returns:
    
    true if the payment status is STATUS_Pending
  - isPaymentOutstanding
```
public boolean isPaymentOutstanding()
```
    Return whether payment is still outstanding
    
    Returns:
    
    true if the payment status is STATUS_Required, STATUS_Error
  - isPaymentTypeBPAY
```
public boolean isPaymentTypeBPAY()
```
    Return whether the submission payment type is "BPAY"
    
    Returns:
    
    true if the payment type is PAYMENT_TYPE_BPAY
  - isPaymentTypeCreditCard
```
public boolean isPaymentTypeCreditCard()
```
    Return whether the submission payment type is "Credit/Debit Card"
    
    Returns:
    
    true if the payment type is PAYMENT_TYPE_CreditCard
  - isPaymentTypeHosted
```
public boolean isPaymentTypeHosted()
```
    Returns whether this submission requires payment via a hosted service (e.g. WestpacQuickWeb)
    
    Returns:
    
    true if the payment type is PAYMENT_TYPE_Hosted
  - isPaymentTypeEFT
```
public boolean isPaymentTypeEFT()
```
    Return whether the submission payment type is "EFT"
    
    Returns:
    
    true if the payment type is PAYMENT_TYPE_EFT
  - isDeliveryCompleted
```
public boolean isDeliveryCompleted()
```
    Return whether submission delivery has been completed
    
    Returns:
    
    true if the delivery status is STATUS_Completed
  - isDeliveryError
```
public boolean isDeliveryError()
```
    Return whether an error occurred during submission delivery
    
    Returns:
    
    true if the delivery status is STATUS_Error
  - isDeliveryReady
```
public boolean isDeliveryReady()
```
    Return whether the submission is ready to be delivered
    
    Returns:
    
    true if the delivery status is STATUS_Ready
  - isDeliveryNotReady
```
public boolean isDeliveryNotReady()
```
    Return whether the submission is not ready for delivery (generally due to outstanding user work)
    
    Returns:
    
    true if the delivery status is STATUS_NotReady
  - isDeliveryNotRequired
```
public boolean isDeliveryNotRequired()
```
    Return whether the submission delivery is not required
    
    Returns:
    
    true if the delivery status is STATUS_NotRequired
  - isDeliveryInProgress
```
public boolean isDeliveryInProgress()
```
    Return whether the submission is delivery is in progress
    
    Returns:
    
    true if the delivery status is STATUS_In_Progress
    
    Since:
    
    3.6.0
  - isDeliveryPending
```
public boolean isDeliveryPending()
```
    Return whether the submission is delivery is pending
    
    Returns:
    
    true if the delivery status is STATUS_Pending
    
    Since:
    
    3.6.0
  - isUndeliverable
```
public boolean isUndeliverable()
```
    Return whether the submission has been marked as undeliverable
    
    Returns:
    
    true if the delivery status is STATUS_Undeliverable
  - isDeliveryConfigured
```
public boolean isDeliveryConfigured()
```
    Return whether delivery details are configured for the submission.
    
    Returns:
    
    true if delivery details are configured for the submission
  - isAttachmentsCompleted
```
public boolean isAttachmentsCompleted()
```
    Return whether attachments have been completed
    
    Returns:
    
    true if the attachment status is STATUS_Completed
  - isAttachmentsOptional
```
public boolean isAttachmentsOptional()
```
    Return whether all mandatory attachments have been completed.
    Note: Even after completing mandatory attachments, the user has to explicitly confirm that have finished working on the attachments - otherwise, the submission will not progress.
    
    Returns:
    
    true if the attachment status is STATUS_Optional
  - isAttachmentsOutstanding
```
public boolean isAttachmentsOutstanding()
```
    Return whether attachments are still outstanding
    
    Returns:
    
    true if the attachment status is STATUS_Required or STATUS_Optional
  - isAuthenticationCompleted
```
public boolean isAuthenticationCompleted()
```
    Return whether the user has logged on to acknowledge a submission
    
    Returns:
    
    true if the authentication status is STATUS_Completed
  - isAuthenticationRequired
```
public boolean isAuthenticationRequired()
```
    Return whether the user needs to log on to acknowledge a submission
    
    Returns:
    
    true if the authentication status is STATUS_Required
  - isAuthenticationCancelled
```
public boolean isAuthenticationCancelled()
```
    Return whether the user has rejected an unauthenticated submission
    
    Returns:
    
    true if the authentication status is STATUS_Cancelled
  - isUserWorkCompleted
```
public boolean isUserWorkCompleted()
```
    Return whether the user has completed everything about the submission (i.e. everything that is outstanding are tasks performed by SmartForm Manager, such as virus scanning)
    
    Returns:
    
    true if the submission has been completed by the user
  - isUserWorkCompletedExcludingAuthentication
```
public boolean isUserWorkCompletedExcludingAuthentication()
```
    TODO: LP to check-in proper method
    
    Returns:
    
    todo
  - getCurrentRequestLog
```
public RequestLog getCurrentRequestLog()
```
    Return the most recent form or receipt request log associated with the submission.
    
    Returns:
    
    the request log with the most recent request, or null if no request log was found
  - getCurrentFormRequestLog
```
public RequestLog getCurrentFormRequestLog()
```
    Return the most recent form request log associated with the submission.
    
    Returns:
    
    the request log with the most recent request, or null if no form request log was found
    
    Since:
    
    17.10.4
  - isLcOutputSubmission
```
@Deprecated
public boolean isLcOutputSubmission()
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Returns:
    
    false
  - setLcOutputSubmission
```
@Deprecated
public void setLcOutputSubmission(boolean isLcOutputSubmission)
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Parameters:
    
    isLcOutputSubmission - unused
  - isLcFormsSubmission
```
@Deprecated
public boolean isLcFormsSubmission()
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Returns:
    
    false
  - setLcFormsSubmission
```
@Deprecated
public void setLcFormsSubmission(boolean isLcFormsSubmission)
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Parameters:
    
    isLcFormsSubmission - unused
  - isLcDsigSubmission
```
@Deprecated
public boolean isLcDsigSubmission()
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Returns:
    
    false
  - setLcDsigSubmission
```
@Deprecated
public void setLcDsigSubmission(boolean isLcDsigSubmission)
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Parameters:
    
    isLcDsigSubmission - unused
  - isLcReaderExtensionsSubmission
```
@Deprecated
public boolean isLcReaderExtensionsSubmission()
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Returns:
    
    false
  - setLcReaderExtensionsSubmission
```
@Deprecated
public void setLcReaderExtensionsSubmission(boolean isLcReSubmission)
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Parameters:
    
    isLcReSubmission - unused
  - isLcProcessManagementSubmission
```
@Deprecated
public boolean isLcProcessManagementSubmission()
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Returns:
    
    false
  - setLcProcessManagementSubmission
```
@Deprecated
public void setLcProcessManagementSubmission(boolean isLcPmSubmission)
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Parameters:
    
    isLcPmSubmission - unused
  - isJobSubmissionWithProcessImmediate
```
@Deprecated
public boolean isJobSubmissionWithProcessImmediate()
```
    Deprecated.
    do not use; this will be removed in a future release Please instead use this check: getJob() != null && getJob().isProcessImmediateFlag()
    
    Returns:
    
    deprecated
  - setJobSubmissionWithProcessImmediate
```
@Deprecated
public void setJobSubmissionWithProcessImmediate(boolean isJobWithImmediateProcessing)
```
    Deprecated.
    do not use; this will be removed in a future release
    
    Parameters:
    
    isJobWithImmediateProcessing - unused
  - isJobFormEditable
```
public boolean isJobFormEditable()
```
    Return true if submission job form is editable.
    
    Returns:
    
    true if submission job form is editable
    
    Since:
    
    4.2.0
  - isAssociatedWithPortal
```
public boolean isAssociatedWithPortal(Portal portal)
```
    Return whether the submission is associated with the given portal
    
    Parameters:
    
    portal - the portal (required)
    
    Returns:
    
    true if the submission has been submitted using the portal, or its form has been assigned the given portal
  - setSaveChallengeAnswer
```
public void setSaveChallengeAnswer(String rawChallengeAnswer)
```
    Processes the challenge answer and stores the hash value. If the answer is null or blank, null is stored as the hash value.
    
    Parameters:
    
    rawChallengeAnswer - the answer as parsed out of the form
  - isSavedFormChallengeAnswerCorrect
```
public boolean isSavedFormChallengeAnswerCorrect(String proposedAnswer)
```
    Compares a proposed challenge answer to the answer stored for the submission. Note: All whitespace is stripped from the proposed answer, and it is converted to lower case prior to comparing. No other processing is done, so the data format must match.
    
    Parameters:
    
    proposedAnswer - the proposed answer entered by the user
    
    Returns:
    
    true if the user's answer matched the answer stored for the submission, false otherwise
  - hasSaveChallengeHash
```
public boolean hasSaveChallengeHash()
```
    Returns:
    
    true if the submission has a save challenge hash value.
    
    Since:
    
    4.3.1
  - hasSaveChallengeTimedOut
```
public boolean hasSaveChallengeTimedOut()
```
    Return true if a save challenge timeout is defined and its value has timed out.
    
    Returns:
    
    true if a save challenge timeout is defined and its value has timed out
    
    Since:
    
    4.3.0
  - getDataExtractMap
```
public Map<String,String> getDataExtractMap()
```
    Return submission data extract map (name/value). Please note this map provides a convenient view of the submission data extracts, and does not model a Cayenne relationship. This data extract map is ordered by data extract sequence number.
    
    Returns:
    
    submission data extract map (name/value)
    
    Since:
    
    3.5.1
  - getFormDataMap
```
public Map<String,String> getFormDataMap()
```
    Return the Form Data Map for the submission based on the submission extract data. Extract names will be converted into Java property format to enable easier use in scripts.
    "First Name" -> "firstName
    Returns:
    
    the submission form data extract map, or null if access is not permitted
    
    Since:
    
    4.1.1
  - incrementDeliveryProcessAttempts
```
public void incrementDeliveryProcessAttempts()
```
    Increment the number of delivery process attempts by one.
    
    Since:
    
    3.6.0
  - incrementReceiptRenderAttempts
```
public void incrementReceiptRenderAttempts()
```
    Increment the number of delivery process attempts by one.
    
    Since:
    
    5.0.3
  - setReceiptErrorProgressiveRetryDelay
```
public void setReceiptErrorProgressiveRetryDelay()
```
    Set the receipt render error progressive retry delay.
    
    Since:
    
    5.0.3
  - getSubmissionPropertyValue
```
public String getSubmissionPropertyValue(String name)
```
    Return the named submission property with the value or null if not defined.
    
    Parameters:
    
    name - the submission property name (required)
    
    Returns:
    
    the submission property value
    
    Since:
    
    3.6.0
  - setSubmissionPropertyValue
```
@Deprecated
public void setSubmissionPropertyValue(String name,
                                       String value)
```
    Deprecated.
    
    Set the named submission property with the given value, or create a new submission property if it does not exist.
    
    Parameters:
    
    name - the submission property name (required)
    
    value - the submission property value
    
    Since:
    
    3.6.0
  - setSubmissionPropertyValue
```
public void setSubmissionPropertyValue(String name,
                                       String value,
                                       boolean encrypted)
```
    Set the named submission property with the given value, or create a new submission property if it does not exist.
    
    Parameters:
    
    name - the submission property name (required)
    
    value - the submission property value
    
    encrypted - specify whether the value should be encrypted in the database
    
    Since:
    
    4.3.0
  - getRequiredAttachmentMap
```
public Map<String,RequiredAttachment> getRequiredAttachmentMap()
```
    Return a map of submission required attachments (attachment name/required attachment). Please note this map provides a convenient view of the submission required attachments, and does not model a Cayenne relationship. This required attachments map is ordered by attachment name.
    
    Returns:
    
    a map of submission required attachments (attachment name/required attachment).
    
    Since:
    
    3.6.5
  - isFormTaskSubmission
```
public boolean isFormTaskSubmission()
```
    Return whether this submission is based on a form task
    
    Returns:
    
    true iff the task type is TASK_TYPE_FORM
    
    Since:
    
    4.0.0
  - isReviewTaskSubmission
```
public boolean isReviewTaskSubmission()
```
    Return whether this submission is based on a review task
    
    Returns:
    
    true iff the task type is TASK_TYPE_REVIEW
    
    Since:
    
    4.0.0
  - isTaskSubmission
```
public boolean isTaskSubmission()
```
    Return whether this submission is based on a task
    
    Returns:
    
    true iff the task key is not empty
    
    Since:
    
    4.0.0
  - getSubsequentTasks
```
@Deprecated
public List<Submission> getSubsequentTasks()
```
    Deprecated.
    
    Return the list of subsequent task submissions, this method is provided for backward compatibility with 3.x
    
    Returns:
    
    the list of subsequent task submissions
  - isSubmissionExpired
```
public boolean isSubmissionExpired()
```
    Return true if the submission expiry date is defined and this value is older than the current time.
    
    Returns:
    
    true if the submission expiry date is defined and this value is older than the current time
    
    Since:
    
    4.3.0
  - getTrackingCode
```
public String getTrackingCode()
```
    Return the submission tracking number. This method provides an adaptor for the tracking number.
    
    Returns:
    
    the submission tracking number
    
    Since:
    
    4.0.0
  - isSaveChallengeRender
```
public boolean isSaveChallengeRender()
```
    Returns:
    
    true if a save challenge render
    
    Since:
    
    4.3.1
  - setTrackingNumber
```
public void setTrackingNumber(String trackingNumber)
```
    Set the trackingNumber value, trimming and converting any value to upper case.
    
    Overrides:
    
    setTrackingNumber in class _Submission
    
    Parameters:
    
    trackingNumber - the trackingNumber value to set
    
    Since:
    
    4.1.0
  - setVersion
```
public void setVersion(TemplateVersion version)
```
    Set the form version. This method also updates the form type to ensure they are always aligned.
    
    Overrides:
    
    setVersion in class _Submission
    
    Parameters:
    
    version - the template version
    
    Since:
    
    4.2.0
  - getSubmissionData
```
@Deprecated
public SubmissionData getSubmissionData()
```
    Deprecated.
    
    This method should not be used, instead please use the submissions associated Submission Data Storage service.
    
    Overrides:
    
    getSubmissionData in class _Submission
    
    Returns:
    
    the submissionData value
    
    Since:
    
    4.2.0
  - setSubmissionData
```
@Deprecated
public void setSubmissionData(SubmissionData submissionData)
```
    Deprecated.
    
    This method should not be used, instead please use the submissions associated Submission Data Storage service.
    
    Overrides:
    
    setSubmissionData in class _Submission
    
    Parameters:
    
    submissionData - the submissionData value to set
    
    Since:
    
    4.2.0
  - getAbandonmentReason
```
public String getAbandonmentReason()
```
    Return the abandonmentReason value.
    
    Returns:
    
    abandonmentReason the abandonmentReason value
    
    Since:
    
    5.1.0
  - setAbandonmentReason
```
public void setAbandonmentReason(String abandonmentReason)
```
    Set the abandonmentReason value.
    
    Parameters:
    
    abandonmentReason - the abandonmentReason value to set
    
    Since:
    
    5.1.0
  - getClientCode
```
public String getClientCode()
```
    Return the clientCode value. Provided for backward compatibility.
    
    Returns:
    
    clientCode the clientCode value
    
    Since:
    
    5.1.0
  - getClientName
```
public String getClientName()
```
    Return the clientName value. Provided for backward compatibility.
    
    Returns:
    
    clientName the clientName value
    
    Since:
    
    5.1.0
  - getContentLength
```
public String getContentLength()
```
    Return the contentLength value. Provided for backward compatibility.
    
    Returns:
    
    contentLength the contentLength value
    
    Since:
    
    5.1.0
  - getContentType
```
public String getContentType()
```
    Return the contentType value. Provided for backward compatibility.
    
    Returns:
    
    contentType the contentType value
    
    Since:
    
    5.1.0
  - getDataValidationMessage
```
public String getDataValidationMessage()
```
    Return the dataValidationMessage value.
    
    Returns:
    
    dataValidationMessage the dataValidationMessage value
    
    Since:
    
    5.1.0
  - setDataValidationMessage
```
public void setDataValidationMessage(String dataValidationMessage)
```
    Set the dataValidationMessage value.
    
    Parameters:
    
    dataValidationMessage - the dataValidationMessage value to set
    
    Since:
    
    5.1.0
  - getDeliveryServer
```
@Deprecated
public ServerNode getDeliveryServer()
```
    Deprecated.
    
    Return null. Provided for backward compatibility.
    
    Returns:
    
    null
    
    Since:
    
    5.1.0
  - getDurationClientResponse
```
public Integer getDurationClientResponse()
```
    Return the durationClientResponse value. Provided for backward compatibility.
    
    Returns:
    
    durationClientResponse the durationClientResponse value
    
    Since:
    
    5.1.0
  - getDurationRender
```
public Integer getDurationRender()
```
    Return the durationRender value. Provided for backward compatibility.
    
    Returns:
    
    durationRender the durationRender value
    
    Since:
    
    5.1.0
  - getDurationTotal
```
public Integer getDurationTotal()
```
    Return the durationTotal value. Provided for backward compatibility.
    
    Returns:
    
    durationTotal the durationTotal value
    
    Since:
    
    5.1.0
  - getFieldworkerSyncTime
```
@Deprecated
public Date getFieldworkerSyncTime()
```
    Deprecated.
    
    Return null. Provided for backward compatibility.
    
    Returns:
    
    fieldworkerSyncTime the fieldworkerSyncTime value
    
    Since:
    
    5.1.0
  - getFormCode
```
public String getFormCode()
```
    Return the formCode value. Provided for backward compatibility.
    
    Returns:
    
    formCode the formCode value
    
    Since:
    
    5.1.0
  - getUrlSafeFormCode
```
public String getUrlSafeFormCode()
```
    Return the url encoded formCode value. Provided for backward compatibility.
    
    Returns:
    
    formCode the url encoded formCode value
    
    Since:
    
    18.11.0
  - getFormName
```
public String getFormName()
```
    Return the formName value. Provided for backward compatibility.
    
    Returns:
    
    formName the formName value
    
    Since:
    
    5.1.0
  - getIpAddress
```
public String getIpAddress()
```
    Return the ipAddress value. Provided for backward compatibility.
    
    Returns:
    
    ipAddress the ipAddress
    
    Since:
    
    5.1.0
  - getOfflineSubmitKey
```
public String getOfflineSubmitKey()
```
    Return the offlineSubmitKey value. Provided for backward compatibility.
    
    Returns:
    
    offlineSubmitKey the offlineSubmitKey value
    
    Since:
    
    5.1.0
  - getPercentageCompleted
```
public Integer getPercentageCompleted()
```
    Return the percentageCompleted value. Provided for backward compatibility.
    
    Returns:
    
    percentageCompleted the percentageCompleted value
    
    Since:
    
    5.1.0
  - getPortalServer
```
public ServerNode getPortalServer()
```
    Deprecated.
    
    Return null. Provided for backward compatibility.
    
    Returns:
    
    null
    
    Since:
    
    5.1.0
  - getPortalServerName
```
@Deprecated
public String getPortalServerName()
```
    Deprecated.
    
    Return null. Provided for backward compatibility.
    
    Returns:
    
    null
    
    Since:
    
    5.1.0
  - getProcessingStatus
```
public String getProcessingStatus()
```
    Return the processingStatus value. Provided for backward compatibility.
    
    Returns:
    
    processingStatus the processingStatus value
    
    Since:
    
    5.1.0
  - getProcessingStatusTime
```
public Date getProcessingStatusTime()
```
    Return the processingStatusTime value. Provided for backward compatibility.
    
    Returns:
    
    processingStatusTime the processingStatusTime value
    
    Since:
    
    5.1.0
  - getReferer
```
public String getReferer()
```
    Return the referer value. Provided for backward compatibility.
    
    Returns:
    
    referer the referer value
    
    Since:
    
    5.1.0
  - getRequestCookie
```
public String getRequestCookie()
```
    Return the requestCookie value. Provided for backward compatibility.
    
    Returns:
    
    requestCookie the requestCookie value
    
    Since:
    
    5.1.0
  - getRequestUrl
```
public String getRequestUrl()
```
    Return the requestUrl value. Provided for backward compatibility.
    
    Returns:
    
    requestUrl the requestUrl value
    
    Since:
    
    5.1.0
  - getSavedMessage
```
public String getSavedMessage()
```
    Return the savedMessage value.
    
    Returns:
    
    savedMessage the savedMessage value
    
    Since:
    
    5.1.0
  - setSavedMessage
```
public void setSavedMessage(String savedMessage)
```
    Set the savedMessage value.
    
    Parameters:
    
    savedMessage - the savedMessage value to set
    
    Since:
    
    5.1.0
  - getSubmissionMessage
```
public String getSubmissionMessage()
```
    Return the submissionMessage value.
    
    Returns:
    
    submissionMessage the submissionMessage value
    
    Since:
    
    5.1.0
  - setSubmissionMessage
```
public void setSubmissionMessage(String submissionMessage)
```
    Set the submissionMessage value.
    
    Parameters:
    
    submissionMessage - the submissionMessage value to set
    
    Since:
    
    5.1.0
  - getTaskEmailSubject
```
public String getTaskEmailSubject()
```
    Return the taskEmailSubject value.
    
    Returns:
    
    taskEmailSubject the taskEmailSubject value
    
    Since:
    
    5.1.0
  - setTaskEmailSubject
```
public void setTaskEmailSubject(String taskEmailSubject)
```
    Set the taskEmailSubject value.
    
    Parameters:
    
    taskEmailSubject - the taskEmailSubject value to set
    
    Since:
    
    5.1.0
  - getTaskEmailMessage
```
public String getTaskEmailMessage()
```
    Return the taskEmailMessage value.
    
    Returns:
    
    taskEmailMessage the taskEmailMessage value
    
    Since:
    
    5.1.0
  - setTaskEmailMessage
```
public void setTaskEmailMessage(String taskEmailMessage)
```
    Set the taskEmailMessage value.
    
    Parameters:
    
    taskEmailMessage - the taskEmailMessage value to set
    
    Since:
    
    5.1.0
  - getTaskMessage
```
public String getTaskMessage()
```
    Return the taskMessage value.
    
    Returns:
    
    taskMessage the taskMessage value
    
    Since:
    
    5.1.0
  - setTaskMessage
```
public void setTaskMessage(String taskMessage)
```
    Set the taskMessage value.
    
    Parameters:
    
    taskMessage - the taskMessage value to set
    
    Since:
    
    5.1.0
  - getUserAgent
```
public String getUserAgent()
```
    Return the userAgent value. Provided for backward compatibility.
    
    Returns:
    
    userAgent the userAgent value
    
    Since:
    
    5.1.0
  - getUserAgentBrowserType
```
public String getUserAgentBrowserType()
```
    Return the userAgentBrowserType value.Provided for backward compatibility.
    
    Returns:
    
    userAgentBrowserType the userAgentBrowserType value
    
    Since:
    
    5.1.0
  - getUserAgentBrowserVersion
```
public String getUserAgentBrowserVersion()
```
    Return the userAgentBrowserVersion value. Provided for backward compatibility.
    
    Returns:
    
    userAgentBrowserVersion the userAgentBrowserVersion value
    
    Since:
    
    5.1.0
  - getUserAgentOsType
```
public String getUserAgentOsType()
```
    Return the userAgentOsType value. Provided for backward compatibility.
    
    Returns:
    
    userAgentOsType the userAgentOsType value
    
    Since:
    
    5.1.0
  - getUserAgentOsVersion
```
public String getUserAgentOsVersion()
```
    Return the userAgentOsVersion value. Provided for backward compatibility.
    
    Returns:
    
    userAgentOsVersion the userAgentOsVersion value
    
    Since:
    
    5.1.0
  - isAbandonmentTypeIneligible
```
public boolean isAbandonmentTypeIneligible()
```
    Return whether this submission has been marked as ineligible.
    
    Returns:
    
    true if the abandonment type is STATUS_Ineligible
    
    Since:
    
    5.1.0

Class Submission

Field Summary

Fields inherited from class com.avoka.fc.core.entity.auto._Submission

Fields inherited from class com.avoka.core.entity.BaseEntity

Fields inherited from class org.apache.cayenne.CayenneDataObject

Fields inherited from class org.apache.cayenne.BaseDataObject

Fields inherited from class org.apache.cayenne.PersistentObject

Fields inherited from interface org.apache.cayenne.DataObject

Constructor Summary

Method Summary

Methods inherited from class com.avoka.fc.core.entity.auto._Submission

Methods inherited from class com.avoka.core.entity.BaseEntity

Methods inherited from class org.apache.cayenne.CayenneDataObject

Methods inherited from class org.apache.cayenne.BaseDataObject

Methods inherited from class org.apache.cayenne.PersistentObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cayenne.Persistent

Field Detail

ABANDONMENT_REASON_PROPERTY

CLIENT_CODE_PROPERTY

CLIENT_NAME_PROPERTY

DATA_VALIDATION_MESSAGE_PROPERTY

FORM_CODE_PROPERTY

FORM_NAME_PROPERTY

IP_ADDRESS_PROPERTY

PERCENTAGE_COMPLETED_PROPERTY

PROCESSING_STATUS_PROPERTY

PROCESSING_STATUS_TIME_PROPERTY

REFERER_PROPERTY

REQUEST_COOKIE_PROPERTY

REQUEST_URL_PROPERTY

SAVED_MESSAGE_PROPERTY

SUBMISSION_MESSAGE_PROPERTY

TASK_EMAIL_SUBJECT_PROPERTY

TASK_EMAIL_MESSAGE_PROPERTY

TASK_MESSAGE_PROPERTY

USER_AGENT_PROPERTY

USER_AGENT_BROWSER_TYPE_PROPERTY

USER_AGENT_BROWSER_VERSION_PROPERTY

USER_AGENT_OS_TYPE_PROPERTY

USER_AGENT_OS_VERSION_PROPERTY

TASK_GROUP_NAME_PROPERTY

SUBMISSION_GROUP_NAMES_PROPERTY

USER_AGENT_BROWSER_PROPERTY

USER_AGENT_OS_PROPERTY

STATUS_Assigned

STATUS_Opened

STATUS_Saved

STATUS_Abandoned

STATUS_Submitted

STATUS_Required

STATUS_Optional

STATUS_In_Progress

STATUS_Pending

STATUS_NotReady

STATUS_NotRequired

STATUS_Ready

STATUS_DetailsRequired

STATUS_PaymentRequired

STATUS_Sent_Email

STATUS_Completed

STATUS_COMPLETED_UPLOAD

STATUS_COMPLETED_MANUALLY

STATUS_Expired

STATUS_Cancelled

STATUS_Undeliverable

STATUS_Error

STATUS_Error_No_Data

STATUS_Ineligible

TASK_TYPE_FORM

TASK_TYPE_REVIEW

PAYMENT_TYPE_BPAY

PAYMENT_TYPE_CreditCard

PAYMENT_TYPE_Hosted

PAYMENT_TYPE_EFT

PAYMENT_TYPE_Manual

SIGNATURE_TYPE_DIGITAL

SIGNATURE_TYPE_ESIGNATURE

SIGNATURE_TYPE_WET

FORM_STATUS_VALUES