Package com.avoka.fc.core.service
Class SubmissionTaskService.SavedFormParam
- java.lang.Object
-
- com.avoka.fc.core.service.SubmissionTaskService.SavedFormParam
-
- Enclosing class:
- SubmissionTaskService
public static class SubmissionTaskService.SavedFormParam extends Object
Provides an anonymous saved form parameter object.
-
-
Field Summary
Fields Modifier and Type Field Description String
address
The task location address.String
contactEmailAddress
The submission contact email address (required if sendEmailFlag is true).List<String>
copyAttachmentsNames
The name of the attachments to copy from the previous submission.Submission
copyAttachmentsSubmission
Copy the attachments of the previous submission if defined.Date
datetimeExpiry
The date/time when the task shall expire (optional; needs to be in the future).Date
datetimeScheduled
The scheduling information that can be displayed to the assignee(s) (optional).String
emailMessage
The email body, if not specified the property value 'Email Saved Form Message' is used instead.String
emailSubject
The email subject, if not specified the property value 'Email Saved Form Subject' is used instead.Form
form
The submission form, must be active and configured for Anonymous Online Save.Map<String,List<DataDocument>>
formAttachments
The submission attachments map, keyed on version attachment name, or the arbitrary attachment description.String
formPrefillServiceName
The name of the Form Prefill service to use to pre-fill the form XML data with.String
inputXmlData
The input pre-fill data XML for the form.JobAction
jobAction
The associated Job action, to associate with this submission.Double
latitude
The latitude component of the geolocation information (optional; can range from -90 to 90).Double
longitude
The longitude component of the geolocation information (optional; can range from -180 to 180).Portal
portal
The associated Portal.String
receiptNumber
The submission receipt number, if not blank the the receipt number must not already exist.String
saveChallengeAnswer
The submission save challenge answer.boolean
sendEmailFlag
The the flag to specify whether to send out an email.Integer
sequence
The sequence number that can be set to number tasks that are part of a set (optional).String
submissionXml
The Submission XML dataString
taskMessage
The task message.String
taskSubject
The task subject (required).TemplateVersion
templateVersion
The submission form version (optional)String
transRefNumber
The Trans.
-
Constructor Summary
Constructors Constructor Description SavedFormParam()
Provides a no args constructor.SavedFormParam(SubmissionTaskService.SavedFormParam param)
Provides a copy constructor.
-
-
-
Field Detail
-
portal
public Portal portal
The associated Portal.
-
form
public Form form
The submission form, must be active and configured for Anonymous Online Save.
-
templateVersion
public TemplateVersion templateVersion
The submission form version (optional)
-
taskSubject
public String taskSubject
The task subject (required).
-
taskMessage
public String taskMessage
The task message.
-
sequence
public Integer sequence
The sequence number that can be set to number tasks that are part of a set (optional).
-
receiptNumber
public String receiptNumber
The submission receipt number, if not blank the the receipt number must not already exist.
-
saveChallengeAnswer
public String saveChallengeAnswer
The submission save challenge answer.
-
contactEmailAddress
public String contactEmailAddress
The submission contact email address (required if sendEmailFlag is true).
-
transRefNumber
public String transRefNumber
The Trans. Ref. Number, for correlating multiple submissions against.
-
submissionXml
public String submissionXml
The Submission XML data
-
inputXmlData
public String inputXmlData
The input pre-fill data XML for the form.
-
formAttachments
public Map<String,List<DataDocument>> formAttachments
The submission attachments map, keyed on version attachment name, or the arbitrary attachment description.
-
sendEmailFlag
public boolean sendEmailFlag
The the flag to specify whether to send out an email.
-
emailSubject
public String emailSubject
The email subject, if not specified the property value 'Email Saved Form Subject' is used instead.
-
emailMessage
public String emailMessage
The email body, if not specified the property value 'Email Saved Form Message' is used instead.
-
copyAttachmentsNames
public List<String> copyAttachmentsNames
The name of the attachments to copy from the previous submission.
-
copyAttachmentsSubmission
public Submission copyAttachmentsSubmission
Copy the attachments of the previous submission if defined.
-
formPrefillServiceName
public String formPrefillServiceName
The name of the Form Prefill service to use to pre-fill the form XML data with.
-
address
public String address
The task location address.
-
latitude
public Double latitude
The latitude component of the geolocation information (optional; can range from -90 to 90).
-
longitude
public Double longitude
The longitude component of the geolocation information (optional; can range from -180 to 180).
-
datetimeScheduled
public Date datetimeScheduled
The scheduling information that can be displayed to the assignee(s) (optional).
-
datetimeExpiry
public Date datetimeExpiry
The date/time when the task shall expire (optional; needs to be in the future).
-
jobAction
public JobAction jobAction
The associated Job action, to associate with this submission.
-
-
Constructor Detail
-
SavedFormParam
public SavedFormParam()
Provides a no args constructor.- Since:
- 4.1.2
-
SavedFormParam
public SavedFormParam(SubmissionTaskService.SavedFormParam param)
Provides a copy constructor.- Parameters:
param
- the saved form param to copy- Since:
- 4.1.2
-
-