Uses of Class
com.avoka.fc.core.entity.Form

Packages that use Form

Package	Description
com.avoka.fc.core.control	Provides custom Apache Click control classes.
com.avoka.fc.core.dao	Provides the Data Access Objects used by SmartForm Manager.
com.avoka.fc.core.entity.auto	Provides the SmartForm Manager entity base classes, which are being maintained by Cayenne.
com.avoka.fc.core.page	Provides Form Page Tracking classes.
com.avoka.fc.core.security	Provides classes related to security and authentication.
com.avoka.fc.core.service	Provides the SmartForm Manager service classes.
com.avoka.fc.core.service.archive	Provides the SmartForm Manager portal import and export service.
com.avoka.fc.core.service.composer	Provides the Composer HTML Form Archive Utils.
com.avoka.fc.core.service.email	Provides the Email Client Services.
com.avoka.fc.core.service.fluent	Provides the Fluent Groovy API services.
com.avoka.fc.core.service.form	Provides classes for form services.
com.avoka.fc.core.service.impl	Provides the SmartForm Manager service class implementation.
com.avoka.fc.core.service.job.impl	Provides Collaboration Jobs service classes.
com.avoka.fc.core.service.test	Provides web automated test services.
com.avoka.fc.core.servlet	Provides execution thread request context utility class.
com.avoka.fc.core.util	Provides common utility classes and exception objects.
com.avoka.tm.vo	Provides Value Object persistent entity classes.

Uses of Form in com.avoka.fc.core.control

Constructors in com.avoka.fc.core.control with parameters of type Form

Constructor	Description
PDFPluginTag(String name, Form form)	Create a new PDFPluginTag object with the given parameters

Uses of Form in com.avoka.fc.core.dao

Methods in com.avoka.fc.core.dao that return Form

Modifier and Type	Method	Description
Form	FormDao.getActiveProductionFormByFormCode(String formCode)	Return the form with the specified form, prefetching the client.
Form	FormDao.getFormByFormCode(String formCode)	Return the form with the specified form code.
Form	FormDao.getFormByFormCode(String formCode, boolean refresh)	Return the form with the specified form code.
Form	FormDao.getFormByFormCodeIgnoreCase(String formCode)	Return the form with the specified form code performing an ignore-case query to support Oracle database.
Form	FormDao.getFormByName(Client client, String name)	Return a form with the specified name belonging to a specific client
Form	FormDao.getFormByNameIgnoreCase(String clientCode, String formName)	Return a form with a certain name and belonging to a specific client.
Form	FormDao.getFormByNormalizedName(Client client, String formNameNormalized)	Return a form with the given normalized name belonging to a specific client
Form	FormDao.getFormBySubmitKey(String submitKey)	Return the form associated with the specified submission, prefetching the client and current template version
Form	FormDao.getFormForFormDesign(Long formDesignId)	Return the form with the specified form design OID.
Form	FormDao.getFormFromPK(Object id)	Return the form with the specified OID

Methods in com.avoka.fc.core.dao that return types with arguments of type Form

Modifier and Type	Method	Description
List<Form>	FormDao.getActiveAndProductionFormList()	Return the list of forms that are active and not in test mode and whose client is also active, sorted by form name.
List<Form>	FormDao.getActiveFilteredFormsForClient(String clientId, Collection<String> formIdsToExclude)	Return the list of active forms for a client while excluding a set of forms
List<Form>	FormDao.getActiveFormListForClient(String clientId)	The list of active forms for a specific client This query uses a fetch limit of 10000.
List<Form>	FormDao.getActiveFormListForPortal(Portal portal, boolean includeTestForms)	Return the list of active form for a specific portal
List<Form>	FormDao.getActiveForms(boolean includeTestForms)	Return the list of forms that are active and whose client is also active, sorted by form name.
List<Form>	FormDao.getActiveFormsWithFarKey(String clientId, String farFormKey)	Return the set of active forms for a given client matching a specified FAR form key
List<Form>	FormDao.getFormByPortal(Portal portal, String name)	Gets the list of active forms by portal.
List<Form>	FormDao.getFormList(String clientId, boolean activeForms)	Return the form list for the given client and active form flag.
List<Form>	FormDao.getFormListForClient(String clientId)	Return the list of forms filtered by client when specified, sorted by form name.
List<Form>	FormDao.getFormListForIds(List<Long> formIds)	Return the list of forms for the given form IDs.
List<Form>	FormDao.getFormListForKeywordLike(String keyword, List<String> categoryNames, Portal portal)	Return a list of forms matching the specified search criteria
List<Form>	FormDao.getFormListIds(List<Long> formIds, UserAccount userAccount)	Return the list of forms for the given form IDs filtered for the users access.
List<Form>	FormDao.getFormsByDeliveryDetails(DeliveryDetails deliveryDetails, boolean isTestDelivery)	Gets the forms by delivery details.
List<Form>	FormDao.getFormsByName(String clientId, String name)	Return a list of forms whose name contains a certain substring and belonging to a specific client, ordered by form name
List<Form>	FormDao.getFormsSearch(String clientId, String value)	Return a list of forms whose name or code contain the search string, or whose OID matches the search string if it is numeric

