Uses of Class
com.avoka.fc.core.entity.Submission
Package
Description
Provides the Data Access Objects used by SmartForm Manager.
Provides the SmartForm Manager entity classes.
Provides the SmartForm Manager entity base classes, which are being maintained by Cayenne.
Provides Cayenne listener classes that execute custom functionality on various Cayenne events.
Provides Form Page Tracking classes.
Provides classes related to security and authentication.
Provides the SmartForm Manager service classes.
Provides the Email Client Services.
Provides the Fluent Groovy API services.
Provides classes for form services.
Provides the SmartForm Manager service class implementation.
Provides the Insighs integration services.
Provides classes for iText PDF receipt rendering services.
Provides Collaboration Jobs Service classes.
Provides Collaboration Jobs service classes.
Provides payment related utility classes.
Provides classes for PhantomJS PDF receipt rendering services.
Provides submission data storage service implementations.
Provides submission service implementations.
Provides web automated test services.
Provides execution thread request context utility class.
Provides a Form Command Hander test framework.
Provides common utility classes and exception objects.
Provides Fluent Function classes.
Provides Value Object persistent entity classes.
-
Uses of Submission in com.avoka.fc.core.dao
Modifier and TypeMethodDescriptionSubmissionDao.getNextRestDeliverySubmission
(DeliveryDetails deliveryDetails) Return the next REST delivery submission ready for delivery.SubmissionDao.getNextSubmissionsForDeliveryDetailsAndStatus
(DeliveryDetails deliveryDetails, String deliveryStatus) Return the next delivery submissions for the specified delivery details and delivery status.SubmissionDao.getSubmission
(Object id) Return the submission with the specified OIDSubmissionDao.getSubmissionByEmailVerificationKey
(String emailKey) Return a submission with the specified email verification key.SubmissionDao.getSubmissionByKey
(String submitKey) Return a submission with the specified surrogate keySubmissionDao.getSubmissionByKeyAndClient
(String clientKey, String submitKey) Return a submission for the given submission and client surrogate keys.SubmissionDao.getSubmissionByOfflineKey
(String offlineSubmitKey) Return the submission with the given offline submit keySubmissionDao.getSubmissionByReceiptNumber
(String receiptNumber) Return a submission with the specified receipt numberSubmissionDao.getSubmissionByTrackingNumber
(String trackingNumber) Return a submission with the specified tracking numberSubmissionDao.getTaskByKey
(String taskKey) Return the submission with the specified task key.Modifier and TypeMethodDescriptionSubmissionDao.getAbandonedLegacyTasks
(int fetchLimit) SubmissionDao.getAbandonedLegacyTransactions
(int fetchLimit) SubmissionDao.getAbandonedSubmissionList
(String genericSearchValue, String clientId, String portalId, String abandonmentType, Integer transactionScore, Date startDate, Date endDate) Return the list of submission with a form status of 'Abandoned' which meet the specified criteria.SubmissionDao.getAbandonedSubmissionsForDelivery
(int maxRows) Deprecated.SubmissionDao.getAdminCachedFormSubmissions
(Form form, int fetchLimit) Return the most recent non-test administrator cached form submissions for the given form.SubmissionDao.getAdminFormSubmissions
(String clientId) Return the most recent form submissions for the specified admin client or all clients if not specified.SubmissionDao.getAllSubmissionsByFilter
(String submissionQueryFilter, String dateField, Date cutoffDate) Deprecated.SubmissionDao.getAnonymousBgSaveSubmissionsForAbandonment
(int maxRows) Return a list of Form Starts (auto saved, but no user save), which are configured for abandonment delivery and reach the form configured abandon submitted timeout.SubmissionDao.getAssignedTasksForUser
(UserAccount userAccount, Portal portal, int maxNumber, boolean includeGroupTasks) Get the list of assigned task submissions for the specified user and portal.SubmissionDao.getCompletedSubmissionsForUser
(UserAccount user, String keyword, String clientName, String formNameLike, Date fromDate, Date toDate, Portal portal, Map<String, String> submissionExtractDataSearch, boolean includeGroupSubmission) Return the list of completed submissions for the given user.SubmissionDao.getCompletedSubmissionsForUser
(String keywordLike, UserAccount userAccount, Portal portal, boolean includeGroupSubmission) Provide the keyword search Submission History results based on the user own account or group access control.SubmissionDao.getCompletedSubmissionsForUser
(String keywordLike, UserAccount userAccount, Portal portal, List<String> groupNames, Set<Long> clientIdSet, Integer fetchLimit) Provide the keyword search Submission History results based on the user own account or group access control.SubmissionDao.getCompletedSubmissionsForUserAndForms
(UserAccount user, Collection<String> formCodes, Date fromDate, Date toDate, Portal portal, Map<String, String> submissionExtractDataSearch, boolean includeGroupSubmission) Return the list of completed submissions for the given user.SubmissionDao.getDraftsForUser
(UserAccount userAccount, Portal portal, List<String> groupNames, boolean includeGroupSubmission) Return the list of draft or 'Saved' submissions for a given user and portal.SubmissionDao.getExpiredSubmissionsToAbandon
(int fetchLimit) Return the list of expired submissions to abandon.SubmissionDao.getExpiredTasksRequiringAbandonment
(int fetchLimit) Returns the list of tasks which have been 'Expired' and data deleted but have no purge time set.SubmissionDao.getFormSubmissions
(Form form, int fetchLimit) Return the most recent non-test form submissions for the given form.SubmissionDao.getFormSubmissions
(String clientId, int fetchLimit) Return the most recent form submissions for the specified client or all clients if not specified.SubmissionDao.getHelpDeskSubmissions
(Portal portal, String keyword, String formStatus, Date startDate, boolean includeAnonymousSubmissions, boolean includeAuthenticatedSubmissions) Return a the list help desk submission.SubmissionDao.getInProgressSubmissionsForFormAndExpiryDate
(Form form, Date submissionExpiryDate) Return the list of in progress submissions (Opened, Assigned, Saved, Submitted) for the given form and submission expiry date.SubmissionDao.getJobDeliveryCompleteSubmissions()
Returns the submissions that are marked delivery completed and have jobDeliveryRequiredFlag set to true.SubmissionDao.getOpenedSubmissionsForAbandonment
(int maxRows) Return a list of the n most recent opened and background save only submissions that are ready for abandonmentSubmissionDao.getPortalToDoSubmissionsForUser
(UserAccount userAccount, String keywordLike, List<String> statusList, Portal portal, boolean includeGroupSubmission) Return the list of incomplete submissions matching the specified search criteria.SubmissionDao.getPortalToDoSubmissionsForUser
(UserAccount userAccount, String keyword, List<String> submissionStatusList, Portal portal, List<String> groupNames, Set<Long> clientIdSet, Integer fetchLimit) Gets the portal to do submissions for user.SubmissionDao.getRESTDeliveryRetrySubmissions()
Return the list of submissions with the delivery status of 'In-Progress' and delivery method 'REST Service' and where their next_delivery_time exceeds the current time.SubmissionDao.getSavedSubmissionList
(String genericSearchValue, String clientId, String portalId, Integer transactionScore, Date startDate, Date endDate) Return the list of submission with a form status of 'Saved' which meet the specified criteria.SubmissionDao.getSavedSubmissionsForAbandonment
(int maxRows) Return a list of the n most recent save submissions that are ready for abandonmentSubmissionDao.getSubmissionDeliveryList
(String deliveryStatus, String clientId, String deliveryDetailsId, String formCode, String deliveryMessageLike, Date startDate, Date endDate, int fetchLimit) Return a list of submissions which match the delivery criteria.SubmissionDao.getSubmissionList
(String keyword, String clientId, Date startDate, Date endDate, String formStatus, String attachmentStatus, String paymentStatus, String emailVerificationStatus, String deliveryStatus, int offset, int pageSize) Return the list of submissions matching the specified search criteriaWorkspaceDao.getSubmissionList
(WorkspaceDao.SubmissionCriteria criteria) Return submission list for the given search criteria.SubmissionDao.getSubmissionsByTransRefNumber
(String transRefNumber) Return the list of submissions matching the specified transaction reference number, ordered by PK.SubmissionDao.getSubmissionsDeliveredViaEmailBefore
(Date cutoffTime, int maxRows) Return the list of submissions for which secure email delivery was initiated before a specified cutoff timeSubmissionDao.getSubmissionsForDeliveryDetailsAndStatus
(DeliveryDetails deliveryDetails, String deliveryStatus) Return the delivery submissions for the specified delivery details and delivery status.SubmissionDao.getSubmissionsForDeliveryDetailsAndStatus
(DeliveryDetails deliveryDetails, String deliveryStatus, int fetchLimit) Return the delivery submissions for the specified delivery details and delivery status.SubmissionDao.getSubmissionsForDeliveryNoDeliveryDetails()
Return submissions for delivery, but with no delivery details configured.SubmissionDao.getSubmissionsForExternalUserId
(String externalUserId) Return the list of submissions with the given external user ID, ordered by submission time.SubmissionDao.getSubmissionsReadyForDelivery
(int maxRows) Return a list of the n most recent submission that are ready for delivery and for which a delivery method is configured.SubmissionDao.getSubmissionsReadyForDelivery
(Client client) Return the list of submissions for a specified client that are ready to be delivered, ordered by submission timeSubmissionDao.getSubmissionsSearch
(String clientId, String value) Return a list of submissions whose form name contain the search string, or whose OID, form OID or user OID matches the search string if it is numeric.SubmissionDao.getSubmissionsToReceipt
(int fetchLimit, int maxRenderAttempts) Return submissions that are ready for receipt generation, ordered by submission time.SubmissionPropertyDao.getSubmissionsWithProperty
(String propertyName, String propertyValue) Return the list of submissions for which a submission property with a specified name and value existsSubmissionDao.getSubmittedOrCompletedSubmissionsForUser
(UserAccount userAccount, Portal portal, List<String> groupNames, boolean includeGroupSubmission) Return the list of completed submissions for the given user.SubmissionDao.getSubmittedSubmissionsForAbandonment
(int maxRows) Return a list of the n most recent save submissions that are ready for abandonmentSubmissionDao.getSupportSearchList
(String clientId, String formId, String portalId, String refNumber, String userOrEmail, Boolean tasksInclude, Boolean jobsInclude, String formStatus, String attachmentStatus, String paymentStatus, String emailVerifStatus, String receiptStatus, String deliveryStatus, Date startDate, Date endDate, int fetchLimit) Provides a Transaction Support Search query.SubmissionDao.getTaskSubmissionList
(String clientId, String keyword, String type, String status, Date startDate, Date endDate) Return the list of task submissions matching the specified search criteriaSubmissionDao.getTaskSubmissionList
(String clientId, String keyword, String type, String status, Date startDate, Date endDate, int pageSize, int fetchLimit) Return the list of task submissions matching the specified search criteriaSubmissionDao.getTaskSubmissionsForExpiryProcess()
Returns task submissions for which an expiry process needs to be run.SubmissionDao.getTaskSubmissionsToAbandon
(int fetchLimit) Return the list of Assigned and Opened Tasks, without expiry or associated Job which can be abandoned.SubmissionDao.getTaskSubmissionsToExpire
(int fetchLimit) Return the list of task submissions that have passed their expiry date but are still in statusSTATUS_Assigned
,STATUS_Opened
orSTATUS_Opened
.SubmissionDao.getToDoSubmissionsForUser
(UserAccount userAccount, String keywordLike, String clientName, List<String> statusList, Date fromDateTime, Date toDateTime, Portal portal, boolean includeGroupSubmission) Return the list of incomplete submissions matching the specified search criteria.SubmissionDao.getToDoSubmissionsForUserAndForm
(UserAccount userAccount, Form form, boolean includeGroupSubmission) Gets the submissions for user and form.Modifier and TypeMethodDescriptionvoid
SubmissionServiceUsageDao.addAmountToUsageCount
(Submission submission, String serviceName, int usageCount) Deprecated.use SubmissionService.addServiceLog insteadboolean
GroupDao.addGroupsToSubmission
(Collection<String> groupNames, Submission submission) Add the specified groups to the submission.void
GroupDao.addGroupToSubmission
(Group group, Submission submission) Add the specified group to the submission.SubmissionMilestoneDao.addMilestone
(Submission submission, String milestone, RequestLog requestLog) Add a submission milestone and registers it with the data context.SubmissionDao.addProcessingStatus
(Submission submission, String status, UserAccount user) Return a processing status entry to a submission.SubmissionDao.addProcessingStatusWithLoginName
(Submission submission, String status, String loginName) Return a processing status entry to a submission.SubmissionDao.copyAttachmentToSubmission
(Attachment attachment, Submission targetSubmission, RequiredAttachment targetRA) Copy the attachment to the specified submission, cloning the file upload data.void
SubmissionDao.copyRequiredAttachmentToSubmission
(RequiredAttachment requiredAttachment, Submission targetSubmission) Copy the required attachment to the specified submission, cloning the associated attachment and file data.void
SubmissionDao.copyRequiredAttachmentToSubmission
(RequiredAttachment requiredAttachment, Submission targetSubmission, Document targetXmlDoc) Copy the required attachment to the specified submission, cloning the associated attachment and file data.AuditLogDao.createAuditLogRecord
(BaseEntity entity, String message, String type, Submission submission) Create an audit log recordRequiredAttachmentDao.createOrUpdateManuallySubmittedRequiredAttachment
(Submission submission, String attachmentName, String mandatoryStatus) Create or update a manually submitted RequiredAttachment record for the submission with the name and mandatory status.RequiredAttachmentDao.createOrUpdateRequiredAttachment
(Submission submission, RequiredAttachmentMetadata metadata) Create or update a RequiredAttachment record for the submission with the specified required attachment metadata.RequiredAttachmentDao.createOrUpdateRequiredAttachment
(Submission submission, String attachmentName) Create or update a RequiredAttachment record for the submission with the specified required attachment name.AttachmentDao.getAttachmentForIdAndSubmission
(Long id, Submission submission) Return the attachment for the given submission and attachment id.FileUploadDao.getFileUploadsForSubmission
(Submission submission) Return the list of file uploads for a submissionSubmissionDataDao.getFormDataMap
(Submission submission) Return the Form Data Map for the given submission based on the submission extract data.SubmissionDeliveryFuncDao.getFuncForSubmission
(Submission submission, ServiceDefinition deliveryService) Return the SubmissionDeliveryFunc for the given submission and service definition.GroovyServiceLogDao.getGroovyServiceLog
(Submission submission) Return the list of service log entries for the given submission, if any.GroovyServiceLogDao.getGroovyServiceLog
(String clientId, String serviceType, String serviceId, String status, Integer minDuration, Submission submission, String sessionId, String logMessage, Date startDate, Date endDate, int pageSize, int fetchLimit) Return the list of GroovyServiceLog records for the given query parameters.PaymentLogDao.getLatestCompletedPayment
(Submission submission) Return latest completed payment log for a submissionPaymentLogDao.getLatestPaymentLog
(Submission submission) Return the latest PaymentLog for the given submissionSubmissionDao.getMandatoryRequiredAttachments
(Submission submission) Return the list of mandatory required attachments for the given submissionSubmissionHistoryDao.getMostRecentHistoryWithStatus
(Submission submission, String formStatus) Search the submission for the most recent submission history with the given form status.SubmissionMilestoneDao.getMostRecentMilestone
(Submission submission) Return the most recent milestone logged against the submission, if any.SubmissionDao.getOptionalRequiredAttachments
(Submission submission) Return the list of optional required attachments for the given submissionPropertyValueDao.getPropertyValue
(String propertyName, Submission submission) Return the named property value searching for: Form Property > Client Property > Portal Property > Deployment Property.PropertyValueDao.getPropertyValue
(String propertyName, Submission submission, Portal portal) Return the named property value searching for: Form Property > Client Property > Portal Property > Deployment Property.SubmissionPropertyDao.getPropertyValue
(Submission submission, String propertyName) Return the value of a submission propertySubmissionPropertyDao.getPropertyValueForId
(Submission submission, long propertyId) Return the property value for the given submission and property idRequiredAttachmentDao.getRequiredAttachmentForSubmission
(Submission submission, String attachmentName) Return the required attachment for the given submission and attachment name.SubmissionServiceDao.getServiceLogByName
(Submission submission, String serviceName) Return the submission service entries for the given submission and service name, sorted ascending by creation date (oldest first).AttachmentDao.getSubmissionFileAttachments
(Submission submission) Return all attachments for a submission, also pre-fetching the associated file upload objectsRequestLogDao.getSubmissionFormRequests
(Submission submission) Return the form request logs for the given submission.byte[]
SubmissionDataDao.getSubmissionReceipt
(Submission submission) Gets the submission receipt data.byte[]
SubmissionDataDao.getSubmissionXml
(Submission submission) Gets the submission XML data.SubmissionDataDao.getSubmissionXmlDocument
(Submission submission) Gets the submission XML data as Document object.SubmissionDataDao.getSubmissionXmlString
(Submission submission) Gets the submission XML data as a UTF-8 encoded text.boolean
SubmissionDeliveryCheckpointDao.hasDeliveryCheckpoint
(Submission submission, String name, String status) Determine whether a completed checkpoint with the given name already exists for the submissionboolean
UserAccountDao.isSubmissionAccessibleToAdministrator
(Submission submission, UserAccount userAccount) Return true if the submission is accessible to the given administrator user.void
EmailQueueDao.markReceiptEmailsAsReady
(Submission submission) Mark all user receipt emails related to this submission as ready (only if they are currently not ready)void
SubmissionPropertyDao.setPropertyValue
(Submission submission, String propertyName, String propertyValue) Set a property related to a submission, creating the property if necessaryvoid
SubmissionDao.setPurgeDateForSubmissionAndSavedAbandonedData
(Submission submission) Deprecated.void
SubmissionDao.setPurgeDatesForDeliveredAbandonedForms
(Submission submission) Sets the submission data purge date for finished (Completed or Abandoned) form data.void
SubmissionDao.setPurgeDatesForSavedForms
(Submission submission) Deprecated.use updateScheduledSaveAbandonTime instead.void
SubmissionDao.setPurgeDeliveredDate
(Submission submission) Deprecated.void
SubmissionDao.updatePurgeTime
(Submission submission) Deprecated.void
SubmissionDao.updateScheduledSaveAbandonTime
(Submission submission) Sets the scheduled abandonment time for a saved submission.Modifier and TypeMethodDescriptionvoid
SubmissionDao.iterateOverSubmissionsForEmailVerificationReminders
(Form form, Date lastReminderSentBefore, int maxAttempts, org.apache.cayenne.ResultIteratorCallback<Submission> op) Iterates over the list of submissions for which an email verification reminder needs to be sent (i.e.void
SubmissionDao.iterateOverSubmissionsWithOverdueEmailVerification
(Form form, Date submittedBefore, org.apache.cayenne.ResultIteratorCallback<Submission> op) Iterates over the list of submissions for which email verification is overdue (i.e. -
Uses of Submission in com.avoka.fc.core.entity
Modifier and TypeMethodDescriptionJob.getFirstSubmission()
Return the first submission of the job.Modifier and TypeMethodDescriptionServiceDefinition.getSubmissionList()
Deprecated.Submission.getSubsequentTasks()
Deprecated.Modifier and TypeMethodDescriptionvoid
Job.addToSubmissions
(Submission obj) Add the Submissions object. -
Uses of Submission in com.avoka.fc.core.entity.auto
Modifier and TypeFieldDescriptionstatic final org.apache.cayenne.exp.Property<Submission>
_Submission.PREVIOUS_SUBMISSION
Provides the 'PREVIOUS_SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_Attachment.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_AuditLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_EmailQueue.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_ErrorLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_EventLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_FileUpload.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_GroovyServiceLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_JobAction.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_PaymentItem.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_PaymentLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_ProcessingStatus.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_RequestLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_RequiredAttachment.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionAsyncMsg.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionAttribute.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionComment.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionData.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionDeliveryCheckpoint.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionDeliveryFunc.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionExtractData.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionExtractJson.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionExtractSearch.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionGroup.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionHistory.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionMilestone.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionProperty.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionPropertySearch.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionServiceLog.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_SubmissionValidationError.SUBMISSION
Provides the 'SUBMISSION' property.static final org.apache.cayenne.exp.Property<Submission>
_ErrorLog.SUBMISSION_DELIVERY
Provides the 'SUBMISSION_DELIVERY' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_ServiceDefinition.SUBMISSION_LIST
Provides the 'SUBMISSION_LIST' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_Client.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_ClientKeystore.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_DeliveryDetails.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_Form.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_Job.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_Portal.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_TemplateVersion.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_UserAccount.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_UserProfile.SUBMISSIONS
Provides the 'SUBMISSIONS' property.static final org.apache.cayenne.exp.Property<List<Submission>>
_Submission.SUBSEQUENT_SUBMISSIONS
Provides the 'SUBSEQUENT_SUBMISSIONS' property.Modifier and TypeMethodDescription_Submission.getPreviousSubmission()
Return the PreviousSubmission._Attachment.getSubmission()
Return the Submission._AuditLog.getSubmission()
Return the Submission._EmailQueue.getSubmission()
Return the Submission._ErrorLog.getSubmission()
Return the Submission._EventLog.getSubmission()
Return the Submission._FileUpload.getSubmission()
Return the Submission._GroovyServiceLog.getSubmission()
Return the Submission._JobAction.getSubmission()
Return the Submission._PaymentItem.getSubmission()
Return the Submission._PaymentLog.getSubmission()
Return the Submission._ProcessingStatus.getSubmission()
Return the Submission._RequestLog.getSubmission()
Return the Submission._RequiredAttachment.getSubmission()
Return the Submission._SubmissionAsyncMsg.getSubmission()
Return the Submission._SubmissionAttribute.getSubmission()
Return the Submission._SubmissionComment.getSubmission()
Return the Submission._SubmissionData.getSubmission()
Return the Submission._SubmissionDeliveryCheckpoint.getSubmission()
Return the Submission._SubmissionDeliveryFunc.getSubmission()
Return the Submission._SubmissionExtractData.getSubmission()
Return the Submission._SubmissionExtractJson.getSubmission()
Return the Submission._SubmissionExtractSearch.getSubmission()
Return the Submission._SubmissionGroup.getSubmission()
Return the Submission._SubmissionHistory.getSubmission()
Return the Submission._SubmissionMilestone.getSubmission()
Return the Submission._SubmissionProperty.getSubmission()
Return the Submission._SubmissionPropertySearch.getSubmission()
Return the Submission._SubmissionServiceLog.getSubmission()
Return the Submission._SubmissionValidationError.getSubmission()
Return the Submission._ErrorLog.getSubmissionDelivery()
Return the SubmissionDelivery.Modifier and TypeMethodDescription_ServiceDefinition.getSubmissionList()
Return the SubmissionList._Client.getSubmissions()
Return the Submissions._ClientKeystore.getSubmissions()
Return the Submissions._DeliveryDetails.getSubmissions()
Return the Submissions._Form.getSubmissions()
Return the Submissions._Job.getSubmissions()
Return the Submissions._Portal.getSubmissions()
Return the Submissions._TemplateVersion.getSubmissions()
Return the Submissions._UserAccount.getSubmissions()
Return the Submissions._UserProfile.getSubmissions()
Return the Submissions._Submission.getSubsequentSubmissions()
Return the SubsequentSubmissions.Modifier and TypeMethodDescriptionvoid
_ServiceDefinition.addToSubmissionList
(Submission obj) Add the SubmissionList object.void
_Client.addToSubmissions
(Submission obj) Add the Submissions object.void
_ClientKeystore.addToSubmissions
(Submission obj) Add the Submissions object.void
_DeliveryDetails.addToSubmissions
(Submission obj) Add the Submissions object.void
_Form.addToSubmissions
(Submission obj) Add the Submissions object.void
_Job.addToSubmissions
(Submission obj) Add the Submissions object.void
_Portal.addToSubmissions
(Submission obj) Add the Submissions object.void
_TemplateVersion.addToSubmissions
(Submission obj) Add the Submissions object.void
_UserAccount.addToSubmissions
(Submission obj) Add the Submissions object.void
_UserProfile.addToSubmissions
(Submission obj) Add the Submissions object.void
_Submission.addToSubsequentSubmissions
(Submission obj) Add the SubsequentSubmissions object.void
_ServiceDefinition.removeFromSubmissionList
(Submission obj) Remove the SubmissionList object.void
_Client.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_ClientKeystore.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_DeliveryDetails.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_Form.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_Job.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_Portal.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_TemplateVersion.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_UserAccount.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_UserProfile.removeFromSubmissions
(Submission obj) Remove the Submissions object.void
_Submission.removeFromSubsequentSubmissions
(Submission obj) Remove the SubsequentSubmissions object.void
_Submission.setPreviousSubmission
(Submission previousSubmission) Set the PreviousSubmission.void
_Attachment.setSubmission
(Submission submission) Set the Submission.void
_AuditLog.setSubmission
(Submission submission) Set the Submission.void
_EmailQueue.setSubmission
(Submission submission) Set the Submission.void
_ErrorLog.setSubmission
(Submission submission) Set the Submission.void
_EventLog.setSubmission
(Submission submission) Set the Submission.void
_FileUpload.setSubmission
(Submission submission) Set the Submission.void
_GroovyServiceLog.setSubmission
(Submission submission) Set the Submission.void
_JobAction.setSubmission
(Submission submission) Set the Submission.void
_PaymentItem.setSubmission
(Submission submission) Set the Submission.void
_PaymentLog.setSubmission
(Submission submission) Set the Submission.void
_ProcessingStatus.setSubmission
(Submission submission) Set the Submission.void
_RequestLog.setSubmission
(Submission submission) Set the Submission.void
_RequiredAttachment.setSubmission
(Submission submission) Set the Submission.void
_SubmissionAsyncMsg.setSubmission
(Submission submission) Set the Submission.void
_SubmissionAttribute.setSubmission
(Submission submission) Set the Submission.void
_SubmissionComment.setSubmission
(Submission submission) Set the Submission.void
_SubmissionData.setSubmission
(Submission submission) Set the Submission.void
_SubmissionDeliveryCheckpoint.setSubmission
(Submission submission) Set the Submission.void
_SubmissionDeliveryFunc.setSubmission
(Submission submission) Set the Submission.void
_SubmissionExtractData.setSubmission
(Submission submission) Set the Submission.void
_SubmissionExtractJson.setSubmission
(Submission submission) Set the Submission.void
_SubmissionExtractSearch.setSubmission
(Submission submission) Set the Submission.void
_SubmissionGroup.setSubmission
(Submission submission) Set the Submission.void
_SubmissionHistory.setSubmission
(Submission submission) Set the Submission.void
_SubmissionMilestone.setSubmission
(Submission submission) Set the Submission.void
_SubmissionProperty.setSubmission
(Submission submission) Set the Submission.void
_SubmissionPropertySearch.setSubmission
(Submission submission) Set the Submission.void
_SubmissionServiceLog.setSubmission
(Submission submission) Set the Submission.void
_SubmissionValidationError.setSubmission
(Submission submission) Set the Submission.void
_ErrorLog.setSubmissionDelivery
(Submission submissionDelivery) Set the SubmissionDelivery. -
Uses of Submission in com.avoka.fc.core.listener
Modifier and TypeMethodDescriptionvoid
SearchPiiPurgeListener.updateSubmission
(Submission sub) Handle a submission status update -
Uses of Submission in com.avoka.fc.core.page
Modifier and TypeMethodDescriptionstatic String
FormPageTrackingUtils.renderContent
(Form form, jakarta.servlet.http.HttpServletRequest request, Submission submission) Return the rendered 3rd party form page tracking content, using the forms pageTrackingContent. -
Uses of Submission in com.avoka.fc.core.security
Modifier and TypeMethodDescriptionFormSubmissionAccessController.getCompletedSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the users access status to the given completed submission.FormSubmissionAccessController.getCompletedSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean checkOrgAccess) Return the users access status to the given completed submission.IFormSubmissionAccessController.getCompletedSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the users access status to the given completed submission.IFormSubmissionAccessController.getCompletedSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean checkOrgAccess) Return the users access status to the given completed submission.FormSubmissionAccessController.getInProgressJsAppAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request, Portal portal) Return the users access status to the given in-progress (not completed) 'JS App' submission.IFormSubmissionAccessController.getInProgressJsAppAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request, Portal portal) Return the users access status to the given in-progress (not completed) 'JS App' submission.FormSubmissionAccessController.getInProgressSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the users access status to the given in-progress submission.FormSubmissionAccessController.getInProgressSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean checkOrgAccess) IFormSubmissionAccessController.getInProgressSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the users access status to the given in-progress (not completed) submission.IFormSubmissionAccessController.getInProgressSubmissionAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean checkOrgAccess) Return the users access status to the given in-progress (not completed) submission.FormSubmissionAccessController.getReceiptAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the users access status to the given submission receipt when returning later (i.e.IFormSubmissionAccessController.getReceiptAccessStatus
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the users access status to the given submission receipt when returning later (i.e.boolean
FormSubmissionAccessController.hasAnonymousSubmissionAccess
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Check whether the submission can be accessed by the current user.boolean
IFormSubmissionAccessController.hasAnonymousSubmissionAccess
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Check whether the submission can be accessed by the current user.boolean
FormSubmissionAccessController.isValidNumberSaveChallengeRequests
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Check whether the current user can make another save challenge attempt.boolean
IFormSubmissionAccessController.isValidNumberSaveChallengeRequests
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Check whether the current user can make another save challenge attempt.void
FormSubmissionAccessController.onSaveChallengeSuccess
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Called after a valid save challenge it resets the submission fields submission.saveChallengeFailures=0, submission.saveChallengeLastFailure=nullvoid
IFormSubmissionAccessController.onSaveChallengeSuccess
(Submission submission, jakarta.servlet.http.HttpServletRequest request) On successful login will resets the submission failures and last failure.void
FormSubmissionAccessController.updateSubmissionSession
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Update new session info on the submission record.void
IFormSubmissionAccessController.updateSubmissionSession
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Update new session info on the submission record.FormSubmissionAccessController.validateTaskReassignment
(Submission submission, UserAccount newAssignee, jakarta.servlet.http.HttpServletRequest request) Checks if a task can be reassigned to a user by the current user.IFormSubmissionAccessController.validateTaskReassignment
(Submission submission, UserAccount newAssignee, jakarta.servlet.http.HttpServletRequest request) Checks if a task can be reassigned to a user by the current user.FormSubmissionAccessController.validateTaskUnassignment
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Checks if a task can be unassigned by the current user.IFormSubmissionAccessController.validateTaskUnassignment
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Checks if a task can be unassigned by the current user. -
Uses of Submission in com.avoka.fc.core.service
Modifier and TypeFieldDescriptionSubmissionTaskService.SavedFormParam.copyAttachmentsSubmission
Copy the attachments of the previous submission if defined.SubmissionTaskService.ReviewTask.reviewSubmission
The submission to review (required).Modifier and TypeMethodDescriptionISubmissionDeliveryController.completeRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, boolean deleteData, String processingStatus) Complete REST Service submission delivery and return the completed submission.SubmissionService.createAndInitialiseSubmission
(Form form) Create and initialise a new submission object.SubmissionService.createAndInitialiseSubmission
(Form form, String receiptNumber, String trackingCode) Create and initialise a new submission object.SubmissionTaskService.createAnonymousSavedForm
(SubmissionTaskService.SavedFormParam param) Create an anonymous saved form submission using the provided parameter data.SubmissionTaskService.createFormTask
(SubmissionTaskService.FormTaskParam param) Create a form task submission for a user or a user group to do.TaskService.createFormTask
(Form form, String taskSubject, String taskMessage, Integer sequence, UserAccount user, Group group, String formDataXml, String inputXmlData, Double latitude, Double longitude, String address, Date datetimeScheduled, Date datetimeExpiry, boolean sendEmailFlag, String emailSubject, String emailMessage, boolean userDeletableFlag) Create a form task for a user or a user group to do.TaskService.createFormTask
(Form form, String taskSubject, String taskMessage, Integer sequence, UserAccount user, Group group, String formDataXml, String inputXmlData, Double latitude, Double longitude, Date datetimeScheduled, Date datetimeExpiry, boolean sendEmailFlag, String emailSubject, String emailMessage, boolean userDeletableFlag) Create a form task for a user or a user group to do.SubmissionTaskService.createReviewTask
(SubmissionTaskService.ReviewTask param) Create a review task submission for a user or a user group to do.TaskService.createReviewTask
(Submission reviewSubmission, Form form, String taskSubject, String taskMessage, Integer sequence, UserAccount user, Group group, String formDataXml, Double latitude, Double longitude, String address, Date datetimeScheduled, Date datetimeExpiry, boolean sendEmailFlag, String emailSubject, String emailMessage, boolean userDeletableFlag) Create a review task for a user or a user group to do.TaskService.createReviewTask
(Submission reviewSubmission, Form form, String taskSubject, String taskMessage, Integer sequence, UserAccount user, Group group, String formDataXml, Double latitude, Double longitude, Date datetimeScheduled, Date datetimeExpiry, boolean sendEmailFlag, String emailSubject, String emailMessage, boolean userDeletableFlag) Create a review task for a user or a user group to do.ISubmissionDeliveryController.errorRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, String errorMessage, jakarta.servlet.http.HttpServletRequest request) Set a REST submission delivery error and return the updated submission.ISubmissionDeliveryController.getNextRESTSubmission
(DeliveryDetails deliveryDetails) Return the next submission ready for delivery for the given REST Service delivery details, and set the Submission delivery status to 'In Progress' or null otherwise.SubmissionService.initializeOpenedSubmission
(Form form, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, Document document, Submission submission) Initializes an open submission record ready for filling out.ISubmissionService.saveSubmission
(SubmissionDataBean submissionDataBean, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, boolean isBackgroundSave) Create a Submission record and persists it into the database for the given submission document.SubmissionService.saveSubmission
(SubmissionDataBean submissionDataBean, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog) Deprecated.SubmissionService.saveSubmission
(SubmissionDataBean submissionDataBean, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, boolean isBackgroundSave) Create a Submission record and persists it into the database for the given submission document.protected Submission
SubmissionService.saveSubmissionUnmanaged
(UserAccount userAccount, SubmissionDataBean submissionDataBean, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, boolean isBackgroundSave) Create a submission record Save a submission record without committing the database transaction.Modifier and TypeMethodDescriptionvoid
SubmissionAcknowledgementService.acknowledgeSubmission
(Submission submission, boolean acknowledged, String userName) Acknowledge a submission by changing the submission status and populate the user profile from the submitted data if applicable.AttachmentService.addAttachment
(Submission submission, String attachmentName, String fileName, byte[] fileData, String userDesciption) Add the specified file attachment to the submission.AttachmentService.addAttachment
(Submission submission, String attachmentName, String fileName, byte[] fileData, String fileType, String userDesciption) Add the specified file attachment to the submission.AttachmentService.addInFormAttachment
(Submission submission, byte[] fileData, String fileName, String contentType, RequiredAttachmentMetadata attachmentMetadata, String attachmentKey, boolean isTFieldAttachment) Add the specified fileData to the submission with the associated required attachment metadata.AttachmentService.addInFormAttachment
(Submission submission, String baseXPath, String filename, byte[] fileData) Adds an arbitrary file to as an in form attachment to the submission provided.AttachmentService.addInFormAttachment
(Submission submission, org.apache.commons.fileupload.FileItem fileItem, RequiredAttachmentMetadata attachmentMetadata, String attachmentKey) Add the specified FileItem to the submission with the associated required attachment metadata.AttachmentService.addInFormSubmitManuallyAttachment
(Submission submission, String attachmentKey, String attachmentName, String mandatoryStatus) Add the specified manually submitted required attachment.AttachmentService.addInFormSubmitManuallyAttachment
(Submission submission, String attachmentKey, String attachmentName, String mandatoryStatus, boolean isTFieldAttachment) Add the specified manually submitted required attachment.AttachmentService.addReceiptAsInFormAttachment
(Submission submission, Submission receiptSubmission, String baseXPath) Adds the receipt from a submission as an in form attachment to another submission.void
SubmissionService.addServiceLog
(Submission submission, String serviceName, String serviceInfo, String serviceUrl) Record service usage for a submission.protected void
LocalProcessRenderReceiptService.appendContextDebugInfo
(StringBuilder context, String htmlFilePath, LocalProcessRenderReceiptService.ProcessParams params, Submission submission) FormDataService.applyFormPrefillService
(ServiceDefinition formPrefillSD, Document document, jakarta.servlet.http.HttpServletRequest request, Form form, TemplateVersion templateVersion, Submission submission) Apply the form prefill service to the submission document.void
IAuthenticationService.associateSubmissionUser
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Associate the user with the submission.void
UserService.associateUserWithSubmission
(UserAccount user, Submission submission) Associate the given user account with the specified submission, also associate user with the submission's portal if not associated.void
IRemoteAuditService.auditDeliveredSubmission
(Submission submission) Audit the delivered submissionvoid
IRemoteAuditService.auditSubmittedSubmission
(Submission submission) Audit the submission.boolean
SubmissionStatusService.canChangeDeliveryStatus
(Submission submission, String newDeliveryStatus) Check whether a submission can be manually updated to a given delivery status.ReceiptDataService.clearPaymentReceiptDetails
(Submission submission, String receiptXml) Clears out payment information stored in the receipt data, then stores the updated receipt XML.ISubmissionDeliveryController.completeRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, boolean deleteData, String processingStatus) Complete REST Service submission delivery and return the completed submission.void
SubmissionService.copyFormAttachments
(Submission sourceSubmission, Submission targetSubmission, Document targetXmlDoc) Copy the attachments of the source submission to the target submission and its form XML document.ErrorLogService.createErrorLog
(org.apache.cayenne.access.DataContext dataContext, Throwable error, String userName, jakarta.servlet.http.HttpServletRequest request, Submission submission) Create an error log entry for the given exception.ErrorLogService.createErrorLog
(org.apache.cayenne.access.DataContext dataContext, Throwable error, String userName, jakarta.servlet.http.HttpServletRequest request, Submission submission, EmailQueue emailQueue, JobAction jobAction) Create an error log entry for the given exception, logged in userName and requestUrl.ErrorLogService.createErrorLog
(org.apache.cayenne.access.DataContext dataContext, Throwable error, String userName, jakarta.servlet.http.HttpServletRequest request, Submission submission, EmailQueue emailQueue, JobAction jobAction, boolean groovyError, String message) Create an error log entry for the given exception, logged in userName and requestUrl.protected ApplicationException
AbstractGroovyService.createExceptionAndLog
(Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, Throwable cause, String context, String userMsg, String solution, Submission submission, Form form, Client client) Create application exception and optionally log ErrorLog and GroovyServiceLog records if Groovy Logging enabled.ErrorLogService.createJavaScriptErrorLog
(String context, String stacktrace, jakarta.servlet.http.HttpServletRequest request, Submission submission) Create a Form JavaScript error log record to support the Open UX API.boolean
ISubmissionReceiptService.createReceiptPdf
(Submission submission) Create the PDF Receipt and store it in the submissionRequestLogService.createRequestLog
(jakarta.servlet.http.HttpServletRequest request, Form form, TemplateVersion templateVersion, Submission submission, UserAccount userAccount, String renderMode) Create a request log and register it with the data contextRequestLogService.createRequestLog
(jakarta.servlet.http.HttpServletRequest request, Form form, TemplateVersion templateVersion, Submission submission, UserAccount userAccount, String renderMode, boolean commitChanges) Create a request log and register it with the data contextTaskService.createReviewTask
(Submission reviewSubmission, Form form, String taskSubject, String taskMessage, Integer sequence, UserAccount user, Group group, String formDataXml, Double latitude, Double longitude, String address, Date datetimeScheduled, Date datetimeExpiry, boolean sendEmailFlag, String emailSubject, String emailMessage, boolean userDeletableFlag) Create a review task for a user or a user group to do.TaskService.createReviewTask
(Submission reviewSubmission, Form form, String taskSubject, String taskMessage, Integer sequence, UserAccount user, Group group, String formDataXml, Double latitude, Double longitude, Date datetimeScheduled, Date datetimeExpiry, boolean sendEmailFlag, String emailSubject, String emailMessage, boolean userDeletableFlag) Create a review task for a user or a user group to do.SubmissionService.createSubmissionHistory
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, boolean isBackgroundSave) Create a new submission history record.SubmissionService.createSubmissionHistory
(Submission submission, jakarta.servlet.http.HttpServletRequest request, Date requestTime) Create a new submission history record.SubmissionService.createSubmissionHistory
(Submission submission, jakarta.servlet.http.HttpServletRequest request, Date requestTime, boolean isBackgroundSave) Create a new submission history record.void
AuditLogService.createSubmissionViewAuditLog
(Submission submission, String dataType) Create a submission view audit log record.void
ITransactionHistoryCreationService.createTransactionHistory
(Submission submission) Deprecated.ISubmissionDataStorageService.decryptText
(Submission submission, String cypherText) Decrypt a submission related string that was created using encryptTextboolean
ISubmissionDataStorageService.deleteSubmissionData
(Submission submission) Delete submission data, attachment data, submission history data and return true if successful.IDeliveryProcessService.deliverSubmission
(Submission submission, DeliveryDetails deliveryDetails) Deliver the given submission using a delivery process and return the process invocation identifier.ISubmissionDeliveryController.deliverSubmission
(Submission submission) Deliver the given submission and return a delivery status message.ISubmissionDataStorageService.encryptText
(Submission submission, String plainText) Encrypt a string related to a submission, returning Base64 encoded cipher text.ISubmissionDeliveryController.errorRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, String errorMessage, jakarta.servlet.http.HttpServletRequest request) Set a REST submission delivery error and return the updated submission.ITaskExpiryProcessService.expireTask
(Submission task) Expire the specified task submission.void
SubmissionService.expireTaskSubmission
(Submission submission) Expires the given task submission and calls the expiry REST endpoint, if defined.IFindDeliveryProcessIDService.findDeliveryProcessIDService
(Submission submission) Return the LiveCycle delivery process ID for the given submission.static IEmailService
ServiceLocator.getEmailService
(Submission submission) Return the email service for the submission.SubmissionService.getPendingPaymentLog
(Submission submission, String serviceCode) Returns the most recent payment log that is pending for the given submission and payment service codeprotected abstract DataDocument
AbstractRenderReceiptService.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) Return the PDF Receipt DataDocument for the submission, request and requestLog.protected DataDocument
LocalProcessRenderReceiptService.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) byte[]
ReceiptDataService.getReceiptPdf
(Submission submission, String mode) Get receipt pdf as byte array.ReceiptDataService.getReceiptXml
(Submission submission) Returns the receipt xml data for a submission If a submission has no receipt data but does have submission data, the receipt data will be generated from the form data.protected String
ReceiptDataService.getReceiptXPath
(Submission submission) Return the Receipt XPath for the given submissionServiceLocator.getSubmissionCompletedProcessor
(Submission submission) Return the submission form completed processor service for the given submissions template version.ServiceLocator.getSubmissionDataStorageService
(Submission submission) Return the SubmissionDataStorageService for the given submission, or the default storage service if not defined.byte[]
ISubmissionDataStorageService.getSubmissionReceipt
(Submission submission) Gets the submission receipt data.byte[]
ISubmissionDataStorageService.getSubmissionXml
(Submission submission) Gets the submission xml data.IEmailService.getTemplatedEmailMessageForSubmission
(Submission submission, String subject, String message) Return the HTML border templated email message for the given submission.IEmailService.getTemplatedEmailMessageForSubmission
(Submission submission, String subject, String message, Portal portal) Return the HTML border templated email message for the given submission.boolean
ReceiptDataService.hasReceiptXml
(Submission submission) Returns whether a submission has receipt data Note: If a submission has been deleted, this will return false.boolean
ISubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) Initializes the crypto data key for the submission This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.SubmissionService.initializeOpenedSubmission
(Form form, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, Document document, Submission submission) Initializes an open submission record ready for filling out.void
SubmissionService.initiateEmailVerification
(Document document, Submission submission, Form form, SchemaSeedVO schemaSeed, jakarta.servlet.http.HttpServletRequest request) Initiate submission email verification if configuredprotected void
SubmissionStatusService.invokeSubmissionCompletedProcessor
(ISubmissionCompletedProcessor completedProcessor, Submission submission) Invoke the given Submission Completed Process against the given submission.boolean
TaskService.isAssignee
(Submission task, UserAccount user) Check whether the task is assigned to a particular user.ErrorLogService.logError
(Class source, String userMsg, String context, Throwable cause, Submission submission) Log an error with the given class source, user message, context and cause.void
EventLogService.logErrorEvent
(String message, Submission submission) Log a error event with the given message and associated submission.void
EventLogService.logErrorEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request) Log a error event with the given message and associated submission.void
EventLogService.logErrorEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean writeToLogger) Log a error event with the given message and associated submission.void
EventLogService.logErrorEvent
(String messageFormat, Object[] args, Submission submission) Log a error event with the given message format, arguements and submission.protected void
EventLogService.logEvent
(String type, String message, Submission submission) protected void
EventLogService.logEvent
(String type, String message, Submission submission, boolean writeToLogger) ErrorLogService.logException
(Throwable error, Submission submission) Logs an Exception.ErrorLogService.logException
(Throwable error, jakarta.servlet.http.HttpServletRequest request, boolean autoRollback, Submission submission) Deprecated.autoRollback behaviour has been removed as of TM 4.1.ErrorLogService.logException
(Throwable error, jakarta.servlet.http.HttpServletRequest request, boolean autoRollback, Submission submission, EmailQueue emailQueue) Deprecated.autoRollback behaviour has been removed as of TM 4.1.ErrorLogService.logException
(Throwable error, jakarta.servlet.http.HttpServletRequest request, Submission submission, EmailQueue emailQueue) Logs an Exception.ErrorLogService.logExceptionNoRollback
(Throwable error, Submission submission) Deprecated.autoRollback behaviour has been removed as of TM 4.1, use logException(Throwable, Submission) insteadErrorLogService.logGroovyException
(Throwable error, jakarta.servlet.http.HttpServletRequest request, Submission submission) Logs an Groovy Script Exception.void
EventLogService.logInfoEvent
(String message, Submission submission) Log an info event with the given message and associated submission.void
EventLogService.logInfoEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request) Log an info event with the given message and associated submission.void
EventLogService.logInfoEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean writeToLogger) Log an info event with the given message and associated submission.void
EventLogService.logInfoEvent
(String messageFormat, Object[] args, Submission submission) Log a info event with the given message and associate with the submission.void
ErrorLogService.logJobActionError
(Throwable error, JobAction jobAction, Submission submission) Deprecated.void
ErrorLogService.logJobActionError
(Throwable error, JobAction jobAction, Submission submission, boolean groovyError) Log a JobAction exception to the error log.void
EventLogService.logSecurityEvent
(String message, Submission submission) Log a security event with the given message and for the given submission.void
EventLogService.logSecurityEvent
(String message, Submission submission, boolean writeToLogger) Log a security event with the given message and for the given submission.void
EventLogService.logSecurityEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request) Log a security event with the given message and for the given submission.void
EventLogService.logSecurityEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean writeToLogger) Log a security event with the given message and for the given submission.GroovyLogService.logServiceCall
(ServiceDefinition serviceDefinition, Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, jakarta.servlet.http.HttpServletRequest request, Submission submission, Form form, Client client, ErrorLog errorLog, boolean debugEnabled, String funcTrigger) Log Groovy Service invocation using the specified parameters.void
EventLogService.logWarnEvent
(String message, Submission submission) Log a warning event with the given message and associated submission.void
EventLogService.logWarnEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request) Log a warning event with the given message and associated submission.void
EventLogService.logWarnEvent
(String message, Submission submission, jakarta.servlet.http.HttpServletRequest request, boolean writeToLogger) Log a warning event with the given message and associated submission.void
ISubmissionCompletedProcessor.onSubmissionCompleted
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) This event handlers is invoked when the submission form status becomes 'Completed'.void
IFormSecurityFilterService.performCheck
(jakarta.servlet.http.HttpServletRequest request, TemplateVersion version, Submission submission) Validates a request for an in-progress submission.boolean
AbandonmentService.performExplicitAdminAbandonment
(Submission submission) Perform explicit administrator abandonment.boolean
AbandonmentService.performExplicitUserAbandonment
(Submission submission) Perform explicit user abandonment.boolean
AbandonmentService.performExplicitUserTaskAbandonment
(Submission submission) Perform explicit user submission task abandonment.boolean
AbandonmentService.performImmediateAdminAbandonment
(Submission submission, AbandonmentService.AbandonMode abandonMode) Perform immediate administrator abandonment.boolean
AbandonmentService.performImplicitAbandonment
(Submission submission) Perform implicit abandonment.boolean
AbandonmentService.performIneligibilityAbandonment
(Submission submission) Perform submission abandonment due to user ineligibility.protected void
FormDataService.populateDynamicData
(Document seedDocument, Form form, jakarta.servlet.http.HttpServletRequest request, UserAccount userAccount, RequestLog requestLog, String referer, Submission submission, TemplateVersion templateVersion, SchemaSeedVO schemaSeed) Populate any Dynamic data into the seed document.boolean
FormDataService.populateInsightsProfile
(jakarta.servlet.http.HttpServletRequest request, Submission submission, Document document) Populate the Insights system profile information.FormDataService.populateSeedXml
(Form form, jakarta.servlet.http.HttpServletRequest request, String xmlPrefillData, boolean userAccountPrefill, TemplateVersion templateVersion, RequestLog requestLog, String referer, Submission submission) Return a populated form seed XML document, populated with the form specific attachments, client properties, user properties and system properties.FormDataService.populateSeedXmlDoc
(Form form, jakarta.servlet.http.HttpServletRequest request, String xmlPrefillData, boolean userAccountPrefill, TemplateVersion version, RequestLog requestLog, String referer, Submission submission) Return a populated form seed XML document, populated with the form specific attachments, client properties, user properties and system properties.FormDataService.populateSeedXmlFromSeed
(Form form, jakarta.servlet.http.HttpServletRequest request, String seedFileString, boolean userAccountPrefill, TemplateVersion templateVersion, RequestLog requestLog, String referer, Submission submission) Return a populated form seed XML document, using the input seed XML and adding the system profile and user specific data Note that this method contains database transactions.FormDataService.populateSeedXmlFromSeedDoc
(Form form, jakarta.servlet.http.HttpServletRequest request, String seedFileString, boolean userAccountPrefill, TemplateVersion version, RequestLog requestLog, String referer, Submission submission) Return a populated form seed XML document, using the input seed XML and adding the system profile and user specific data Note that this method contains database transactions.void
SubmissionService.populateSubmissionExtractData
(Document document, Submission submission, SchemaSeed schemaSeed) Populate submission XML data extract values.void
SubmissionService.populateSubmissionExtractData
(Document document, Submission submission, SchemaSeedVO schemaSeed) Populate submission XML data extract values.protected void
FormDataService.populateSystemProfile
(Document seedDocument, Form form, jakarta.servlet.http.HttpServletRequest request, UserAccount userAccount, RequestLog requestLog, String referer, Submission submission, TemplateVersion templateVersion) Populate the system profile information in the XML seed document.boolean
FormDataService.populateSytemProfileJobs
(jakarta.servlet.http.HttpServletRequest request, Document document, Submission submission) Populate the SystemProfile Job elements, and return true if system profile job task steps were updated.void
SubmissionService.prepareReturnToForm
(Submission submission, byte[] submissionXmlData, jakarta.servlet.http.HttpServletRequest request) Prepare a submission for a "Return to Form" operation.void
SubmissionService.pruneOrphanedInFormAttachments
(Document document, Submission submission, jakarta.servlet.http.HttpServletRequest request) Prune orphaned In-Form attachments from the submission record based on the form XML document.IEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String subject, String body, String category) Create an email on the email queueIEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String cc, String bcc, String replyTo, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queue.IEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String cc, String replyTo, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queue.IEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String replyTo, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queueIEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queueboolean
IEmailService.queueFormReceiptEmail
(Submission submission, String toAddress) Queue email for submission receipt to an address.boolean
IEmailService.queueFormReceiptEmail
(Submission submission, String toAddress, String ccAddress) Queue email for submission receipt to an address.boolean
IEmailService.queueFormReceiptEmail
(Submission submission, String toAddress, String ccAddress, String bccAddress) Queue email for submission receipt to an address.boolean
IEmailService.queueOrSendFormConfirmationReceiptMessage
(Submission submission, String toAddress) Deprecated.void
IEmailService.queueSavedFormEmail
(Submission submission, String formUrl, String toAddress) Queue email with a link to a saved submission to an anonymous uservoid
IEmailService.queueSavedFormEmail
(Submission submission, String formUrl, String toAddress, String ccAddress) Queue email with a link to a saved submission to an anonymous uservoid
IEmailService.queueSavedFormEmail
(Submission submission, String formUrl, String toAddress, String ccAddress, String bccAddress) Queue email with a link to a saved submission to an anonymous uservoid
IEmailService.queueShareFormEmail
(Submission submission, String senderName, String emailAddresses, String emailBody) Queue an email notifying people with whom a saved form has been shared.void
IEmailService.queueSubmissionUpdateNotification
(Submission submission, String emailSubject, String emailBody) Create the submission update notification on an email queue.protected void
LocalProcessRenderReceiptService.rasterize
(LocalProcessRenderReceiptService.ProcessParams params, Submission submission) void
SubmissionStatusService.reassignTaskSubmission
(Submission submission, UserAccount newAssignee, jakarta.servlet.http.HttpServletRequest request) Reassign the task submission to the specified user account.void
AbstractRenderReceiptService.renderReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog) Render the PDF Receipt given the submission.byte[]
AbstractRenderReceiptService.renderReceipt
(Submission submission, String mode) Return a PDF Receipt byte array rendered from the submission.void
IRenderReceiptService.renderReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog) Render the PDF Receipt given the submission.byte[]
IRenderReceiptService.renderReceipt
(Submission submission, String mode) Return a PDF Receipt byte array rendered from the submission.boolean
AbandonmentService.requiresAbandonDelivery
(Submission submission) Return true if the submission requires abandonment delivery.boolean
SubmissionStatusService.resetTaskSubmission
(Submission submission) Reset a task submission that has been abandoned or rejected by the user.void
SubmissionService.resumeAbandonedForm
(Submission submission) Resume the abandoned 'Open' or 'Form Start' submission.boolean
SubmissionService.retryRESTSubmissionDelivery
(Submission submission) Reset the 'In Progress' delivery to 'Ready' to enable REST Service delivery queue retry.AttachmentService.saveArbitaryAttachmentForSubmission
(Submission submission, String type, String fileName, byte[] fileData, String mimeType, String description) Save an optional file attachment for a submission.void
AttachmentService.saveEmbeddedAttachmentForSubmission
(EmbeddedAttachment embeddedAttachment, Submission submission) Save the embedded attachment for the given submission.void
IEmailService.sendEmailMessage
(String subject, String message, String fromAddress, String replyToAddress, String toAddress, String ccAddress, String bccAddress, Map<String, byte[]> attachmentMap, Submission submission) Send an email message.void
ISubmissionDeliveryController.sendEmailReminder
(Submission submission) Send an submission delivery reminder email.void
IEmailService.sendEmailVerification
(Submission submission) Immediately send an submission verification email.void
IEmailService.sendFormConfirmationMessage
(Submission submission, String toAddress) Send a submission confirmation email to an address, which does not include a PDF receiptvoid
IEmailService.sendFormReceiptMessage
(Submission submission, String toAddress) Send a submission receipt to an address.void
IEmailService.sendSavedFormEmail
(Submission submission, String formUrl, String toAddress) Send an email with a link to a saved submission to an anonymous uservoid
IEmailService.sendSavedFormEmail
(Submission submission, String formUrl, String toAddress, boolean backgroundThread) Send an email with a link to a saved submission to an anonymous userboolean
IEmailService.sendTaskNotification
(Submission submission) Send a task notification to a user or a group of users.void
AttachmentService.setAttachmentsComplete
(Submission submission) Set attachment status of a given submission to be complete.void
ISubmissionDeliveryController.setEmailSubmissionDeliveryCompleted
(Submission submission) Set the submission delivery status as completed.void
ReceiptDataService.setPaymentReceiptDetails
(Submission submission, String receiptNo, Date paymentDate) Allows to set the receipt number and payment date to be written in to the Receipt section The Receipt section is looked up using the schema config map for the submission's form deploy Note that this method does NOT commit the changes, it merely writes them into the submission's receipt data.ErrorLoggerSvc.setSubmission
(Submission submission) Set the associated submission with errorvoid
FormPrefillService.setSubmission
(Submission submission) Optionally set the task submission record before thegetFormPrefillData
method is called.void
ISubmissionDeliveryController.setSubmissionDeliveryCompleted
(Submission submission, String dataHash) Set the submission delivery status as completed and delete the submission data if configured.void
ISubmissionDeliveryController.setSubmissionDeliveryCompletedByAdmin
(Submission submission, String userName) Set the submission delivery status as completed.protected void
SubmissionService.setSubmissionExpiryTime
(Submission submission, Document document) Set the submission expiry time based on the associated form configuration.void
SubmissionDataService.setSubmissionReceiptNumber
(Submission submission, String receiptNumber) Set the submission receipt number on the submission record and in the submission XML data.void
SubmissionDataService.setSubmissionXmlData
(Submission submission, String xmlData, jakarta.servlet.http.HttpServletRequest request) Set the submission XML data with the given value.void
SubmissionService.setTaskAssigneeGroup
(Submission submission, Group group) Update the assignee group for a task submission.static void
GroovyLogService.setThreadSubmission
(Submission submission) Set the thread local context submission, for associating groovy service log records with any executing submission context.void
ISubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) Store the submission attachment file data.void
ISubmissionDataStorageService.storeSubmissionAndHistoryXml
(Submission submission, SubmissionHistory history, byte[] xmlData) Store submission form xml data against the submission and submission history objects.void
ISubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) Store submission receipt data.void
ISubmissionDataStorageService.storeSubmissionXml
(Submission submission, byte[] xmlData) Store submission form xml data.void
SubmissionStatusService.unassignTaskSubmission
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Unassign the task submission, removing the user associated with it.void
SubmissionStatusService.updateAttachmentStatusManually
(Submission submission, String attachmentStatus) Update the submission attachment status manually by specifying the new attachment status.void
SubmissionStatusService.updateDeliveryStatusManually
(Submission submission, String deliveryStatus) Update the submission delivery status manually by specifying the new delivery status.void
SubmissionStatusService.updateEmailVerificationStatusManually
(Submission submission, String emailVerificationStatus) Update the submission email verification status manually by specifying the new status.boolean
SubmissionStatusService.updateFormStatusManually
(Submission submission, String formStatus) Update the submission form status manually by specifying the new form status.void
SubmissionStatusService.updatePaymentStatusManually
(Submission submission, String paymentStatus) Update the submission payment status manually by specifying the new payment status.boolean
SubmissionService.updatePaymentTypeForService
(Submission submission) Looks up the payment service for the submission's client and updates the payment type if necessary.void
SubmissionStatusService.updateReceiptStatusManuallyToReady
(Submission submission) Update the submission receipt status manually to ready status, deleting any previously generated PDF receipt data.FormDataService.updateSavedFormSystemProfile
(jakarta.servlet.http.HttpServletRequest request, Submission submission, Document document) Update the system profile for a saved form.FormDataService.updateSavedFormSystemProfile
(jakarta.servlet.http.HttpServletRequest request, Submission submission, Document document, RequestLog requestLog) Update the system profile for a saved form.SubmissionStatusService.updateStatus
(Submission submission) Update the status of the submission and commits the changes.SubmissionStatusService.updateStatus
(Submission submission, Document document) Update the status of the submission and commits the changes.void
SubmissionService.updateSubmissionDeliveryProcessID
(Submission submission) Deprecated.LiveCycle support has been removedISubmissionDataValidator.validateSubmission
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) Validate the submission's XML data, returning empty list if no errors or a list of errors message if data validation failures occur.protected boolean
SubmissionStatusService.virusScanComplete
(Submission submission) Check whether the virus scan has been performed for all attachments associated with the submission. -
Uses of Submission in com.avoka.fc.core.service.email
Modifier and TypeMethodDescriptionprotected ApplicationException
GroovyEmailService.createExceptionAndLog
(Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, Throwable cause, String context, String userMsg, String solution, Submission submission, Form form, Client client) Create application exception and optionally log ErrorLog and GroovyServiceLog records if Groovy Logging enabled.AbstractEmailService.getTemplatedEmailMessageForSubmission
(Submission submission, String subject, String message) Return the HTML border templated email message for the given submission.AbstractEmailService.getTemplatedEmailMessageForSubmission
(Submission submission, String subject, String message, Portal portal) Return the HTML border templated email message for the given submission.AbstractEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String subject, String body, String category) Create an email on the email queueAbstractEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String cc, String bcc, String replyTo, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queue.AbstractEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String cc, String replyTo, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queue.AbstractEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String replyTo, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queueAbstractEmailService.queueEmail
(Portal portal, Submission submission, String from, String to, String subject, String body, String category, Map<String, byte[]> attachmentMap) Create an email on the email queueboolean
AbstractEmailService.queueFormReceiptEmail
(Submission submission, String toAddress) Queue email for submission receipt to an address.boolean
AbstractEmailService.queueFormReceiptEmail
(Submission submission, String toAddress, String ccAddress) Queue email for submission receipt to an address.boolean
AbstractEmailService.queueFormReceiptEmail
(Submission submission, String toAddress, String ccAddress, String bccAddress) Queue email for submission receipt to an address.boolean
AbstractEmailService.queueOrSendFormConfirmationReceiptMessage
(Submission submission, String toAddress) Deprecated.void
AbstractEmailService.queueSavedFormEmail
(Submission submission, String formUrl, String toAddress) Queue email with a link to a saved submission to an anonymous uservoid
AbstractEmailService.queueSavedFormEmail
(Submission submission, String formUrl, String toAddress, String ccAddress) Queue email with a link to a saved submission to an anonymous uservoid
AbstractEmailService.queueSavedFormEmail
(Submission submission, String formUrl, String toAddress, String ccAddress, String bccAddress) Queue email with a link to a saved submission to an anonymous uservoid
AbstractEmailService.queueShareFormEmail
(Submission submission, String senderName, String emailAddresses, String emailBody) Queue an email notifying people with whom a saved form has been shared.void
AbstractEmailService.queueSubmissionUpdateNotification
(Submission submission, String emailSubject, String emailBody) Create the submission update notification on an email queue.void
ExchangeEmailService.sendEmailMessage
(String subject, String message, String fromAddress, String replyToAddress, String toAddress, String ccAddress, String bccAddress, Map<String, byte[]> attachmentMap, Submission submission) Send an email message.void
GroovyEmailService.sendEmailMessage
(String subject, String message, String fromAddress, String replyToAddress, String toAddress, String ccAddress, String bccAddress, Map<String, byte[]> attachmentMap, Submission submission) Send an email message.void
SmtpEmailService.sendEmailMessage
(String subject, String message, String fromAddress, String replyToAddress, String toAddress, String ccAddress, String bccAddress, Map<String, byte[]> attachmentMap, Submission submission) Send an email message.void
TrashCanEmailService.sendEmailMessage
(String subject, String message, String fromAddress, String replyToAddress, String toAddress, String ccAddress, String bccAddress, Map<String, byte[]> attachmentMap, Submission submission) Send an email message.void
AbstractEmailService.sendEmailVerification
(Submission submission) Immediately send an submission verification email.void
AbstractEmailService.sendFormConfirmationMessage
(Submission submission, String toAddress) Send a submission confirmation email to an address, which does not include a PDF receiptvoid
AbstractEmailService.sendFormReceiptMessage
(Submission submission, String toAddress) Send a submission receipt to an address.void
AbstractEmailService.sendMessage
(String subject, String message, String from, String toAddress, Submission submission, boolean backgroundThread) Send an email message, optionally using a background thread.void
AbstractEmailService.sendSavedFormEmail
(Submission submission, String formUrl, String toAddress) Send an email with a link to a saved submission to an anonymous uservoid
AbstractEmailService.sendSavedFormEmail
(Submission submission, String formUrl, String toAddress, boolean backgroundThread) Send an email with a link to a saved submission to an anonymous userboolean
AbstractEmailService.sendTaskNotification
(Submission submission) Send a task notification to a user or a group of users. -
Uses of Submission in com.avoka.fc.core.service.fluent
Modifier and TypeMethodDescriptionprotected ApplicationException
AbstractFluentService.createExceptionAndLog
(Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, Throwable cause, String context, String userMsg, String solution, JobAction jobAction, Submission submission, Form form, String functionTrigger) Create application exception and optionally log ErrorLog and GroovyServiceLog records if Groovy Logging enabled.FluentDeliveryProcessService.deliverSubmission
(Submission submission, DeliveryDetails deliveryDetails) Deliver the given submission using a Fluent Groovy Script delivery process and return a delivery process invocation identifier if applicable.DeliveryFunctionProcessor.excecuteAllDeliveryFunctions
(Submission submission) Register the configured submission delivery function records.FluentFunctionService.execute
(String triggerType, jakarta.servlet.http.HttpServletRequest request, Submission submission, Map<String, Object> params, Document formDoc, org.apache.commons.fileupload.FileItem fileAttachment, UserAccount userAccount) Execute the Fluent function and return a func result object.FormFunctionsExecutor.execute
(jakarta.servlet.http.HttpServletRequest request, Submission submission, Document formData, Map<String, Object> parameters, org.apache.commons.fileupload.FileItem fileAttachment, UserAccount userAccount) Execute the form functions in sequence for the given trigger type.FluentTaskExpiryService.expireTask
(Submission task) Expire the specified task submission.static List<IFluentFunction>
FluentFunctionsProvider.getFluentFunctions
(String trigger, Submission submission) Return the list of Fluent Functions for the given trigger and submission record.FluentDynamicDataService.getFormData
(jakarta.servlet.http.HttpServletRequest request, Form form, Submission submission) Return the dynamic form data for the request and form.FluentRenderReceiptService.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) Return the PDF Receipt DataDocument for the submission, request and requestLog.void
FluentSubmissionCompletedProcessor.onSubmissionCompleted
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) This event handler is invoked when the submission form status becomes 'Completed'.void
FluentFormSavedProcessor.onSubmissionSaved
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) This event handler is invoked when the submission has been saved.void
FluentFormSecurityFilterService.performCheck
(jakarta.servlet.http.HttpServletRequest request, TemplateVersion version, Submission submission) Validates a request for an in-progress submission.void
FluentReceiptNumberService.populateReceiptNumber
(Submission submission, String submissionXml) Populate the submission's receipt number.boolean
DeliveryFunctionProcessor.registerSubmissionDeliveryFunctions
(Submission submission) Register any available submission delivery function records and return true if the submission has delivery functions registered.void
FluentRenderReceiptService.renderReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog) Render the PDF Receipt given the submission.byte[]
FluentRenderReceiptService.renderReceipt
(Submission submission, String mode) Return a PDF Receipt byte array rendered from the submission.void
FluentEmailService.sendEmailMessage
(String subject, String message, String fromAddress, String replyToAddress, String toAddress, String ccAddress, String bccAddress, Map<String, byte[]> attachmentMap, Submission submission) Send an email message.DeliveryFunctionProcessor.setSubmission
(Submission submission) void
FluentFormPrefillService.setSubmission
(Submission submission) Optionally set the task submission record before thegetFormPrefillData
method is called.DeliveryFunctionProcessor.updateDeliveryStatus
(Submission submission) Update the delivery status based on the current delivery functions.FluentSubmissionDataValidator.validateSubmission
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXml) Validate the submission's XML data, returning empty list if no errors or a list of errors message if validation failures occur. -
Uses of Submission in com.avoka.fc.core.service.form
Modifier and TypeMethodDescriptionGroovyDynamicDataService.getFormData
(jakarta.servlet.http.HttpServletRequest request, Form form, Submission submission) Return the dynamic form data for the request and form.IDynamicDataService.getFormData
(jakarta.servlet.http.HttpServletRequest request, Form form, Submission submission) Return the lookup form data for the request and form.void
GroovyReceiptNumberService.populateReceiptNumber
(Submission submission, String submissionXml) void
IReceiptNumberService.populateReceiptNumber
(Submission submission, String submissionXml) Populate the submission's receipt numbervoid
RandomReceiptNumberService.populateReceiptNumber
(Submission submission, String submissionXml) Populate the submission's receipt numbervoid
SequencePatternReceiptNumberService.populateReceiptNumber
(Submission submission, String submissionXml) void
GroovyFormPrefillService.setSubmission
(Submission submission) Optionally set the task submission record before thegetFormPrefillData
method is called. -
Uses of Submission in com.avoka.fc.core.service.impl
Modifier and TypeMethodDescriptionSubmissionDeliveryControllerService.completeRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, boolean deleteData, String processingStatus) Complete REST Service submission delivery and return the completed submission.SubmissionDeliveryControllerService.errorRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, String errorMessage, jakarta.servlet.http.HttpServletRequest request) Set a REST submission delivery error and return the updated submission.SubmissionDeliveryControllerService.getNextRESTSubmission
(DeliveryDetails deliveryDetails) Return the next submission ready for delivery for the given REST Service delivery details, and set the Submission delivery status to 'In Progress' or null otherwise.Modifier and TypeMethodDescriptionvoid
AuthenticationServiceImpl.associateSubmissionUser
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Associate the user with the submission.SubmissionDeliveryControllerService.completeRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, boolean deleteData, String processingStatus) Complete REST Service submission delivery and return the completed submission.boolean
SubmissionReceiptServiceImpl.createReceiptPdf
(Submission submission) Create the PDF Receipt and store it in the submissionvoid
TransactionHistoryCreationService.createTransactionHistory
(Submission submission) Create a transaction history record for the given submission.GroovyDeliveryProcessService.deliverSubmission
(Submission submission, DeliveryDetails deliveryDetails) Deliver the given submission using a Groovy Script delivery process and return a delivery process invocation identifier if applicable.SubmissionDeliveryControllerService.deliverSubmission
(Submission submission) Deliver the given submission and return a delivery status message.protected String
SubmissionDeliveryControllerService.deliverViaDeliveryProcess
(Submission submission, DeliveryDetails deliveryDetails, IDeliveryProcessService deliveryProcess, String deliveryServiceName) Deliver the given submission via Delivery Process using the delivery details provided.protected String
SubmissionDeliveryControllerService.deliverViaEmail
(Submission submission, DeliveryDetails deliveryDetails) Deliver the given submission via email using the delivery details provided.protected String
SubmissionDeliveryControllerService.deliverViaEmailSecure
(Submission submission, DeliveryDetails deliveryDetails) Deliver the given submission via email using the delivery details provided.SubmissionDeliveryControllerService.errorRESTDelivery
(DeliveryDetails deliveryDetails, Submission submission, String errorMessage, jakarta.servlet.http.HttpServletRequest request) Set a REST submission delivery error and return the updated submission.GroovyRenderReceiptService.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) Return the PDF Receipt DataDocument for the submission, request and requestLog.IRenderReceiptDocument.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) Return the PDF Receipt DataDocument for the submission, request and requestLog.void
GroovyFormSecurityFilterService.performCheck
(jakarta.servlet.http.HttpServletRequest request, TemplateVersion version, Submission submission) Validates a request for an in-progress submission.void
GroovyRenderReceiptService.renderReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog) Render the PDF Receipt given the submission.byte[]
GroovyRenderReceiptService.renderReceipt
(Submission submission, String mode) Return a PDF Receipt byte array rendered from the submission.void
SubmissionDeliveryControllerService.sendEmailReminder
(Submission submission) Send an submission delivery reminder email.void
SubmissionDeliveryControllerService.setEmailSubmissionDeliveryCompleted
(Submission submission) Set the submission delivery status as completed.void
SubmissionDeliveryControllerService.setSubmissionDeliveryCompleted
(Submission submission, String dataHash) Set the submission delivery status as completed and delete the submission data if configured.void
SubmissionDeliveryControllerService.setSubmissionDeliveryCompletedByAdmin
(Submission submission, String userName) Set the submission delivery status as completed. -
Uses of Submission in com.avoka.fc.core.service.insights
Modifier and TypeMethodDescriptionInsightsEventPublisher.setSubmission
(Submission submission) Set the Insights submission event to publish -
Uses of Submission in com.avoka.fc.core.service.itext
Modifier and TypeMethodDescriptionprotected DataDocument
AcroFormRenderReceiptService.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) -
Uses of Submission in com.avoka.fc.core.service.job
Modifier and TypeMethodDescriptionboolean
IJobController.cancelledTaskSubmission
(Submission submission) Provides a callback to tell the Job controller that the given task submission has been cancelled.boolean
IJobController.completedTaskSubmission
(Submission submission) Provides a callback to tell the Job controller that the given task submission has been completed.IJobController.createJobWithSubmission
(Submission submission) Create a job with the submission, initializing the first step and action, and using the given submission and put step action in 'Ready' state. -
Uses of Submission in com.avoka.fc.core.service.job.impl
Modifier and TypeMethodDescriptionstatic Submission
JobActionUtils.getFormStartSubmission
(JobAction currentJobAction) Gets the original submission that started the Job's form start action.static Submission
JobActionUtils.getLastSubmission
(ActionContext actionContext, String stepName) Gets the submission for the specified step name working backwards from latest to earliest steps.static Submission
JobActionUtils.getPreviousSubmission
(JobAction currentJobAction) Gets the submission from the previous step action.static Submission
JobActionUtils.getRedirectNextTask
(Submission submission) Get the next task to redirect the user to for an Application Bundle workflow.static Submission
JobActionUtils.getStepSubmission
(Job job, String stepName) Return the first submission for the given step name or null if not found.JobFunctions.previousSubmission()
JobFunctions.startSubmission()
Modifier and TypeMethodDescriptionstatic List<Submission>
JobActionUtils.getCompletedSubmissionsForStep
(JobStep step) Returns a List of completed submissions for the step, in id order, for the given job step or and empty Liststatic List<Submission>
JobActionUtils.getSubmissionsForLastStep
(Job job, String stepName) Returns a List of submissions, in action order, for the latest job step and given step name or and empty Liststatic List<Submission>
JobActionUtils.getSubmissionsForStep
(Job job, String stepName) Returns a List of submissions, in id order, for the job and given step name or and empty Liststatic List<Submission>
JobActionUtils.getSubmissionsForStep
(JobStep step) Returns a List of submissions, in action order, for the given job step or and empty ListModifier and TypeMethodDescriptionstatic void
JobActionUtils.addSubmissionProcessingStatus
(ActionContext actionContext, ActionStepProperties actionStepProperties, Submission submission) Add processing status message to the submission.boolean
JobControllerService.cancelledTaskSubmission
(Submission submission) boolean
JobControllerService.completedTaskSubmission
(Submission submission) JobControllerService.createJobWithSubmission
(Submission submission) protected DeliveryDetails
JobDeliveryService.getDeliveryDetails
(Submission submission, String deliveryDetailsName, JobAction jobAction) Return the delivery details for the submission.JobActionUtils.getFormDataMap
(Submission submission) Returns the formDataMap for the current submissionstatic Submission
JobActionUtils.getRedirectNextTask
(Submission submission) Get the next task to redirect the user to for an Application Bundle workflow.static String
JobActionUtils.getRouteName
(Submission submission) Returns the route name from the given submission.JobFunctions.stepOrSubmissionXml
(Submission submission) Returns the submission XML data for the first submission in the current step, if there are no submissions then the submission XML data for the given submission object, or null if not found or submission XML data has been deleted.JobFunctions.submissionXml
(Submission submission) Return the submission XML data for the given submission object, or null if not found or submission XML data has been deleted.ModifierConstructorDescriptionActionPropertiesMap
(ActionStepProperties properties, Submission submission) Create an ActionStepProperties map adaptor. -
Uses of Submission in com.avoka.fc.core.service.payment
Modifier and TypeMethodDescriptionIHostedPaymentService.cancelPayment
(Submission submission, jakarta.servlet.http.HttpServletRequest req) Cancels the payment internally in SFM.IHostedPaymentService.completePayment
(Submission submission, jakarta.servlet.http.HttpServletRequest req) Confirms, validates, and finalizes the payment: Confirms with the 3rd party payment gateway that the callback request is genuine Validates the payment details (such as amount) Update the PaymentLog and Submission entities with the transaction details and status.IHostedPaymentService.errorPayment
(Submission submission, jakarta.servlet.http.HttpServletRequest req) Receives a error signal from the payment gateway and record the error internally in SFM.IHostedPaymentService.getCustomPaymentForm
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Returns the rendered HTML custom payment form which will be included in the payment page.IHostedPaymentService.getHostedPageURL
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Returns the URL of the hosted payment page on the 3rd party payment gateway that the user will be redirected to in order to perform the payment.IHostedPaymentService.handlePaymentCallback
(Submission submission, jakarta.servlet.http.HttpServletRequest req) Depending on the payment gateway implementation, this method may be invoked prior to completePayment and may need to perform the same set of tasks.boolean
IPaymentGatewayService.resolveOutstandingPayments
(Submission submission) Resolve any outstanding payments against the payment gateway for this submission -
Uses of Submission in com.avoka.fc.core.service.phantomjs
Modifier and TypeMethodDescriptionprotected DataDocument
PhantomJSRenderReceiptService.getReceiptDocument
(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode) -
Uses of Submission in com.avoka.fc.core.service.storage
Modifier and TypeMethodDescriptionprotected ApplicationException
CloudSubmissionDataStorageService.createAndLogException
(Exception error, Submission submission, String method, String storageUrl, String encoding) protected byte[]
AbstractSubmissionDataStorageService.decodeData
(Submission submission, byte[] data, String encoding) Decode the data for the given submission with the encoding type.protected byte[]
AmazonKMSSubmissionDataStorageService.decodeData
(Submission submission, byte[] data, String encoding) Deprecated.Decode the data for the given submission with the encoding type.byte[]
AwsHsmDataEncryptor.decodeData
(Submission submission, byte[] data, String encoding) Decode the data for the given submission.byte[]
AwsKmsDataEncryptor.decodeData
(Submission submission, byte[] data, String encoding) Decode the data for the given submission with the encoding type.byte[]
ISubmissionDataEncryptor.decodeData
(Submission submission, byte[] data, String encoding) Decode the data for the given submission.byte[]
LocalKeystoreDataEncryptor.decodeData
(Submission submission, byte[] data, String encoding) Decode the data for the given submission with the encoding type.AbstractSubmissionDataStorageService.decryptText
(Submission submission, String cypherText) Decrypt a submission related string that was created using encryptTextAmazonKMSSubmissionDataStorageService.decryptText
(Submission submission, String cypherText) Deprecated.Decrypt a submission related string that was created using encryptTextAwsHsmDataEncryptor.decryptText
(Submission submission, String cypherText) Decrypt a submission related string that was created using encryptTextAwsKmsDataEncryptor.decryptText
(Submission submission, String cypherText) Decrypt a submission related string that was created using encryptTextISubmissionDataEncryptor.decryptText
(Submission submission, String cypherText) Decrypt a submission related string that was created using encryptTextLocalKeystoreDataEncryptor.decryptText
(Submission submission, String cypherText) Decrypt a submission related string that was created using encryptTextprotected void
AzureSubmissionDataStorageService.deleteData
(String uri, Submission submission) Delete data from store.protected abstract void
CloudSubmissionDataStorageService.deleteData
(String storageUrlReceipt, Submission submission) boolean
AmazonKMSSubmissionDataStorageService.deleteSubmissionData
(Submission submission) Deprecated.Delete the transaction data associated with this submission, if not already deleted.boolean
AmazonS3SubmissionDataStorageService.deleteSubmissionData
(Submission submission) Deprecated.boolean
AwsSubmissionDataStorageService.deleteSubmissionData
(Submission submission) boolean
CloudSubmissionDataStorageService.deleteSubmissionData
(Submission submission) boolean
DatabaseSubmissionDataStorageService.deleteSubmissionData
(Submission submission) Delete the transaction data associated with this submission, if not already deleted.boolean
FileSystemSubmissionDataStorageService.deleteSubmissionData
(Submission submission) Delete the transaction data associated with this submission, if not already deleted.boolean
HybridCloudSubmissionDataStorageService.deleteSubmissionData
(Submission submission) protected byte[]
AbstractSubmissionDataStorageService.encodeData
(Submission submission, byte[] data, String encoding) Encode the data for the given submission with the encoding type.protected byte[]
AmazonKMSSubmissionDataStorageService.encodeData
(Submission submission, byte[] data, String encoding) Deprecated.Encode the data for the given submission with the encoding type.byte[]
AwsHsmDataEncryptor.encodeData
(Submission submission, byte[] data, String encoding) Encode the data for the given submission.byte[]
AwsKmsDataEncryptor.encodeData
(Submission submission, byte[] data, String encoding) Encode the data for the given submission with the encoding type.byte[]
ISubmissionDataEncryptor.encodeData
(Submission submission, byte[] data, String encoding) Encode the data for the given submission.byte[]
LocalKeystoreDataEncryptor.encodeData
(Submission submission, byte[] data, String encoding) Encode the data for the given submission with the encoding type.AbstractSubmissionDataStorageService.encryptText
(Submission submission, String plainText) Encrypt a string related to a submissionAmazonKMSSubmissionDataStorageService.encryptText
(Submission submission, String plainText) Deprecated.Encrypt a string related to a submission.AwsHsmDataEncryptor.encryptText
(Submission submission, String plainText) Encrypt a string related to a submission.AwsKmsDataEncryptor.encryptText
(Submission submission, String plainText) Encrypt a string related to a submission.ISubmissionDataEncryptor.encryptText
(Submission submission, String plainText) Encrypt a string related to a submission.LocalKeystoreDataEncryptor.encryptText
(Submission submission, String plainText) Encrypt a string related to a submissionprotected byte[]
AmazonKMSSubmissionDataStorageService.getKeystoreData
(Submission submission) Deprecated.Return the keystore data for the submission.byte[]
AmazonKMSSubmissionDataStorageService.getSubmissionReceipt
(Submission submission) Deprecated.byte[]
AmazonS3SubmissionDataStorageService.getSubmissionReceipt
(Submission submission) Deprecated.byte[]
AwsSubmissionDataStorageService.getSubmissionReceipt
(Submission submission) byte[]
CloudSubmissionDataStorageService.getSubmissionReceipt
(Submission submission) byte[]
DatabaseSubmissionDataStorageService.getSubmissionReceipt
(Submission submission) byte[]
FileSystemSubmissionDataStorageService.getSubmissionReceipt
(Submission submission) byte[]
HybridCloudSubmissionDataStorageService.getSubmissionReceipt
(Submission submission) byte[]
AmazonKMSSubmissionDataStorageService.getSubmissionXml
(Submission submission) Deprecated.byte[]
AmazonS3SubmissionDataStorageService.getSubmissionXml
(Submission submission) Deprecated.byte[]
DatabaseSubmissionDataStorageService.getSubmissionXml
(Submission submission) byte[]
HybridCloudSubmissionDataStorageService.getSubmissionXml
(Submission submission) boolean
AmazonHSMSubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) Deprecated.Delegate the Initialization of the crypto data key for the submission to the data encryptor This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
AmazonKMSSubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) Deprecated.Returns false as we don't want to change behaviour of this class.boolean
AmazonS3SubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) Deprecated.returns false as there is no crypto key to initialize This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
AwsHsmDataEncryptor.initializeCryptoDataKey
(Submission submission) Initializes the crypto data key for the submission This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
AwsKmsDataEncryptor.initializeCryptoDataKey
(Submission submission) Initializes the crypto data key for the submission This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
AwsSubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) Delegate the Initialization of the crypto data key for the submission to the data encryptor This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
CloudSubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) Delegate the Initialization of the crypto data key for the submission to the data encryptorboolean
DatabaseSubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) returns false as there is no crypto key to initialize This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
HybridCloudSubmissionDataStorageService.initializeCryptoDataKey
(Submission submission) returns false as there is no crypto key to initialize This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
ISubmissionDataEncryptor.initializeCryptoDataKey
(Submission submission) Initializes the crypto data key for the submission This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
LocalKeystoreDataEncryptor.initializeCryptoDataKey
(Submission submission) returns false as there is no crypto key to initialize This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.boolean
SubmissionDataPurger.purge
(Submission submission) Purge the configured submission data items.void
AmazonKMSSubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) Deprecated.void
AmazonS3SubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) Deprecated.void
AwsSubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) void
CloudSubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) void
DatabaseSubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) void
FileSystemSubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) Store the submission attachment file data.void
HybridCloudSubmissionDataStorageService.storeAttachment
(Submission submission, FileUpload fileUpload, byte[] fileData) void
AmazonKMSSubmissionDataStorageService.storeSubmissionAndHistoryXml
(Submission submission, SubmissionHistory history, byte[] xmlData) Deprecated.void
AmazonS3SubmissionDataStorageService.storeSubmissionAndHistoryXml
(Submission submission, SubmissionHistory history, byte[] xmlData) Deprecated.void
DatabaseSubmissionDataStorageService.storeSubmissionAndHistoryXml
(Submission submission, SubmissionHistory history, byte[] xmlData) void
HybridCloudSubmissionDataStorageService.storeSubmissionAndHistoryXml
(Submission submission, SubmissionHistory history, byte[] xmlData) void
AmazonKMSSubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) Deprecated.void
AmazonS3SubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) Deprecated.void
AwsSubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) void
CloudSubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) void
DatabaseSubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) void
FileSystemSubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) void
HybridCloudSubmissionDataStorageService.storeSubmissionReceipt
(Submission submission, byte[] receiptData) void
AmazonKMSSubmissionDataStorageService.storeSubmissionXml
(Submission submission, byte[] xmlData) Deprecated.void
AmazonS3SubmissionDataStorageService.storeSubmissionXml
(Submission submission, byte[] xmlData) Deprecated.void
DatabaseSubmissionDataStorageService.storeSubmissionXml
(Submission submission, byte[] xmlData) void
HybridCloudSubmissionDataStorageService.storeSubmissionXml
(Submission submission, byte[] xmlData) -
Uses of Submission in com.avoka.fc.core.service.submission
Modifier and TypeMethodDescriptionAsyncMessageService.createRequestMsg
(Submission submission, String topic, String requestMsg, Date expiryTime) Create a request message with the status of 'Ready'.TrashCanDeliveryProcess.deliverSubmission
(Submission submission, DeliveryDetails deliveryDetails) Delivery process which does nothing and returns null.GroovyTaskExpiryService.expireTask
(Submission task) Expire the specified task submission.void
ISubmissionEmailVerificationService.logProcessingStatus
(Submission submission) Log a processing status after the email verification status for a submission has changed.void
SubmissionEmailVerificationService.logProcessingStatus
(Submission submission) Log a processing status after the email verification status for a submission has changed.boolean
SubmissionExtractDataService.mustEncryptDataExtractValue
(Submission submission, String name) Deprecated.void
GroovySubmissionCompletedProcessor.onSubmissionCompleted
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) This event handlers is invoked when the submission form status becomes 'Completed'.void
GroovyFormSavedProcessor.onSubmissionSaved
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) This event handler is invoked when the submission has been saved.void
IFormSavedProcessor.onSubmissionSaved
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXML) This event handler is invoked when the submission has saved.void
ISubmissionEmailVerificationService.sendInitialEmailVerification
(Submission submission) Send an initial user email verification email for the given submissionvoid
SubmissionEmailVerificationService.sendInitialEmailVerification
(Submission submission) Send an initial user email verification email for the given submissionvoid
SubmissionExtractDataService.store
(Submission submission, Map<String, String> dataMap) Store the given XML data extract map against the given submission.void
SubmissionExtractDataService.store
(Submission submission, Map<String, String> dataMap, ISubmissionDataStorageService storageService, boolean backwardCompatibility) Store the given XML data extract map against the given submission.static final void
SubmissionPropertyUtils.store
(Submission submission, SubmissionProperty property) Creates or Updates a SubmissionPropertySearch record when a submission property value is set Search hash is set for the SubmissionPropertySearch This is called in SubmissionProperty.setPropertyValue()GroovySubmissionDataValidator.validateSubmission
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String submissionXml) Validate the submission's XML data, returning empty list if no errors or a list of errors message if validation failures occur.ModifierConstructorDescriptionDeliveryCheckpointService
(Submission submission, String deliveryServiceName) Create a service based on the given submission and delivery service name. -
Uses of Submission in com.avoka.fc.core.service.test
Modifier and TypeMethodDescriptionMockEntityService.createSubmissionCompletedWithFormAndXml
(Form form, String formXmlData) Create a completed Submission entity with the given form and XML form data.MockEntityService.createSubmissionCompletedWithXml
(String formXmlData) Create a completed Submission entity with the given XML form data.MockEntityService.createSubmissionCompletedWithXml
(String formXmlData, Client client) Create a completed Submission entity with the given XML form data and client.MockEntityService.createSubmissionDeliveryReadyWithFormAndXml
(Form form, String formXmlData) Create a completed Submission entity with the given form and XML form data.MockEntityService.createSubmissionDeliveryReadyWithXml
(String formXmlData) Create a completed Submission entity with the given form and XML form data.MockEntityService.createSubmissionOpened()
Create a opened Submission entity.MockEntityService.createSubmissionOpened
(Client client) Create a opened Submission entity with the given client.MockEntityService.createSubmissionSavedWithXml
(String formXmlData) Create a saved Submission entity with the given XML form data.MockEntityService.createSubmissionSavedWithXml
(String formXmlData, Client client) Create a saved Submission entity with the given XML form data and client.MockEntityService.createSubmissionSubmittedWithFormAndXml
(Form form, String formXmlData) Create a submitted Submission entity with the given form and XML form data.MockEntityService.createSubmissionSubmittedWithXml
(String formXmlData) Create a submitted Submission entity with the given XML form data.MockEntityService.createSubmissionSubmittedWithXml
(String formXmlData, Client client) Create a submitted Submission entity with the given XML form data and client.MockEntityService.createSubmissionTaskWithXml
(String formXmlData) Create an assigned Submission form task entity with the given XML form data.MockEntityService.createSubmissionTaskWithXml
(String formXmlData, Client client) Create an assigned Submission form task entity with the given XML form data and client.MockEntityService.createSubmissionTaskWithXml
(String formXmlData, Form form) Create an assigned Submission form task entity with the given XML form data and form The submission record will have the status values:MockEntityService.createSubmissionWithClientStatusXml
(Client client, String formStatus, String formXmlData) Create a Submission entity with the given client, form status and XML form data.MockEntityService.createSubmissionWithStatusesAndXml
(Form form, String formStatus, String receiptStatus, String deliveryStatus, String formXmlData) Create a mock request for the given submission object.Modifier and TypeMethodDescriptionMockEntityUtils.addSearchableSubmissionProperty
(Submission submission, String name, String value) Stores a submission property (encrypted) and adds a submission property search entry.MockEntityUtils.addSubmissionToGroup
(Submission submission, Group group) Create a submission group association.MockEntityUtils.createElectronicAttachment
(Submission submission, String fileName, byte[] fileData, String fileUploadType) Create a basic delivery channel for the given client.MockEntityService.createEventLog
(Submission submission) Create a mock EventLog.MockEntityService.createGroovyServiceLog
(Client client, Submission submission, ServiceDefinition serviceDefinition, ErrorLog errorLog) Create a mock GroovyServiceLog for the given parameters.MockEntityService.createJobWithSubmission
(Client client, String jobDefJson, Submission submission) Create a mock collaboration job for the given jobDefinition and ClientMockEntityService.createPaymentLog
(Submission sub) Create a payment log entity.MockEntityService.createRequest
(Submission submission) Create a mock request for the given submission object.MockEntityService.createSubmissionProperty
(Submission submission, String name, String value) Create a non-encrypted submission property.void
BlankTestReceiptService.renderReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog) Render a blank PDF Receipt for testing purposes.byte[]
BlankTestReceiptService.renderReceipt
(Submission submission, String mode) Return a PDF Receipt byte array of a blank PDF receipt.void
MockEntityUtils.storeSubmissionDataExtracts
(Submission submission, Map<String, String> dataExtractMap) Stores a submission property (encrypted) and adds a submission property search entry. -
Uses of Submission in com.avoka.fc.core.servlet
Modifier and TypeMethodDescriptionstatic Submission
JsAppUtils.createOrUpdateSubmission
(jakarta.servlet.http.HttpServletRequest request, Form form, RequestLog requestLog, Portal portal, Submission submission, Date requestTime) Create new submission record, or update an existing existing submission record.Modifier and TypeMethodDescriptionstatic Submission
JsAppUtils.createOrUpdateSubmission
(jakarta.servlet.http.HttpServletRequest request, Form form, RequestLog requestLog, Portal portal, Submission submission, Date requestTime) Create new submission record, or update an existing existing submission record.static RequestLog
JsAppUtils.createRequestLog
(jakarta.servlet.http.HttpServletRequest request, Form form, TemplateVersion version, Submission submission, Date requestTime) Create a RequestLog record for the given request.void
SubmissionTargetResolver.handleOnlineSubmission
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Handle an online submission, redirecting the response to the next page.void
SubmissionTargetResolverImpl.handleOnlineSubmission
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Handle an online submission, redirecting the response to the next page.protected void
SubmissionServlet.renderReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) SubmissionTargetResolver.resolveAction
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Resolve a submission action given a http request, a submission and its associated submission data bean.SubmissionTargetResolverImpl.resolveAction
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Resolve a submission action given a http request, a submission and its associated submission data bean.SubmissionTargetResolver.resolvePath
(Submission submission) Resolve the next action path for the given submission.SubmissionTargetResolver.resolvePath
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Resolve a path given a http request, a submission and its associated submission data bean.SubmissionTargetResolverImpl.resolvePath
(Submission submission) Resolve a path given a http request and submission.SubmissionTargetResolverImpl.resolvePath
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Resolve a path given a http request, a submission and its associated submission data bean.void
SubmissionTargetResolver.resolvePathAndRedirect
(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Submission submission) Resolve the next action path for the given submission and redirect to that target.void
SubmissionTargetResolverImpl.resolvePathAndRedirect
(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Submission submission) Resolve the next action path for the given submission and redirect to that target.protected void
RenderServlet.storeSubmissionFormXml
(Submission submission, RenderServlet.RenderContext context, Document storeDoc) Store the submission form XML data.ModifierConstructorDescriptionDynamicDataSubmissionResponse
(Submission submission, jakarta.servlet.http.HttpServletRequest request, String emailSentTo, boolean backgroundSave) Create a Dynamic Data service submission response builder with the given submission.RenderContext
(jakarta.servlet.http.HttpServletRequest request, Submission submission, String renderMode) -
Uses of Submission in com.avoka.fc.core.sysevent
Modifier and TypeMethodDescriptionvoid
SysEventBuilder.ISysEventBuilder.addFormDataMap
(Map<String, String> fdm, Submission sub) Registers the form data map for inclusion in the system event messages.void
SysEventBuilder.ISysEventBuilder.addSubmission
(Submission sub) Registers the submission for inclusion in the system event messages. -
Uses of Submission in com.avoka.fc.core.test.func
-
Uses of Submission in com.avoka.fc.core.util
Modifier and TypeMethodDescriptionstatic void
SubmissionUtils.addInlineReceiptToken
(jakarta.servlet.http.HttpSession session, Submission submission) Add a token to allow a user to access a receipt inline (as part of the submission process, notably via the confirmation page).static void
SubmissionUtils.addOpenSavedFormToken
(jakarta.servlet.http.HttpSession session, Submission submission) Add a open saved form token.static void
SubmissionUtils.addReceiptAccessToken
(jakarta.servlet.http.HttpSession session, Submission submission) Add a receipt access token.static void
SubmissionUtils.addSessionChallengeJobKey
(jakarta.servlet.http.HttpSession session, Submission submission) Add a successful save challenge job key to the session.static void
SubmissionUtils.addSessionChallengeSubmitKey
(jakarta.servlet.http.HttpSession session, Submission submission) Add a successful save challenge submit key to the session and any submission contact email address if defined.static boolean
SubmissionUtils.containsSessionChallengeJobKey
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Checks if the session contains a successful save challenge job key for the specified submissionstatic boolean
SubmissionUtils.containsSessionChallengeSubmitKey
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Checks if the request session contains a successful save challenge submit key for the specified submissionstatic Submission
SubmissionBeanUtils.createSubmissionBeanWithAttachmentKeys
(Submission submission) Creates a submission bean representing aSubmission
entitySubmissionFormat.format
(Submission submission) Return the formatted string based on the pattern and the given submission.static String
SubmissionUtils.generateSubmissionXmlMetadata
(Submission submission) Generate submission metadata in XML format describing the submission and attachments.static Map<String,
DataDocument> SubmissionUtils.getDeliveryAttachmentsMap
(Submission submission, DeliveryDetails deliveryDetails, boolean deliveryAttachments) Return the submission delivery attachments map, keyed on attachment key.static String
PortalUtils.getFormReceiptURL
(Submission submission, Portal portal) Return the URL to access a rendered receipt.static String
PortalUtils.getFormRenderURL
(Submission submission, Portal portal) Return the URL to access a rendered saved form.static String
PortalUtils.getFormSavedUrl
(Portal portal, Submission submission) Provide a return to saved form URL.static String
PortalUtils.getFormSavedUrlWithReferenceNumber
(Portal portal, Submission submission) Provide a return to saved form URL with the submission reference number URL prefill parameter.static byte[]
ReceiptUtils.getPdfReceiptWithEmbeddedData
(Submission submission) Return a PDF receipt file for the given submission, with the associated transaction form XML and file attachments included in the PDF receipt document.static String
PortalUtils.getReceiptChallengeUrl
(Portal portal, Submission submission) Provide a receipt challenge URL.static String
SubmissionUtils.getReceiptFilename
(Submission submission) Return the PDF receipt filename.static String
PortalUtils.getSaveChallengeUrl
(Portal portal, Submission submission) Provide a return to form saved challenge URL.static String
FormUtils.getSavedFormnLastEditInfo
(Submission submission, jakarta.servlet.http.HttpServletRequest request) Return the saved form last edit info warning message if the form was opened by another user within the Security Managers configured session timeout period.static String
PortalUtils.getSavedFormRenderURL
(Submission submission, Portal portal, boolean useCurrentTemplateVersion) Return the URL to access a rendered saved form, including additional PDF zoom parameters.static String
PortalUtils.getSecureFormReceiptURL
(Submission submission, Portal portal) Return the URL to securely access a rendered receipt (the user will be asked to log in).static String
PortalUtils.getSecureFormRenderURL
(Submission submission, Portal portal) Return the URL to access a rendered saved form.static String
PortalUtils.getSecureFormRenderURL
(Submission submission, Portal portal, boolean useCurrentTemplateVersion) Return the URL to access a rendered saved form.static String
PortalUtils.getSessionExpiredPath
(Submission submission) Return the form session expired page path for the portal.static String
PortalUtils.getSubmissionCancelledPath
(Submission submission, Portal portal) Return the URL to the custom cancelled page URL specified on the submission's form or otherwise the"Submission Cancelled"
page on the given portal.static byte[]
SubmissionUtils.getSubmissionDataExcel
(Submission submission) Return the Submission Data Extracts an Excel file byte array, or null if no extracts available.static String
PortalUtils.getSubmissionEmailVerificationURL
(Portal portal, Submission submission) Return the full URL for the"Submission Email Verification"
page on the given portal and submission.static Portal
SubmissionUtils.getTaskPortal
(jakarta.servlet.http.HttpServletRequest request, Submission task) Return the portal for the associated request and task.static String
SubmissionUtils.getTransactionStatus
(Submission submission) Return a formatted transaction status text values, which summarizes the submission transaction status.static boolean
SubmissionUtils.hasInlineReceiptAccessToken
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Returns true if an inline receipt access token is present in the session for a given submission.static boolean
SubmissionUtils.hasOpenSavedFormToken
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Returns true if the open form token is present for a save challenge open form flow.static boolean
SubmissionUtils.hasReceiptAccessToken
(jakarta.servlet.http.HttpServletRequest request, Submission submission) Returns true if a receipt access token is present in the session for a given submission.static boolean
SubmissionUtils.hasSubmissionExpired
(Submission submission) Return true if the submission has expired.static boolean
SubmissionUtils.isSubmissionTaskAvailble
(Submission submission, UserAccount userAccount, String contactEmailAddress) Return true if the submission is available to the current user account or contact email address.static void
SubmissionUtils.logAttachmentEvent
(Submission submission, Attachment attachment, jakarta.servlet.http.HttpServletRequest request, String msg) Log the submission attachment event.static String
PortalUtils.mergeSubmissionRedirectUrlTemplate
(String template, Submission submission, jakarta.servlet.http.HttpServletRequest request) Merge a redirect URL Velocity template with a model consisting of the submission ($submission), the HTTP servlet request ($request) and the data extract values ($formDataMap).static void
AttachmentSummaryUtils.populateAttachmentSummary
(Submission submission, Document document, String xPath, Set<String> attachmentNamesToInclude) Populates information about a submission's attachments into an XML document.static void
SubmissionUtils.populateUserProfile
(Document document, Submission submission) Populates the user profile referenced in the submission with submission data, using the user profile mappings into the schema in reversestatic void
PortalUtils.redirectToNextPage
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Set a redirect to the next suitable page for a submissionstatic byte[]
ReceiptUtils.renderPdfReceipt
(Submission submission) Render the submissions customer PDF receipt and return the PDF byte data.static void
ReceiptUtils.renderPdfReceipt
(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Render a temporary PDF receipt for the given submission to the provided servlet response.static void
SubmissionUtils.resolveAndSetDeliveryDetails
(Submission submission) Resolve and set the submission delivery details for the given submission if not a job submission.static DeliveryDetails
SubmissionUtils.resolveDeliveryDetails
(Submission submission) Resolve the delivery details for the submission object.Modifier and TypeMethodDescriptionstatic byte[]
PDFUtils.mergeReceiptPDF
(List<Submission> submissions) This takes a List of submissions, it returns a byte[] containing the receipts appended together page by page -
Uses of Submission in com.avoka.tm.func
Modifier and TypeMethodDescriptionIFluentFunction.execute
(String triggerType, jakarta.servlet.http.HttpServletRequest request, Submission submission, Map<String, Object> params, Document formDoc, org.apache.commons.fileupload.FileItem fileAttachment, UserAccount userAccount) Execute the Fluent function and return a func result object. -
Uses of Submission in com.avoka.tm.vo
Modifier and TypeMethodDescriptionTxnVoBuilder.build
(Submission submission) Return a new Txn value object for the given submission record and fetch parameters.static Txn
MarshalUtils.marshalTxn
(Submission sub, boolean withFormDataMap, boolean withFormXml, boolean withGroupNames, boolean withPropertyMap, boolean withReceiptPdf, boolean withFileAttachList, boolean withDeliveryFuncs, boolean withComments) Marshal a submission entity into a new Txn value object.ModifierConstructorDescriptionTxn
(Submission sub, Map<String, String> formDataMap, String formXml, Set<String> groupNames, Map<String, String> propertyMap, byte[] receiptPdf, List<FileAttach> fileAttachList, List<TxnDeliveryFunc> deliveryFuncs, List<Comment> commentList) Create a Txn value object with the given parameters.