Package com.avoka.fc.common

Interface Params

public interface Params

Defines parameters shared between the FC projects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUEST_AUTO_SAVE_DISABLED	A flag for disabling autosave.
static final String	REQUEST_CLIENT_CODE	The unique client code identifier.
static final String	REQUEST_CLIENT_ID	The client id.
static final String	REQUEST_CLIENT_NAME	The client name.
static final String	REQUEST_ClientKey
static final String	REQUEST_DEVICE_TYPE	The form template device type.
static final String	REQUEST_EmailKey
static final String	REQUEST_Embed
static final String	REQUEST_EntityId	The Entity ID parameter.
static final String	REQUEST_ExternalId	The external account ID.
static final String	REQUEST_ExternalUserId	The Web Plug-in external account ID.
static final String	REQUEST_FORM_VERSION	The form version number
static final String	REQUEST_FormCode	The unique form code identifier.
static final String	REQUEST_FormId	The unique form OID.
static final String	REQUEST_FormStatus	The form status.
static final String	REQUEST_GLOBAL_FORM_FLAG	The global form flag
static final String	REQUEST_HEADER_ENVIRONMENTNAME	The header used by the FCIC to communicate the environment name
static final String	REQUEST_HelpText
static final String	REQUEST_HostContext
static final String	REQUEST_JsonPrefillData	The The Web Plug-in form JSON prefill data.
static final String	REQUEST_MESSAGE_KEY	The message key that is passed across for certain errors
static final String	REQUEST_NoUserAccountPrefill
static final String	REQUEST_Parent
static final String	REQUEST_ParentId
static final String	REQUEST_PaymentLog	The payment log.
static final String	REQUEST_PaymentLogKey
static final String	REQUEST_Preview
static final String	REQUEST_Redirect
static final String	REQUEST_RedirectTarget
static final String	REQUEST_ReferenceNumber	The submission reference/receipt number.
static final String	REQUEST_RenderHtml
static final String	REQUEST_RenderMode	The render mode to be used when rendering forms and receipts
static final String	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
static final String	REQUEST_RenderServlet	The form render servlet.
static final String	REQUEST_RequestKey
static final String	REQUEST_ReturnToForm
static final String	REQUEST_SaveChallenge	The form request save challenge parameter.
static final String	REQUEST_SchemaSeed	The form schema seed.
static final String	REQUEST_submissionData
static final String	REQUEST_SubmissionDataXml
static final String	REQUEST_submissionRetryRequestLogKey
static final String	REQUEST_SubmitKey
static final String	REQUEST_TaskKey
static final String	REQUEST_TrackingCode
static final String	REQUEST_useCurrentVersion
static final String	REQUEST_UserKey
static final String	REQUEST_validationErrors
static final String	REQUEST_VERIFICATION_KEY
static final String	REQUEST_XmlData	The form XML pre-population data.
static final String	REQUEST_XmlDataEncoded	The form XML pre-population data which has been URL encoded.
static final String	SESSION_2FASetupProcessed
static final String	SESSION_AccountLocked
static final String	SESSION_Flash
static final String	SESSION_FormCode
static final String	SESSION_FormName
static final String	SESSION_FormRequestParams
static final String	SESSION_FormTermsAccepted
static final String	SESSION_Redirect
static final String	SESSION_ReferringUrl
static final String	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.
static final String	SESSION_submissionFailureData

Field Details

REQUEST_AUTO_SAVE_DISABLED

static final String REQUEST_AUTO_SAVE_DISABLED

A flag for disabling autosave.

See Also:

• Constant Field Values

REQUEST_CLIENT_CODE

static final String REQUEST_CLIENT_CODE

The unique client code identifier.

See Also:

• Constant Field Values

REQUEST_CLIENT_NAME

static final String REQUEST_CLIENT_NAME

The client name.

See Also:

• Constant Field Values

REQUEST_CLIENT_ID

static final String REQUEST_CLIENT_ID

The client id.

See Also:

• Constant Field Values

REQUEST_DEVICE_TYPE

static final String REQUEST_DEVICE_TYPE

The form template device type.

See Also:

• Constant Field Values

REQUEST_EntityId

static final String REQUEST_EntityId

The Entity ID parameter.

See Also:

• Constant Field Values

REQUEST_ExternalId

static final String REQUEST_ExternalId

The external account ID.

See Also:

• Constant Field Values

REQUEST_ExternalUserId

static final String REQUEST_ExternalUserId

The Web Plug-in external account ID.

See Also:

• Constant Field Values

REQUEST_FormId

static final String REQUEST_FormId

The unique form OID.

See Also:

• Constant Field Values

REQUEST_FormCode

static final String REQUEST_FormCode

The unique form code identifier.

See Also:

• Constant Field Values

REQUEST_FormStatus

static final String REQUEST_FormStatus

The form status.

See Also:

• Constant Field Values

REQUEST_FORM_VERSION

static final String REQUEST_FORM_VERSION

The form version number

See Also:

• Constant Field Values

REQUEST_GLOBAL_FORM_FLAG

static final String REQUEST_GLOBAL_FORM_FLAG

The global form flag

See Also:

• Constant Field Values

REQUEST_PaymentLog

static final String REQUEST_PaymentLog

The payment log.

See Also:

• Constant Field Values

REQUEST_XmlData

static final String REQUEST_XmlData

The form XML pre-population data.

See Also:

• Constant Field Values