Methods in com.avoka.fc.core.dao with parameters of type Form

Modifier and Type	Method	Description
VersionPropertyValue	VersionPropertyValueDao.createVersionPropertyValue(TemplateVersion templateVersion, Form form, PropertyType propertyType, String value)	Creates a new VersionPropertyValue for the given form, version and property.
VersionPropertyValue	VersionPropertyValueDao.createVersionPropertyValue(TemplateVersion templateVersion, Form form, PropertyType propertyType, String value, String longValue)	Deprecated. longValue no longer exists - use VersionPropertyValueDao.createVersionPropertyValue(TemplateVersion, Form, PropertyType, String) instead.
List<Submission>	SubmissionDao.getAdminCachedFormSubmissions(Form form, int fetchLimit)	Return the most recent non-test administrator cached form submissions for the given form.
ApplicationForm	ApplicationFormDao.getApplicationForm(ApplicationPackage applicationPackage, Form form)	Return the ApplicationForm entity for the given application package and form, or null if none exists
int	FormReceiptSequenceDao.getCurrentReceiptSequenceNumber(Form form)	Return the current sequence number for the specified form.
Integer	TransactionHistoryDao.getFormAvgTimeToSubmit(Form form)	Deprecated.
List<String>	FormDao.getFormGroupNames(Form form)	Return the list of form group names for the given form.
FormReceiptSequence	FormReceiptSequenceDao.getFormReceiptSequence(Form form)	Return the form receipt sequence for a specific form
int	TransactionHistoryDao.getFormRequestCount(Form form)	Deprecated.
int	TransactionHistoryDao.getFormSubmissionCount(Form form)	Deprecated.
List<Submission>	SubmissionDao.getFormSubmissions(Form form, int fetchLimit)	Return the most recent non-test form submissions for the given form.
List<TemplateVersionDeployment>	TemplateVersionDeploymentDao.getFutureDeployments(Form form)	Return the list of all template version deployments scheduled for a future time for the given template.
List<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.
String	FormDao.getNextVersionNumber(Form form)	Return the next template version number for the given form.
List<PromotionLog>	PromotionDao.getPromotionList(Client client, Form form, TemplateVersion version, boolean showHistory)	Return the list of promotion log records matching the specified search criteria, ordered by creation time.
List<PromotionLog>	PromotionDao.getPromotionList(Form form)	Return the list of current form promotion log records.
String	PropertyValueDao.getPropertyValue(String propertyName, Form form)	Return the named property value searching for: Form Property > Client Property > Portal Property > Deployment Property.
TemplateVersion	TemplateVersionDao.getTemplateVersionForForm(Form form, String versionNumber)	Return the template version for a specified form and version number
TemplateVersion	TemplateVersionDao.getTemplateVersionForFormNoCache(Form form, String versionNumber)	Return the template version for a specified form and version number
List<Submission>	SubmissionDao.getToDoSubmissionsForUserAndForm(UserAccount userAccount, Form form, boolean includeGroupSubmission)	Gets the submissions for user and form.
List<TemplateVersion>	TemplateVersionDao.getVersionsForPromotion(Form form)	Return the list of template versions that have no promotion log records
boolean	FormPortalDao.isInternalTxnFlag(Form form, Portal portal)	Return whether the form is set up to allow internal transactions on the given portal.
void	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.
void	SubmissionDao.recalcDeliveredSubmissionRetentionTimeForForm(Form form, int maxDeliveredSubmissionAgeDays)	Recalculate purge time for delivered submissions of a form.

Uses of Form in com.avoka.fc.core.entity.auto

Fields in com.avoka.fc.core.entity.auto with type parameters of type Form

