Package com.avoka.fc.common
Interface Params
public interface Params
Defines parameters shared between the FC projects.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringA flag for disabling autosave.static final StringThe unique client code identifier.static final StringThe client id.static final StringThe client name.static final Stringstatic final StringThe form template device type.static final Stringstatic final Stringstatic final StringThe Entity ID parameter.static final StringThe external account ID.static final StringThe Web Plug-in external account ID.static final StringThe form version numberstatic final StringThe unique form code identifier.static final StringThe unique form OID.static final StringThe form status.static final StringThe global form flagstatic final StringThe header used by the FCIC to communicate the environment namestatic final Stringstatic final Stringstatic final StringThe The Web Plug-in form JSON prefill data.static final StringThe message key that is passed across for certain errorsstatic final Stringstatic final Stringstatic final Stringstatic final StringThe payment log.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringThe submission reference/receipt number.static final Stringstatic final StringThe render mode to be used when rendering forms and receiptsstatic final StringA specific render mode indicating the form or receipt should be streamed back to the browser as a file rather than inlinestatic final StringThe form render servlet.static final Stringstatic final Stringstatic final StringThe form request save challenge parameter.static final StringThe form schema seed.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringThe form XML pre-population data.static final StringThe form XML pre-population data which has been URL encoded.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringThis will be used as the prefix for the actual session attribute for a specific form holding the version that was selected for rendering.static final String
-
Field Details
-
REQUEST_AUTO_SAVE_DISABLED
A flag for disabling autosave.- See Also:
-
REQUEST_CLIENT_CODE
The unique client code identifier.- See Also:
-
REQUEST_CLIENT_NAME
The client name.- See Also:
-
REQUEST_CLIENT_ID
The client id.- See Also:
-
REQUEST_DEVICE_TYPE
The form template device type.- See Also:
-
REQUEST_EntityId
The Entity ID parameter.- See Also:
-
REQUEST_ExternalId
The external account ID.- See Also:
-
REQUEST_ExternalUserId
The Web Plug-in external account ID.- See Also:
-
REQUEST_FormId
The unique form OID.- See Also:
-
REQUEST_FormCode
The unique form code identifier.- See Also:
-
REQUEST_FormStatus
The form status.- See Also:
-
REQUEST_FORM_VERSION
The form version number- See Also:
-
REQUEST_GLOBAL_FORM_FLAG
The global form flag- See Also:
-
REQUEST_PaymentLog
The payment log.- See Also:
-
REQUEST_XmlData
The form XML pre-population data.- See Also:
-
REQUEST_JsonPrefillData
The The Web Plug-in form JSON prefill data.- See Also:
-
REQUEST_XmlDataEncoded
The form XML pre-population data which has been URL encoded.- See Also:
-
REQUEST_ReferenceNumber
The submission reference/receipt number.- See Also:
-
REQUEST_RenderServlet
The form render servlet.- See Also:
-
REQUEST_SaveChallenge
The form request save challenge parameter.- See Also:
-
REQUEST_SchemaSeed
The form schema seed.- See Also:
-
REQUEST_HelpText
- See Also:
-
REQUEST_MESSAGE_KEY
The message key that is passed across for certain errors- See Also:
-
REQUEST_NoUserAccountPrefill
- See Also:
-
REQUEST_Parent
- See Also:
-
REQUEST_ParentId
- See Also:
-
REQUEST_Redirect
- See Also:
-
REQUEST_RedirectTarget
- See Also:
-
REQUEST_ReturnToForm
- See Also:
-
REQUEST_HostContext
- See Also:
-
REQUEST_Embed
- See Also:
-
REQUEST_RenderMode
The render mode to be used when rendering forms and receipts- See Also:
-
REQUEST_RenderHtml
- See Also:
-
REQUEST_Preview
- See Also:
-
REQUEST_RenderMode_File
A specific render mode indicating the form or receipt should be streamed back to the browser as a file rather than inline- See Also:
-
REQUEST_ClientKey
- See Also:
-
REQUEST_EmailKey
- See Also:
-
REQUEST_PaymentLogKey
- See Also:
-
REQUEST_RequestKey
- See Also:
-
REQUEST_submissionData
- See Also:
-
REQUEST_SubmissionDataXml
- See Also:
-
REQUEST_submissionRetryRequestLogKey
- See Also:
-
REQUEST_SubmitKey
- See Also:
-
REQUEST_TaskKey
- See Also:
-
REQUEST_TrackingCode
- See Also:
-
REQUEST_useCurrentVersion
- See Also:
-
REQUEST_UserKey
- See Also:
-
REQUEST_validationErrors
- See Also:
-
REQUEST_VERIFICATION_KEY
- See Also:
-
REQUEST_HEADER_ENVIRONMENTNAME
The header used by the FCIC to communicate the environment name- See Also:
-
SESSION_AccountLocked
- See Also:
-
SESSION_Flash
- See Also:
-
SESSION_FormCode
- See Also:
-
SESSION_FormName
- See Also:
-
SESSION_FormRequestParams
- See Also:
-
SESSION_FormTermsAccepted
- See Also:
-
SESSION_2FASetupProcessed
- See Also:
-
SESSION_Redirect
- See Also:
-
SESSION_ReferringUrl
- See Also:
-
SESSION_SELECTED_FORM_VERSION_PREFIX
This will be used as the prefix for the actual session attribute for a specific form holding the version that was selected for rendering. The actual attribute name is this prefix + the form code (exact implementation inFormService.getSelectedFormVersionAttributeName(com.avoka.fc.core.entity.Form) -
SESSION_submissionFailureData
- See Also:
-