REQUEST_JsonPrefillData

static final String REQUEST_JsonPrefillData

The The Web Plug-in form JSON prefill data.

See Also:

• Constant Field Values

REQUEST_XmlDataEncoded

static final String REQUEST_XmlDataEncoded

The form XML pre-population data which has been URL encoded.

See Also:

• Constant Field Values

REQUEST_ReferenceNumber

static final String REQUEST_ReferenceNumber

The submission reference/receipt number.

See Also:

• Constant Field Values

REQUEST_RenderServlet

static final String REQUEST_RenderServlet

The form render servlet.

See Also:

• Constant Field Values

REQUEST_SaveChallenge

static final String REQUEST_SaveChallenge

The form request save challenge parameter.

See Also:

• Constant Field Values

REQUEST_SchemaSeed

static final String REQUEST_SchemaSeed

The form schema seed.

See Also:

• Constant Field Values

REQUEST_HelpText

static final String REQUEST_HelpText

See Also:

• Constant Field Values

REQUEST_MESSAGE_KEY

static final String REQUEST_MESSAGE_KEY

The message key that is passed across for certain errors

See Also:

• Constant Field Values

REQUEST_NoUserAccountPrefill

static final String REQUEST_NoUserAccountPrefill

See Also:

• Constant Field Values

REQUEST_Parent

static final String REQUEST_Parent

See Also:

• Constant Field Values

REQUEST_ParentId

static final String REQUEST_ParentId

See Also:

• Constant Field Values

REQUEST_Redirect

static final String REQUEST_Redirect

See Also:

• Constant Field Values

REQUEST_RedirectTarget

static final String REQUEST_RedirectTarget

See Also:

• Constant Field Values

REQUEST_ReturnToForm

static final String REQUEST_ReturnToForm

See Also:

• Constant Field Values

REQUEST_HostContext

static final String REQUEST_HostContext

See Also:

• Constant Field Values

REQUEST_Embed

static final String REQUEST_Embed

See Also:

• Constant Field Values

REQUEST_RenderMode

static final String REQUEST_RenderMode

The render mode to be used when rendering forms and receipts

See Also:

• REQUEST_RenderMode_File
• Constant Field Values

REQUEST_RenderHtml

static final String REQUEST_RenderHtml

See Also:

• Constant Field Values

REQUEST_Preview

static final String REQUEST_Preview

See Also:

• Constant Field Values

REQUEST_RenderMode_File

static final String 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_RenderMode
• Constant Field Values

REQUEST_ClientKey

static final String REQUEST_ClientKey

See Also:

• Constant Field Values

REQUEST_EmailKey

static final String REQUEST_EmailKey

See Also:

• Constant Field Values

REQUEST_PaymentLogKey

static final String REQUEST_PaymentLogKey

See Also:

• Constant Field Values

REQUEST_RequestKey

static final String REQUEST_RequestKey

See Also:

• Constant Field Values

REQUEST_submissionData

static final String REQUEST_submissionData

See Also:

• Constant Field Values

REQUEST_SubmissionDataXml

static final String REQUEST_SubmissionDataXml

See Also:

• Constant Field Values

REQUEST_submissionRetryRequestLogKey

static final String REQUEST_submissionRetryRequestLogKey

See Also:

• Constant Field Values

REQUEST_SubmitKey

static final String REQUEST_SubmitKey

See Also:

• Constant Field Values

REQUEST_TaskKey

static final String REQUEST_TaskKey

See Also:

• Constant Field Values

REQUEST_TrackingCode

static final String REQUEST_TrackingCode

See Also:

• Constant Field Values

REQUEST_useCurrentVersion

static final String REQUEST_useCurrentVersion

See Also:

• Constant Field Values

REQUEST_UserKey

static final String REQUEST_UserKey

See Also:

• Constant Field Values

REQUEST_validationErrors

static final String REQUEST_validationErrors

See Also:

• Constant Field Values

REQUEST_VERIFICATION_KEY

static final String REQUEST_VERIFICATION_KEY

See Also:

• Constant Field Values

REQUEST_HEADER_ENVIRONMENTNAME

static final String REQUEST_HEADER_ENVIRONMENTNAME

The header used by the FCIC to communicate the environment name

See Also:

• Constant Field Values

SESSION_AccountLocked

static final String SESSION_AccountLocked

See Also:

• Constant Field Values

SESSION_Flash

static final String SESSION_Flash

See Also:

• Constant Field Values

SESSION_FormCode

static final String SESSION_FormCode

See Also:

• Constant Field Values

SESSION_FormName

static final String SESSION_FormName

See Also:

• Constant Field Values

SESSION_FormRequestParams

static final String SESSION_FormRequestParams

See Also:

• Constant Field Values

SESSION_FormTermsAccepted

static final String SESSION_FormTermsAccepted

See Also:

• Constant Field Values

SESSION_2FASetupProcessed

static final String SESSION_2FASetupProcessed

See Also:

• Constant Field Values

SESSION_Redirect

static final String SESSION_Redirect

See Also:

• Constant Field Values

SESSION_ReferringUrl

static final String SESSION_ReferringUrl

See Also:

• Constant Field Values

SESSION_SELECTED_FORM_VERSION_PREFIX

static final String 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 in FormService.getSelectedFormVersionAttributeName(com.avoka.fc.core.entity.Form)

SESSION_submissionFailureData

static final String SESSION_submissionFailureData

See Also:

• Constant Field Values