Modifier and Type	Field	Description
static org.apache.cayenne.exp.Property<List<Form>>	_DeliveryDetails.ABANDON_FORMS	Provides the 'ABANDON_FORMS' property.
static org.apache.cayenne.exp.Property<Form>	_TemplateVersion.CURRENT_VERSION_FORM	Provides the 'CURRENT_VERSION_FORM' property.
static org.apache.cayenne.exp.Property<Form>	_ApplicationForm.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_ComposerImportAction.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_FormDesign.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_FormGroup.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_FormPortal.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_FormReceiptSequence.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_GroovyServiceLog.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_PromotionLog.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_RequestLog.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_Submission.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_TemplateVersion.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<Form>	_TemplateVersionDeployment.FORM	Provides the 'FORM' property.
static org.apache.cayenne.exp.Property<List<Form>>	_Client.FORMS	Provides the 'FORMS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_ServiceDefinition.FORMS	Provides the 'FORMS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_UserAccount.MANAGED_FORMS	Provides the 'MANAGED_FORMS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_DeliveryDetails.PROD_FORM_SUBMISSIONS	Provides the 'PROD_FORM_SUBMISSIONS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_DeliveryDetails.TEST_FORM_SUBMISSIONS	Provides the 'TEST_FORM_SUBMISSIONS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_ServiceDefinition.TRACKING_NUMBER_FORMS	Provides the 'TRACKING_NUMBER_FORMS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_DeliveryDetails.VALIDATION_FORMS	Provides the 'VALIDATION_FORMS' property.
static org.apache.cayenne.exp.Property<List<Form>>	_ServiceDefinition.VERSION_SELECTOR_FORMS	Provides the 'VERSION_SELECTOR_FORMS' property.

Methods in com.avoka.fc.core.entity.auto that return Form

Modifier and Type	Method	Description
Form	_TemplateVersion.getCurrentVersionForm()	Return the CurrentVersionForm.
Form	_ApplicationForm.getForm()	Return the Form.
Form	_ComposerImportAction.getForm()	Return the Form.
Form	_FormDesign.getForm()	Return the Form.
Form	_FormGroup.getForm()	Return the Form.
Form	_FormPortal.getForm()	Return the Form.
Form	_FormReceiptSequence.getForm()	Return the Form.
Form	_GroovyServiceLog.getForm()	Return the Form.
Form	_PromotionLog.getForm()	Return the Form.
Form	_RequestLog.getForm()	Return the Form.
Form	_Submission.getForm()	Return the Form.
Form	_TemplateVersion.getForm()	Return the Form.
Form	_TemplateVersionDeployment.getForm()	Return the Form.

Methods in com.avoka.fc.core.entity.auto that return types with arguments of type Form

Modifier and Type	Method	Description
List<Form>	_DeliveryDetails.getAbandonForms()	Return the AbandonForms.
List<Form>	_Client.getForms()	Return the Forms.
List<Form>	_ServiceDefinition.getForms()	Return the Forms.
List<Form>	_UserAccount.getManagedForms()	Return the ManagedForms.
List<Form>	_DeliveryDetails.getProdFormSubmissions()	Return the ProdFormSubmissions.
List<Form>	_DeliveryDetails.getTestFormSubmissions()	Return the TestFormSubmissions.
List<Form>	_ServiceDefinition.getTrackingNumberForms()	Return the TrackingNumberForms.
List<Form>	_DeliveryDetails.getValidationForms()	Return the ValidationForms.
List<Form>	_ServiceDefinition.getVersionSelectorForms()	Return the VersionSelectorForms.

Methods in com.avoka.fc.core.entity.auto with parameters of type Form

Modifier and Type	Method	Description
void	_DeliveryDetails.addToAbandonForms(Form obj)	Add the AbandonForms object.
void	_Client.addToForms(Form obj)	Add the Forms object.
void	_ServiceDefinition.addToForms(Form obj)	Add the Forms object.
void	_UserAccount.addToManagedForms(Form obj)	Add the ManagedForms object.
void	_DeliveryDetails.addToProdFormSubmissions(Form obj)	Add the ProdFormSubmissions object.
void	_DeliveryDetails.addToTestFormSubmissions(Form obj)	Add the TestFormSubmissions object.
void	_ServiceDefinition.addToTrackingNumberForms(Form obj)	Add the TrackingNumberForms object.
void	_DeliveryDetails.addToValidationForms(Form obj)	Add the ValidationForms object.
void	_ServiceDefinition.addToVersionSelectorForms(Form obj)	Add the VersionSelectorForms object.
void	_DeliveryDetails.removeFromAbandonForms(Form obj)	Remove the AbandonForms object.
void	_Client.removeFromForms(Form obj)	Remove the Forms object.
void	_ServiceDefinition.removeFromForms(Form obj)	Remove the Forms object.
void	_UserAccount.removeFromManagedForms(Form obj)	Remove the ManagedForms object.
void	_DeliveryDetails.removeFromProdFormSubmissions(Form obj)	Remove the ProdFormSubmissions object.
void	_DeliveryDetails.removeFromTestFormSubmissions(Form obj)	Remove the TestFormSubmissions object.
void	_ServiceDefinition.removeFromTrackingNumberForms(Form obj)	Remove the TrackingNumberForms object.
void	_DeliveryDetails.removeFromValidationForms(Form obj)	Remove the ValidationForms object.
void	_ServiceDefinition.removeFromVersionSelectorForms(Form obj)	Remove the VersionSelectorForms object.
void	_TemplateVersion.setCurrentVersionForm(Form currentVersionForm)	Set the CurrentVersionForm.
void	_ApplicationForm.setForm(Form form)	Set the Form.
void	_ComposerImportAction.setForm(Form form)	Set the Form.
void	_FormDesign.setForm(Form form)	Set the Form.
void	_FormGroup.setForm(Form form)	Set the Form.
void	_FormPortal.setForm(Form form)	Set the Form.
void	_FormReceiptSequence.setForm(Form form)	Set the Form.
void	_GroovyServiceLog.setForm(Form form)	Set the Form.
void	_PromotionLog.setForm(Form form)	Set the Form.
void	_RequestLog.setForm(Form form)	Set the Form.
void	_Submission.setForm(Form form)	Set the Form.
void	_TemplateVersion.setForm(Form form)	Set the Form.
void	_TemplateVersionDeployment.setForm(Form form)	Set the Form.

Uses of Form in com.avoka.fc.core.page

Methods in com.avoka.fc.core.page with parameters of type Form

Modifier and Type	Method	Description
static String	FormPageTrackingUtils.renderContent(Form form, HttpServletRequest request)	Return the rendered 3rd party form page tracking content, using the forms pageTrackingContent.
static String	FormPageTrackingUtils.renderContent(Form form, HttpServletRequest request, Submission submission)	Return the rendered 3rd party form page tracking content, using the forms pageTrackingContent.

Uses of Form in com.avoka.fc.core.security

Methods in com.avoka.fc.core.security with parameters of type Form

Modifier and Type	Method	Description
IFormSubmissionAccessController.AccessStatus	FormSubmissionAccessController.getFormAccessStatus(Form form, HttpServletRequest request)	Gets user's the form access status.
IFormSubmissionAccessController.AccessStatus	IFormSubmissionAccessController.getFormAccessStatus(Form form, HttpServletRequest request)	Gets user's the form access status.
String	FormSubmissionAccessController.getFormCspHeaderValue(Form form)	Return the 'Content Security Policy' (CSP) HTTP Security Header value for the given form.
String	IFormSubmissionAccessController.getFormCspHeaderValue(Form form)	Return the 'Content Security Policy' (CSP) HTTP Security Header value for the given form.
boolean	FormSubmissionAccessController.hasFormAccessPermissions(Form form, HttpServletRequest request, Set<IFormSubmissionAccessController.AccessPermission> accessPermissions)	Checks if is user has the specified access permissions to the form.
boolean	IFormSubmissionAccessController.hasFormAccessPermissions(Form form, HttpServletRequest request, Set<IFormSubmissionAccessController.AccessPermission> accessPermissions)	Checks if is user has the specified access permissions to the form.

Uses of Form in com.avoka.fc.core.service

Fields in com.avoka.fc.core.service declared as Form

Modifier and Type	Field	Description
Form	SubmissionTaskService.FormTaskParam.form	The form the form to fill (required).
Form	SubmissionTaskService.SavedFormParam.form	The submission form, must be active and configured for Anonymous Online Save.

Methods in com.avoka.fc.core.service that return Form

Modifier and Type	Method	Description
Form	CloneService.cloneSingleForm(String oldFormId, String toClientId)	Deprecated. Given a formId, create a copy and attach to given client.

Methods in com.avoka.fc.core.service with parameters of type Form

Modifier and Type	Method	Description
Document	FormDataService.applyFormPrefillService(ServiceDefinition formPrefillSD, Document document, HttpServletRequest request, Form form, TemplateVersion templateVersion, Submission submission)	Apply the form prefill service to the submission document.
Submission	SubmissionService.createAndInitialiseSubmission(Form form)	Create and initialise a new submission object.
Submission	SubmissionService.createAndInitialiseSubmission(Form form, String receiptNumber, String trackingCode)	Create and initialise a new submission object.
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.
Submission	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.
Submission	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.
RequestLog	RequestLogService.createRequestLog(HttpServletRequest request, Form form, TemplateVersion templateVersion, Submission submission, UserAccount userAccount, String renderMode)	Create a request log and register it with the data context
RequestLog	RequestLogService.createRequestLog(HttpServletRequest request, Form form, TemplateVersion templateVersion, Submission submission, UserAccount userAccount, String renderMode, boolean commitChanges)	Create a request log and register it with the data context
Submission	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.
Submission	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.
Double	IComposerHtmlFormRenderService.getComposerFormVersion(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return the Composer Form version as major.minor version, e.g.
Object	FormPrefillService.getFormPrefillData(Form form, Document schemaSeed, HttpServletRequest request)	Return the form pre-population data for the given form, the schema seed and request.
static IFormVersionSelectorService	ServiceLocator.getFormVersionSelectorServiceForForm(Form form)	Returns the form version selector service configured for the form
static IReceiptNumberService	ServiceLocator.getReceiptNumberServiceForForm(Form form)	Returns the receipt number service configured for the form
String	IComposerHtmlFormRenderService.getRenderFormTemplateType(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return the form template type [ 'desktop' | 'tablet' | 'phone' ] which will be rendered to the given request.
static ITrackingNumberService	ServiceLocator.getTrackingNumberServiceForForm(Form form)	Returns the tracking number service configured for the form
Submission	SubmissionService.initializeOpenedSubmission(Form form, 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, HttpServletRequest request)	Initiate submission email verification if configured
GroovyServiceLog	GroovyLogService.logServiceCall(ServiceDefinition serviceDefinition, Date startTime, com.jezhumble.javasysmon.CpuTimes startCpuTimes, Long startFreeMemory, HttpServletRequest request, Submission submission, Form form, Client client, ErrorLog errorLog, boolean debugEnabled, String funcTrigger)	Log Groovy Service invocation using the specified parameters.
protected void	FormDataService.populateDynamicData(Document seedDocument, Form form, HttpServletRequest request, UserAccount userAccount, RequestLog requestLog, String referer, Submission submission, TemplateVersion templateVersion, SchemaSeedVO schemaSeed)	Populate any Dynamic data into the seed document.
String	FormDataService.populateSeedXml(Form form, 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.
Document	FormDataService.populateSeedXmlDoc(Form form, 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.
String	FormDataService.populateSeedXmlFromSeed(Form form, 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.
Document	FormDataService.populateSeedXmlFromSeedDoc(Form form, 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.
protected void	FormDataService.populateSystemProfile(Document seedDocument, Form form, HttpServletRequest request, UserAccount userAccount, RequestLog requestLog, String referer, Submission submission, TemplateVersion templateVersion)	Populate the system profile information in the XML seed document.
void	FormDataService.populateVersionAttachments(Document seedDocument, Form form, TemplateVersion templateVersion, SchemaSeed schemaSeed)	Populate the form seed document with the form version attachments.
void	FormDataService.populateVersionPropertyValues(Document seedDocument, Form form, TemplateVersion templateVersion, SchemaSeed schemaSeed)	Populate the form seed document with the form version property value.
void	IComposerHtmlFormRenderService.renderForm(TemplateVersion templateVersion, Form form, String xmlData, HttpServletRequest request, HttpServletResponse response, String targetUrl, RequestLog requestLog)	Render the Form using the given form, template version and XML data to the response.
void	IRenderFormService.renderForm(TemplateVersion templateVersion, Form form, String xmlData, HttpServletRequest request, HttpServletResponse response, String targetUrl, RequestLog requestLog)	Render the Form using the given form, template version and XML data to the response.
String	IFormMetaDataService.renderHtmlMetaData(Form form)	Return the list of meta data elements for the form.

Uses of Form in com.avoka.fc.core.service.archive

Methods in com.avoka.fc.core.service.archive with parameters of type Form

Modifier and Type	Method	Description
protected void	BaseArchiveService.addDeploymentSchedule(Form form, Element parentElement)
protected void	BaseArchiveService.addForm(ZipOutputStream zos, Form form, TemplateVersion version, Element parentElement)
protected void	BaseArchiveService.addFormGroups(Form form, Element parentElement)
protected void	BaseArchiveService.addFormPortals(Form form, Element parentElement)
protected void	BaseArchiveService.addPropertyPrefillMaps(Form form, SchemaSeed schemaSeed, ZipOutputStream zos, Element parentElement)
protected void	BaseArchiveService.addSchemaSeed(Form form, TemplateVersion version, ZipOutputStream zos, Element parentElement)
protected void	BaseArchiveService.addTemplateVersion(Form form, TemplateVersion version, ZipOutputStream zos, Element parentElement)
protected void	BaseArchiveService.addVersionAttachments(Form form, TemplateVersion version, ZipOutputStream zos, Element parentElement)
protected void	BaseArchiveService.addVersionMetadataValues(Form form, TemplateVersion version, ZipOutputStream zos, Element parentElement)
protected void	BaseArchiveService.addVersionPropertyValues(Form form, TemplateVersion version, ZipOutputStream zos, Element parentElement)
protected BaseArchiveService.FormData	ApplicationPackageArchiveService.getFormData(Element formElement, Form form, TemplateVersion version)
protected BaseArchiveService.FormData	BaseArchiveService.getFormData(Element formElement, Form form, TemplateVersion version)
protected BaseArchiveService.FormData	FormVersionArchiveService.getFormData(Element formElement, Form form, TemplateVersion version)
protected String	BaseArchiveService.getFormVersionKey(Form form, TemplateVersion version)	Deprecated. use {@link this#getFormVersionKey(String, TemplateVersion) instead and explicitly pass the appropriate form code (generally either the archive form code during import or form.getClientFormCode() during export).
protected void	BaseArchiveService.importApplicationPackages(Form form, Element parentElement, List<String> warnings)
protected void	BaseArchiveService.importDeploymentPlan(Form form, Element parentElement, List<String> warnings)
protected void	BaseArchiveService.importFormGroups(Form form, Element formElement, List<String> warnings)
protected void	BaseArchiveService.importFormPortals(Form form, Element formElement, List<String> warnings)
protected void	BaseArchiveService.importSchemaSeed(Form form, TemplateVersion version, Element formElement, Element parentElement, List<String> warnings)
protected int	BaseArchiveService.importTemplateVersions(Form form, boolean importAttachments, boolean importMetadata, boolean importProperties, boolean importServices, boolean importFormDataConfiguration, boolean importCurrentVersionFlag, boolean importCategories, boolean importFormFunctions, Element formElement, List<String> warnings)
protected int	BaseArchiveService.importTemplateVersions(Form form, Element formElement, List<String> warnings)
protected void	BaseArchiveService.importVersionAttachments(Form form, TemplateVersion version, Element parentElement, List<String> warnings)
protected void	BaseArchiveService.importVersionCategories(Form form, TemplateVersion version, Element parentElement, List<String> warnings)
protected void	BaseArchiveService.importVersionMetadata(Form form, TemplateVersion version, Element parentElement, List<String> warnings)
protected void	BaseArchiveService.importVersionProperties(Form form, TemplateVersion version, Element parentElement, List<String> warnings)

Uses of Form in com.avoka.fc.core.service.composer

Methods in com.avoka.fc.core.service.composer with parameters of type Form

Modifier and Type	Method	Description
Double	ComposerHtmlFormRenderService.getComposerFormVersion(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return the Composer Form version as major.minor version, e.g.
Double	JsAppComposerRenderAdapter.getComposerFormVersion(HttpServletRequest request, Form form, TemplateVersion templateVersion)	This interface adaptor method does nothing.
static FormArchive	FormArchiveCache.getFormArchive(TemplateVersion templateVersion, Form form, Map properties, String resourcesContext)	Return the cached form archive for the specified form and template version.
String	ComposerHtmlFormRenderService.getRenderFormTemplateType(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return the form template type [ 'desktop' | 'tablet' | 'phone' ] which will be rendered to the given request.
String	JsAppComposerRenderAdapter.getRenderFormTemplateType(HttpServletRequest request, Form form, TemplateVersion templateVersion)	This interface adaptor method does nothing.
static String	FormArchiveCache.getResourceContext(Portal portal, Form form, TemplateVersion templateVersion)	Return the resource context.
void	ComposerHtmlFormRenderService.renderForm(TemplateVersion templateVersion, Form form, String xmlData, HttpServletRequest request, HttpServletResponse response, String targetUrl, RequestLog requestLog)	Render the Form using the given form, template version and XML data to the response.
void	JsAppComposerRenderAdapter.renderForm(TemplateVersion templateVersion, Form form, String xmlData, HttpServletRequest request, HttpServletResponse response, String targetUrl, RequestLog requestLog)	This method provides a IComposerHtmlFormRenderService interface adaptor.

Uses of Form in com.avoka.fc.core.service.email

Methods in com.avoka.fc.core.service.email with parameters of type Form

Modifier and Type	Method	Description
protected 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.

Uses of Form in com.avoka.fc.core.service.fluent

Methods in com.avoka.fc.core.service.fluent with parameters of type Form

Modifier and Type	Method	Description
protected 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.
String	FluentTrackingNumberService.createTrackingNumber(Form form)	Generate a new transaction tracking number for the given form
String	FluentDynamicDataService.getFormData(HttpServletRequest request, Form form, Submission submission)	Return the dynamic form data for the request and form.
Object	FluentFormPrefillService.getFormPrefillData(Form form, Document schemaSeed, HttpServletRequest request)	Return the form pre-population data for the given form, the schema seed and request.
TemplateVersion	FluentFormVersionSelectorService.getFormVersionToRender(Form form, HttpServletRequest request)	Select the form version that shall be used to fulfill a form render request.

Uses of Form in com.avoka.fc.core.service.form

Fields in com.avoka.fc.core.service.form declared as Form

Modifier and Type	Field	Description
Form	TemplateVersionBean.form	The form associated with this template version.

Methods in com.avoka.fc.core.service.form that return Form

Modifier and Type	Method	Description
Form	FormService.createNewForm(FormBean formBean)	Create a new form instance given a form bean.
Form	JsAppDeployService.deploy(byte[] appBundle, JsAppDeployService.FormDef formDef, Document formXml, UserAccount userAccount)	Deploy the JS App using the specified app bundle ZIP, form definition JSON and form XML data document.
Form	JsAppDeployService.deploy(byte[] appBundle, JsAppDeployService.FormDef formDef, Document formXml, UserAccount userAccount, String tmMinVersion)	Deploy the JS App using the specified app bundle ZIP, form definition JSON and form XML data document.

Methods in com.avoka.fc.core.service.form with parameters of type Form

Modifier and Type	Method	Description
void	FormService.changeTemplateVersion(Form form, String versionNumber)	Changes the current version of a form immediately.
String	GroovyTrackingNumberService.createTrackingNumber(Form form)	Generate a new transaction tracking number for the given form
String	ITrackingNumberService.createTrackingNumber(Form form)	Generate a new transaction tracking number for the given form.
String	RandomTrackingNumberService.createTrackingNumber(Form form)	Generate a new transaction tracking number for the given form
Portal	FormService.getDefaultRenderPortal(Form form)	Return the portal that is the "default" for rendering thie form.
String	GroovyDynamicDataService.getFormData(HttpServletRequest request, Form form, Submission submission)	Return the dynamic form data for the request and form.
String	IDynamicDataService.getFormData(HttpServletRequest request, Form form, Submission submission)	Return the lookup form data for the request and form.
String	GroovyFormPrefillService.getFormPrefillData(Form form, Document schemaSeed, HttpServletRequest request)	Return the form pre-population data for the given form, the schema seed and request.
TemplateVersion	CurrentVersionSelectorService.getFormVersionToRender(Form form, HttpServletRequest request)	Select the form version that shall be used to fulfill a form render request.
TemplateVersion	FormService.getFormVersionToRender(Form form, HttpServletRequest request)	Returns the form version that shall be used to fulfil a form render request.
TemplateVersion	GroovyFormVersionSelectorService.getFormVersionToRender(Form form, HttpServletRequest request)	Select the form version that shall be used to fulfil a form render request.
TemplateVersion	IFormVersionSelectorService.getFormVersionToRender(Form form, HttpServletRequest request)	Select the form version that shall be used to fulfil a form render request.
TemplateVersion	RandomFormVersionSelectorService.getFormVersionToRender(Form form, HttpServletRequest request)	Select the form version that shall be used to fulfill a form render request.
String	FormService.getSelectedFormVersionAttributeName(Form form)	Get the full name of the session attribute holding the selected form version for a particular form.
TemplateVersion	FormService.getVersionWithHighestNumber(Form form)	Find the form version with the highest version number for the given form.
String	SimplePingService.handlePing(HttpServletRequest request, Form form)	Return a response to the ping request.
void	FormService.initialiseTemplateVersion(TemplateVersion templateVersion, Form form)	Initialises the version properties and metadata values for a new template version, based on existing client properties and metadata values Note that this method assumes that the template version does not yet have any version property values or metadata values for the given form.

Uses of Form in com.avoka.fc.core.service.impl

Methods in com.avoka.fc.core.service.impl with parameters of type Form

Modifier and Type	Method	Description
String	AGLSFormMetaDataService.renderHtmlMetaData(Form form)	Return the list of meta data elements for the form.

Uses of Form in com.avoka.fc.core.service.job.impl

Methods in com.avoka.fc.core.service.job.impl that return Form

Modifier and Type	Method	Description
Form	JobFunctions.startForm()

Uses of Form in com.avoka.fc.core.service.test

Methods in com.avoka.fc.core.service.test that return Form

Modifier and Type	Method	Description
Form	MockEntityService.createForm(String formCode, Client client, Portal portal)	Create a new form with the given formCode, client and portal.
Form	MockEntityService.createForm(String formCode, Client client, Collection<Portal> portals)	Create a new form with the given formCode, client and portal.

Methods in com.avoka.fc.core.service.test with parameters of type Form

Modifier and Type	Method	Description
void	MockEntityService.addFormToGroup(Form form, Group group)	Add a form to a group.
Job	MockEntityService.createJobWithFormXml(Client client, String jobDefJson, Form form, String formXmlData)	Create a mock collaboration job for the given jobDefinition and Client
Submission	MockEntityService.createSubmissionCompletedWithFormAndXml(Form form, String formXmlData)	Create a completed Submission entity with the given form and XML form data.
Submission	MockEntityService.createSubmissionDeliveryReadyWithFormAndXml(Form form, String formXmlData)	Create a completed Submission entity with the given form and XML form data.
Submission	MockEntityService.createSubmissionSubmittedWithFormAndXml(Form form, String formXmlData)	Create a submitted Submission entity with the given form and XML form data.
Submission	MockEntityService.createSubmissionWithStatusesAndXml(Form form, String formStatus, String receiptStatus, String deliveryStatus, String formXmlData)	Create a mock request for the given submission object.
FormPortal	MockEntityService.grantFormPortalAccess(Form form, Portal portal, boolean allowAnonymousAccess, boolean allowAuthenticatedAccess)	Creates or updates the form portal association and sets the anonymous/authenticated access flags as specified.
MockEntityService	MockEntityService.setForm(Form form)	Set the form to be used when creating submission entities.

Uses of Form in com.avoka.fc.core.servlet

Fields in com.avoka.fc.core.servlet declared as Form

Modifier and Type	Field	Description
Form	RenderServlet.RenderContext.form

Methods in com.avoka.fc.core.servlet with parameters of type Form

Modifier and Type	Method	Description
static Submission	JsAppUtils.createOrUpdateSubmission(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(HttpServletRequest request, Form form, TemplateVersion version, Submission submission, Date requestTime)	Create a RequestLog record for the given request.

Constructors in com.avoka.fc.core.servlet with parameters of type Form

Constructor	Description
RenderContext(HttpServletRequest request, Form form)

Uses of Form in com.avoka.fc.core.util

Methods in com.avoka.fc.core.util with parameters of type Form

Modifier and Type	Method	Description
static Map<String,String>	PortalUtils.addFormAndVersionProperties(org.apache.click.Page page, Form form)	Add the form and template version property values to the given page model, and return the map.
static boolean	FormUtils.doesFormSupportEmbedWithDiv(Form form)	Return true if the form's current template version supports HTML 'Embed with Div'.
static boolean	FormUtils.ensureRequestedFormValid(org.apache.click.Page page, Form form)	Validate a form that is being requested by a user.
static String	PortalUtils.getFormLandingPagePath(Form form, Portal portal)	Return the landing page URL for the given form.
static String	PortalUtils.getFormPageURL(Form form, Portal portal)	Return the URL to the form 'plugin' page for the portal.
static String	PortalUtils.getFormPath(Form form, Portal portal)	Return the form 'plug-in' page path for the form.
static String	PortalUtils.getFormRenderURL(Form form, Portal portal)	Return the URL to access a rendered form.
static String	PortalUtils.getFormRenderURL(Form form, Portal portal, boolean includeSessionId)	Return the URL to access a rendered form.
static String	PortalUtils.getFormRenderURL(Form form, TemplateVersion templateVersion, boolean includePDFParams)	Return the form render URL including PDF open parameters if a PDF form
static Map<String,String>	PortalUtils.getFormVersionProperties(Form form, HttpServletRequest request)	Return the form template version property value map.
static String	PortalUtils.getFriendlyFormURL(Form form, Portal portal)	Return the Friendly URL for a given form
static String	PortalUtils.getPropertyDeploy(Form form, String propertyName)	Return the property deploy value for a specific form and property name
static Map<String,Integer>	DataRetentionUtils.getRetentionPolicyRange(String retentionParameterName, Client client, Form form)	Return the possible range in days for a data retention parameter, as well as (on client and form levels) information on the inherited value.
static String	PortalUtils.getSecureFormRenderURL(Form form, Portal portal)	Return the URL to access a rendered form.
static String	PortalUtils.getSubmissionExpiredPath(Portal portal, Form form)	Return the URL to the "Submission Expired" page on the given portal and portal.
static SubmissionRetentionSettings	DataRetentionUtils.getSubmissionRetentionDefaults(Form form)	Calculate the global/organization default values that apply to data retention policies for the given form.
static SubmissionRetentionSettings	DataRetentionUtils.getSubmissionRetentionThresholds(Form form)	Calculate the upper limits that apply to data retention policies for the given form.
static boolean	FormUtils.isUseComposerHtmlDirectRender(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return true if the Composer HTML Form should be rendered directly.
static boolean	FormUtils.requireFormTerms(Submission submission, Form form, HttpServletRequest request)	Check whether the form require form terms.

Constructors in com.avoka.fc.core.util with parameters of type Form

Constructor	Description
DuplicateSubmissionException(RequestLog requestLog, Form form)	Create a DuplicateSubmissionException object with the given parameters

Uses of Form in com.avoka.tm.vo

Constructors in com.avoka.tm.vo with parameters of type Form

Constructor	Description
Form(Form form)	Create a Form value object with the given form entity parameter.