java.lang.Object
- de.xima.fc.form.request.FormRequestContext

All Implemented Interfaces:

IFormRequestContext, Serializable

Direct Known Subclasses:

ExtendedFormRequestContext
```
public class FormRequestContext
extends Object
implements IFormRequestContext
```
Context of an form-request with all data for working with further contexts like IFormRenderContext, IFormPersistContext or IFormProcessContext

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`baseUrl`
`protected ProjectDOIData`	`doubleOptInData`
`protected IFormDataAdapter`	`formData`
`protected IFormRecordLockContext`	`formRecordLockContext`
`protected FormVersion`	`formVersion`
`protected FrontendServer`	`frontendServer`
`protected FRQSession`	`frqSession`
`protected Map<Serializable,Serializable>`	`frqSessionAttributes`
`protected String`	`fullRequestUrl`
`protected ProjectIdentityCheckData`	`identityCheckData`
`protected boolean`	`isBenutzerZugriffAllowed`
`protected boolean`	`isCheckForm`
`protected boolean`	`isContinueProcessing`
`protected boolean`	`isFrontendServerAllowed`
`protected boolean`	`isOldVersion`
`protected boolean`	`isPreview`
`protected boolean`	`isResubmit`
`protected boolean`	`isReview`
`protected boolean`	`isRunWorkflow`
`protected boolean`	`isSaveOnly`
`protected boolean`	`isUseCurrentFv`
`protected Locale`	`locale`
`protected static org.slf4j.Logger`	`LOG`
`protected Mandant`	`mandant`
`protected ParameterWrapper`	`parameterWrapper`
`protected boolean`	`previewWithoutSave`
`protected Projekt`	`projekt`
`protected EFormRequestType`	`requestType`
`protected boolean`	`rerenderAfterValidationFailed`
`protected Map<String,Serializable>`	`sessionAttributes`
`protected String`	`sessionId`
`protected Duration`	`sessionTimeout`
`protected boolean`	`skipSubmitButtonValidation`
`protected UserContext`	`uc`
`protected Benutzer`	`user`
`protected List<BenutzerGruppe>`	`userGroups`
`protected List<Postfach>`	`userInboxes`
`protected org.pac4j.core.profile.CommonProfile`	`userProfile`
`protected Vorgang`	`vorgang`
`protected WorkflowVersion`	`workflowVersion`
`protected XfcSession`	`xfcSession`

Constructor Summary

Constructors
Modifier Constructor Description

protected FormRequestContext(EFormRequestType requestType, UserContext uc)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`com.alibaba.fastjson.JSONObject`	`createUserDataJSON()`
`String`	`getBaseUrl()`
`ProjectDOIData`	`getDoubleOptInData()`
`IFormDataAdapter`	`getFormData()`
`IFormRecordLockContext`	`getFormRecordLockContext()`
`FormVersion`	`getFormVersion()`
`FrontendServer`	`getFrontendServer()`
`FRQSession`	`getFRQSession()`
`Map<Serializable,Serializable>`	`getFrqSessionAttributeMap()`
`String`	`getFullRequestUrl()`
`ProjectIdentityCheckData`	`getIdentityCheckData()`
`Locale`	`getLocale()`
`Mandant`	`getMandant()`
`ParameterWrapper`	`getParameterWrapper()`	!
`Projekt`	`getProjekt()`
`EFormRequestType`	`getRequestType()`
`XfcSession`	`getSession()`
`Map<String,Serializable>`	`getSessionAttributeMap()`
`SessionAttributes`	`getSessionAttributes()`	Deprecated. use `getSessionAttributeMap()`
`String`	`getSessionID()`
`Duration`	`getSessionTimeout()`
`UploadParameters`	`getUploadParameters()`
`Boolean`	`getUseCurrentFv()`
`Benutzer`	`getUser()`
`UserContext`	`getUserContext()`
`List<BenutzerGruppe>`	`getUserGroups()`
`List<Postfach>`	`getUserInboxes()`
`org.pac4j.core.profile.CommonProfile`	`getUserProfile()`
`ValueParameters`	`getValueParameters()`
`Vorgang`	`getVorgang()`
`WorkflowVersion`	`getWorkflowVersion()`
`void`	`initFormData(ParameterWrapper rp)`
`boolean`	`isAnonymize()`
`boolean`	`isBenutzerZugriffAllowed()`
`boolean`	`isCheckForm()`
`boolean`	`isContinueProcessing()`
`boolean`	`isFrontendServerAllowed()`
`boolean`	`isOldVersion()`
`boolean`	`isPreview()`
`boolean`	`isPreviewWithoutSave()`
`boolean`	`isRerenderAfterValidationFailed()`
`boolean`	`isResubmit()`
`boolean`	`isReview()`
`boolean`	`isSaveOnly()`
`boolean`	`isSkipSubmitButtonValidation()`
`boolean`	`isUseCurrentFv()`
`void`	`loadUserData(FormUserRequestData userData)`
`void`	`setAnonymize(boolean anonymize)`
`void`	`setBaseUrl(String baseUrl)`
`void`	`setBenutzerZugriffAllowed(boolean isBenutzerZugriffAllowed)`
`void`	`setCheckForm(boolean checkForm)`
`void`	`setContinueProcessing(boolean isContinueProcessing)`
`void`	`setDoubleOptInData(ProjectDOIData doubleOptInData)`
`void`	`setFormData(IFormDataAdapter formData)`
`void`	`setFormRecordLockContext(IFormRecordLockContext formRecordLockContext)`
`void`	`setFormVersion(FormVersion formVersion)`
`void`	`setFrontendServer(FrontendServer frontendServer)`
`void`	`setFrontenServerAllowed(boolean isFrontendServerAllowed)`
`void`	`setFRQSession(FRQSession frqSession)`
`void`	`setFullRequestUrl(String fullRequestUrl)`
`void`	`setIdentityCheckData(ProjectIdentityCheckData identityCheckData)`
`void`	`setLocale(Locale locale)`
`void`	`setMandant(Mandant mandant)`
`void`	`setOldVersion(boolean isOldVersion)`
`void`	`setParameterWrapper(ParameterWrapper parameterWrapper)`	Deprecated.
`void`	`setPreview(boolean isPreview)`
`void`	`setPreviewWithoutSave(boolean previewWithoutSave)`
`void`	`setProjekt(Projekt projekt)`
`void`	`setRequestType(EFormRequestType requestType)`
`void`	`setRerenderAfterValidationFailed(boolean rerenderAfterValidationFailed)`
`void`	`setResubmit(boolean isResubmit)`
`void`	`setReview(boolean isReview)`
`void`	`setSaveOnly(boolean saveOnly)`
`void`	`setSession(XfcSession xfcSession)`
`void`	`setSessionAttributeMap(Map<String,Serializable> sessionAttributes)`
`void`	`setSessionAttributes(SessionAttributes sessionAttributes)`	Deprecated. use `setSessionAttributeMap(Map)`
`void`	`setSessionID(String sessionID)`
`void`	`setSessionTimeout(Duration sessionTimeout)`
`void`	`setSkipSubmitButtonValidation(boolean skipSubmitButtonValidation)`
`void`	`setUseCurrentFv(boolean isUseCurrentFv)`
`void`	`setUser(Benutzer user)`
`void`	`setUserContext(UserContext uc)`
`void`	`setUserGroups(List<BenutzerGruppe> userGroups)`
`void`	`setUserInboxes(List<Postfach> userInboxes)`
`void`	`setUserProfile(org.pac4j.core.profile.CommonProfile userData)`
`void`	`setVorgang(Vorgang vorgang)`
`void`	`setWorkflowVersion(WorkflowVersion workflowVersion)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.form.IFormRequestContext
getBenutzerGruppen, getBenutzerPostfaecher, getCurrentBenutzer, getRequestContext, setBenutzerGruppen, setBenutzerPostfaecher, setCurrentBenutzer, setRequestContest, setRequestContext

- Field Detail
  - LOG
```
protected static final org.slf4j.Logger LOG
```
  - xfcSession
```
protected XfcSession xfcSession
```
  - frqSession
```
protected FRQSession frqSession
```
  - sessionId
```
protected String sessionId
```
  - baseUrl
```
protected String baseUrl
```
  - fullRequestUrl
```
protected String fullRequestUrl
```
  - locale
```
protected Locale locale
```
  - mandant
```
protected Mandant mandant
```
  - formVersion
```
protected FormVersion formVersion
```
  - workflowVersion
```
protected WorkflowVersion workflowVersion
```
  - vorgang
```
protected Vorgang vorgang
```
  - formRecordLockContext
```
protected IFormRecordLockContext formRecordLockContext
```
  - projekt
```
protected Projekt projekt
```
  - doubleOptInData
```
protected ProjectDOIData doubleOptInData
```
  - identityCheckData
```
protected ProjectIdentityCheckData identityCheckData
```
  - user
```
protected Benutzer user
```
  - userProfile
```
protected org.pac4j.core.profile.CommonProfile userProfile
```
  - userGroups
```
protected List<BenutzerGruppe> userGroups
```
  - userInboxes
```
protected List<Postfach> userInboxes
```
  - frontendServer
```
protected FrontendServer frontendServer
```
  - formData
```
protected IFormDataAdapter formData
```
  - uc
```
protected UserContext uc
```
  - parameterWrapper
```
protected ParameterWrapper parameterWrapper
```
  - requestType
```
protected EFormRequestType requestType
```
  - sessionAttributes
```
protected Map<String,Serializable> sessionAttributes
```
  - frqSessionAttributes
```
protected Map<Serializable,Serializable> frqSessionAttributes
```
  - sessionTimeout
```
protected Duration sessionTimeout
```
  - isSaveOnly
```
protected boolean isSaveOnly
```
  - isResubmit
```
protected boolean isResubmit
```
  - isPreview
```
protected boolean isPreview
```
  - isReview
```
protected boolean isReview
```
  - isOldVersion
```
protected boolean isOldVersion
```
  - previewWithoutSave
```
protected boolean previewWithoutSave
```
  - rerenderAfterValidationFailed
```
protected boolean rerenderAfterValidationFailed
```
  - isRunWorkflow
```
protected boolean isRunWorkflow
```
  - isCheckForm
```
protected boolean isCheckForm
```
  - isUseCurrentFv
```
protected boolean isUseCurrentFv
```
  - isFrontendServerAllowed
```
protected boolean isFrontendServerAllowed
```
  - isBenutzerZugriffAllowed
```
protected boolean isBenutzerZugriffAllowed
```
  - isContinueProcessing
```
protected boolean isContinueProcessing
```
  - skipSubmitButtonValidation
```
protected boolean skipSubmitButtonValidation
```
- Constructor Detail
  - FormRequestContext
```
protected FormRequestContext(EFormRequestType requestType,
                             UserContext uc)
                      throws ContextBuilderException
```
    Throws:
    
    ContextBuilderException
- Method Detail
  - getFormData
```
public IFormDataAdapter getFormData()
```
    Specified by:
    
    getFormData in interface IFormRequestContext
    
    Returns:
    
    An IFormDataAdapter that can be used to access the current form data, ie. the submitted or already present values for each form field.
  - setFormData
```
public void setFormData(IFormDataAdapter formData)
```
    Specified by:
    
    setFormData in interface IFormRequestContext
    
    Parameters:
    
    formData - An IFormDataAdapter that can be used to access the current form data, ie. the submitted or already present values for each form field.
  - getFormVersion
```
public FormVersion getFormVersion()
```
    Specified by:
    
    getFormVersion in interface IFormRequestContext
    
    Returns:
    
    The current FormVersion that was requested.
  - getWorkflowVersion
```
public WorkflowVersion getWorkflowVersion()
```
    Specified by:
    
    getWorkflowVersion in interface IFormRequestContext
    
    Returns:
    
    The current WorkflowVersion that was requested.
  - setFrontendServer
```
public void setFrontendServer(FrontendServer frontendServer)
```
    Specified by:
    
    setFrontendServer in interface IFormRequestContext
    
    Parameters:
    
    frontendServer - When the form request is made to a FrontendServer, that frontend server. Otherwise, when the form request is made directly to the master server, this return null.
  - getFrontendServer
```
public FrontendServer getFrontendServer()
```
    Specified by:
    
    getFrontendServer in interface IFormRequestContext
    
    Returns:
    
    When the form request is made to a FrontendServer, that frontend server. Otherwise, when the form request is made directly to the master server, this return null.
  - getFRQSession
```
public FRQSession getFRQSession()
```
    Specified by:
    
    getFRQSession in interface IFormRequestContext
    
    Returns:
    
    The current form request session. A form request session is opened each time a form is requested. A single IFormRequestContext.getSession() may contain multiple FRQSessions.
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface IFormRequestContext
    
    Returns:
    
    The current locale that is to be used for locale-dependent operations.
  - getMandant
```
public Mandant getMandant()
```
    Specified by:
    
    getMandant in interface IFormRequestContext
    
    Returns:
    
    The Mandant to which the current form belongs to.
  - getParameterWrapper
```
public ParameterWrapper getParameterWrapper()
```
    Description copied from interface: IFormRequestContext
    
    !READ-ONLY model of the parsed request parameters. To initialize data user IFormRequestContext.initFormData(ParameterWrapper) or IFormRequestContext.getFormData() and IFormDataAdapter.init(Map) or IFormRequestContext.setFormData(IFormDataAdapter)
    
    Specified by:
    
    getParameterWrapper in interface IFormRequestContext
    
    Returns:
    
    ParameterWrapper
  - getProjekt
```
public Projekt getProjekt()
```
    Specified by:
    
    getProjekt in interface IFormRequestContext
    
    Returns:
    
    The Projekt which contains the form that was requested.
  - getBaseUrl
```
public String getBaseUrl()
```
    Specified by:
    
    getBaseUrl in interface IFormRequestContext
    
    Returns:
    
    The base URL for this application, may not include the host.
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
    Specified by:
    
    setBaseUrl in interface IFormRequestContext
    
    Parameters:
    
    baseUrl - The base URL for this application, may not include the host.
  - getFullRequestUrl
```
public String getFullRequestUrl()
```
    Specified by:
    
    getFullRequestUrl in interface IFormRequestContext
    
    Returns:
    
    The full URL that was used to request the form, including all query params.
  - setFullRequestUrl
```
public void setFullRequestUrl(String fullRequestUrl)
```
    Specified by:
    
    setFullRequestUrl in interface IFormRequestContext
    
    Parameters:
    
    fullRequestUrl - The full URL that was used to request the form, including all query params.
  - getRequestType
```
public EFormRequestType getRequestType()
```
    Specified by:
    
    getRequestType in interface IFormRequestContext
    
    Returns:
    
    The type of request that was made, eg. whether a new form was requested or a form was submitted.
  - getSession
```
public XfcSession getSession()
```
    Specified by:
    
    getSession in interface IFormRequestContext
    
    Returns:
    
    The current FORMCYCLE session that contains additional information not contained in the HttpSession.
  - getSessionID
```
public String getSessionID()
```
    Specified by:
    
    getSessionID in interface IFormRequestContext
    
    Returns:
    
    The current HttpSession ID.
  - getUseCurrentFv
```
public Boolean getUseCurrentFv()
```
    Specified by:
    
    getUseCurrentFv in interface IFormRequestContext
  - getUserContext
```
public UserContext getUserContext()
```
    Specified by:
    
    getUserContext in interface IFormRequestContext
    
    Returns:
    
    The current user context that contains information about the user that is currently logged in. This context is also used when you would like to open a connection to the database.
  - setUserContext
```
public void setUserContext(UserContext uc)
```
    Specified by:
    
    setUserContext in interface IFormRequestContext
    
    Parameters:
    
    uc - The current user context that contains information about the user that is currently logged in. This context is also used when you would like to open a connection to the database.
  - getVorgang
```
public Vorgang getVorgang()
```
    Specified by:
    
    getVorgang in interface IFormRequestContext
    
    Returns:
    
    The current Vorgang when the form was submitted; or null when a new empty form was just requested. Note that this may not represent the current state of the form record: for example, when submitting a form and the workflow is run, the workflow might modify some data of the form record, this will not be reflected here.
  - getFormRecordLockContext
```
public IFormRecordLockContext getFormRecordLockContext()
```
    Specified by:
    
    getFormRecordLockContext in interface IFormRequestContext
    
    Returns:
    
    the form record locking context that is locking the form record of this request context
  - setFormRecordLockContext
```
public void setFormRecordLockContext(IFormRecordLockContext formRecordLockContext)
```
    Specified by:
    
    setFormRecordLockContext in interface IFormRequestContext
    
    Parameters:
    
    formRecordLockContext - the form record locking context that is locking the form record of this request context
  - isBenutzerZugriffAllowed
```
public boolean isBenutzerZugriffAllowed()
```
    Specified by:
    
    isBenutzerZugriffAllowed in interface IFormRequestContext
    
    Returns:
    
    true to indicate that the current Benutzer is allowed access to the request form, or false otherwise.
  - setBenutzerZugriffAllowed
```
public void setBenutzerZugriffAllowed(boolean isBenutzerZugriffAllowed)
```
    Specified by:
    
    setBenutzerZugriffAllowed in interface IFormRequestContext
    
    Parameters:
    
    isBenutzerZugriffAllowed - true to indicate that the current Benutzer is allowed access to the request form, or false otherwise.
  - isFrontendServerAllowed
```
public boolean isFrontendServerAllowed()
```
    Specified by:
    
    isFrontendServerAllowed in interface IFormRequestContext
    
    Returns:
    
    true if the requested form may be served by the IFormRequestContext.getFrontendServer(), or false otherwise.
  - setFrontenServerAllowed
```
public void setFrontenServerAllowed(boolean isFrontendServerAllowed)
```
    Specified by:
    
    setFrontenServerAllowed in interface IFormRequestContext
    
    Parameters:
    
    isFrontendServerAllowed - true if the requested form may be served by the IFormRequestContext.getFrontendServer(), or false otherwise.
  - getUserInboxes
```
public List<Postfach> getUserInboxes()
```
    Specified by:
    
    getUserInboxes in interface IFormRequestContext
    
    Returns:
    
    A List of Postfachs which the current Benutzer can access.
  - setUserInboxes
```
public void setUserInboxes(List<Postfach> userInboxes)
```
    Specified by:
    
    setUserInboxes in interface IFormRequestContext
    
    Parameters:
    
    userInboxes - A List of Postfachs which the current Benutzer can access.
  - getUserGroups
```
public List<BenutzerGruppe> getUserGroups()
```
    Specified by:
    
    getUserGroups in interface IFormRequestContext
    
    Returns:
    
    A List of BenutzerGruppes to which the current Benutzer belongs to.
  - setUserGroups
```
public void setUserGroups(List<BenutzerGruppe> userGroups)
```
    Specified by:
    
    setUserGroups in interface IFormRequestContext
    
    Parameters:
    
    userGroups - A List of BenutzerGruppes to which the current Benutzer belongs to.
  - createUserDataJSON
```
public com.alibaba.fastjson.JSONObject createUserDataJSON()
```
    Specified by:
    
    createUserDataJSON in interface IFormRequestContext
  - initFormData
```
public void initFormData(ParameterWrapper rp)
```
    Specified by:
    
    initFormData in interface IFormRequestContext
  - isAnonymize
```
public boolean isAnonymize()
```
    Specified by:
    
    isAnonymize in interface IFormRequestContext
    
    Returns:
    
    true to indicate the form submission should be made anonymously, or false otherwise. When the form is anonymized, no meta data is saved regarding the user who submitted the form.
  - isCheckForm
```
public boolean isCheckForm()
```
    Specified by:
    
    isCheckForm in interface IFormRequestContext
    
    Returns:
    
    true to indicate the form should be validated on the server, or false otherwise.
  - isContinueProcessing
```
public boolean isContinueProcessing()
```
    Specified by:
    
    isContinueProcessing in interface IFormRequestContext
    
    Returns:
    
    true if this form request should be processed further, or false to indicate that processing should be aborted.
  - isOldVersion
```
public boolean isOldVersion()
```
    Specified by:
    
    isOldVersion in interface IFormRequestContext
    
    Returns:
    
    true if an old version was requested, or false otherwise.
  - isResubmit
```
public boolean isResubmit()
```
    Specified by:
    
    isResubmit in interface IFormRequestContext
    
    Returns:
    
    true when the form was not submitted for the first time and a Vorgang exists already, false otherwise.
  - isReview
```
public boolean isReview()
```
    Specified by:
    
    isReview in interface IFormRequestContext
    
    Returns:
    
    true if a review was requested (when opening a form in the inbox), or false otherwise.
  - isSaveOnly
```
public boolean isSaveOnly()
```
    Specified by:
    
    isSaveOnly in interface IFormRequestContext
    
    Returns:
    
    true if a save button was used to submit the form. For the old workflow engine, this only saves the form data to the database and does not trigger the workflow. For the new workflow engine, the workflow is still processed, but the saved flag is set on the form record.
  - setSaveOnly
```
public void setSaveOnly(boolean saveOnly)
```
    Specified by:
    
    setSaveOnly in interface IFormRequestContext
    
    Parameters:
    
    saveOnly - true if a save button was used to submit the form. For the old workflow engine, this only saves the form data to the database and does not trigger the workflow. For the new workflow engine, the workflow is still processed, but the saved flag is set on the form record.
  - isUseCurrentFv
```
public boolean isUseCurrentFv()
```
    Specified by:
    
    isUseCurrentFv in interface IFormRequestContext
    
    Returns:
    
    true if the latest version of the form is to be used, false if a specific form version was requested.
  - isSkipSubmitButtonValidation
```
public boolean isSkipSubmitButtonValidation()
```
    Specified by:
    
    isSkipSubmitButtonValidation in interface IFormRequestContext
    
    Returns:
    
    When true, the xf-action is not checked for whether it represents a valid submit button.
  - setAnonymize
```
public void setAnonymize(boolean anonymize)
```
    Specified by:
    
    setAnonymize in interface IFormRequestContext
    
    Parameters:
    
    anonymize - true to indicate the form submission should be made anonymously, or false otherwise. When the form is anonymized, no meta data is saved regarding the user who submitted the form.
  - setCheckForm
```
public void setCheckForm(boolean checkForm)
```
    Specified by:
    
    setCheckForm in interface IFormRequestContext
    
    Parameters:
    
    checkForm - When true, the xf-action is not checked for whether it represents a valid submit button.
  - setContinueProcessing
```
public void setContinueProcessing(boolean isContinueProcessing)
```
    Specified by:
    
    setContinueProcessing in interface IFormRequestContext
    
    Parameters:
    
    isContinueProcessing - true if this form request should be processed further, or false to indicate that processing should be aborted.
  - getUser
```
public Benutzer getUser()
```
    Specified by:
    
    getUser in interface IFormRequestContext
    
    Returns:
    
    The user who is currently logged in and requested the form. In case the user is not logged in, this will be an anonymous user.
  - setUser
```
public void setUser(Benutzer user)
```
    Specified by:
    
    setUser in interface IFormRequestContext
    
    Parameters:
    
    user - The user who is currently logged in and requested the form. In case the user is not logged in, this will be an anonymous user.
  - setUserProfile
```
public void setUserProfile(org.pac4j.core.profile.CommonProfile userData)
```
    Specified by:
    
    setUserProfile in interface IFormRequestContext
  - getUserProfile
```
public org.pac4j.core.profile.CommonProfile getUserProfile()
```
    Specified by:
    
    getUserProfile in interface IFormRequestContext
  - setFormVersion
```
public void setFormVersion(FormVersion formVersion)
```
    Specified by:
    
    setFormVersion in interface IFormRequestContext
    
    Parameters:
    
    formVersion - The current FormVersion that was requested.
  - setWorkflowVersion
```
public void setWorkflowVersion(WorkflowVersion workflowVersion)
```
    Specified by:
    
    setWorkflowVersion in interface IFormRequestContext
    
    Parameters:
    
    workflowVersion - The current WorkflowVersion that was requested.
  - setFRQSession
```
public void setFRQSession(FRQSession frqSession)
```
    Specified by:
    
    setFRQSession in interface IFormRequestContext
    
    Parameters:
    
    frqSession - The current form request session. A form request session is opened each time a form is requested. A single IFormRequestContext.getSession() may contain multiple FRQSessions.
  - setLocale
```
public void setLocale(Locale locale)
```
    Specified by:
    
    setLocale in interface IFormRequestContext
    
    Parameters:
    
    locale - The current locale that is to be used for locale-dependent operations.
  - setMandant
```
public void setMandant(Mandant mandant)
```
    Specified by:
    
    setMandant in interface IFormRequestContext
    
    Parameters:
    
    mandant - The Mandant to which the current form belongs to.
  - setOldVersion
```
public void setOldVersion(boolean isOldVersion)
```
    Specified by:
    
    setOldVersion in interface IFormRequestContext
    
    Parameters:
    
    isOldVersion - true if an old version was requested, or false otherwise.
  - setProjekt
```
public void setProjekt(Projekt projekt)
```
    Specified by:
    
    setProjekt in interface IFormRequestContext
    
    Parameters:
    
    projekt - The Projekt which contains the form that was requested.
  - setRequestType
```
public void setRequestType(EFormRequestType requestType)
```
    Specified by:
    
    setRequestType in interface IFormRequestContext
    
    Parameters:
    
    requestType - The type of request that was made, eg. whether a new form was requested or a form was submitted.F
  - setResubmit
```
public void setResubmit(boolean isResubmit)
```
    Specified by:
    
    setResubmit in interface IFormRequestContext
    
    Parameters:
    
    isResubmit - true when the form was not submitted for the first time and a Vorgang exists already, false otherwise.
  - setReview
```
public void setReview(boolean isReview)
```
    Specified by:
    
    setReview in interface IFormRequestContext
    
    Parameters:
    
    isReview - true if a review was requested (when opening a form in the inbox), or false otherwise.
  - isPreview
```
public boolean isPreview()
```
    Specified by:
    
    isPreview in interface IFormRequestContext
    
    Returns:
    
    true if a preview was requested, false otherwise.
  - setPreview
```
public void setPreview(boolean isPreview)
```
    Specified by:
    
    setPreview in interface IFormRequestContext
    
    Parameters:
    
    isPreview - true if a preview was requested, false otherwise.
  - setSessionID
```
public void setSessionID(String sessionID)
```
    Specified by:
    
    setSessionID in interface IFormRequestContext
    
    Parameters:
    
    sessionID - The current HttpSession ID.
  - setSkipSubmitButtonValidation
```
public void setSkipSubmitButtonValidation(boolean skipSubmitButtonValidation)
```
    Specified by:
    
    setSkipSubmitButtonValidation in interface IFormRequestContext
    
    Parameters:
    
    skipSubmitButtonValidation - When true, the xf-action is not checked for whether it represents a valid submit button.
  - setUseCurrentFv
```
public void setUseCurrentFv(boolean isUseCurrentFv)
```
    Specified by:
    
    setUseCurrentFv in interface IFormRequestContext
    
    Parameters:
    
    isUseCurrentFv - true if the latest version of the form is to be used, false if a specific form version was requested.
  - getValueParameters
```
public ValueParameters getValueParameters()
```
    Specified by:
    
    getValueParameters in interface IFormRequestContext
    
    Returns:
    
    All values that were submitted with this form request, ie. the values of the individual form elements. This excludes uploaded files, see IFormRequestContext.getUploadParameters().
  - setVorgang
```
public void setVorgang(Vorgang vorgang)
```
    Specified by:
    
    setVorgang in interface IFormRequestContext
    
    Parameters:
    
    vorgang - The current Vorgang when the form was submitted; or null when a new empty form was just requested.
  - setSession
```
public void setSession(XfcSession xfcSession)
```
    Specified by:
    
    setSession in interface IFormRequestContext
    
    Parameters:
    
    xfcSession - The current FORMCYCLE session that contains additional information not contained in the HttpSession.
  - getUploadParameters
```
public UploadParameters getUploadParameters()
```
    Specified by:
    
    getUploadParameters in interface IFormRequestContext
    
    Returns:
    
    All files that were uploaded with this form request, usually via upload form elements.
  - isPreviewWithoutSave
```
public boolean isPreviewWithoutSave()
```
    Specified by:
    
    isPreviewWithoutSave in interface IFormRequestContext
    
    Returns:
    
    true if the workflow should be processed, but the form data should not be saved. Used e.g. for generating a PDF preview.
  - setPreviewWithoutSave
```
public void setPreviewWithoutSave(boolean previewWithoutSave)
```
    Specified by:
    
    setPreviewWithoutSave in interface IFormRequestContext
    
    Parameters:
    
    previewWithoutSave - true if the workflow should be processed, but the form data should not be saved. Used e.g. for generating a PDF preview.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getFrqSessionAttributeMap
```
public Map<Serializable,Serializable> getFrqSessionAttributeMap()
```
    Specified by:
    
    getFrqSessionAttributeMap in interface IFormRequestContext
    
    Returns:
    
    A Map of all key-value pairs in the current HttpSession. Please note that changes to this map will not affect the HttpSession.
  - getSessionAttributeMap
```
public Map<String,Serializable> getSessionAttributeMap()
```
    Specified by:
    
    getSessionAttributeMap in interface IFormRequestContext
    
    Returns:
    
    A Map of all key-value pairs in the current HttpSession. Please note that changes to this map will not affect the HttpSession.
  - setSessionAttributeMap
```
public void setSessionAttributeMap(Map<String,Serializable> sessionAttributes)
```
    Specified by:
    
    setSessionAttributeMap in interface IFormRequestContext
    
    Parameters:
    
    sessionAttributes - A Map of all key-value pairs in the current HttpSession. Please note that changes to this map will not affect the HttpSession.
  - getSessionTimeout
```
public Duration getSessionTimeout()
```
    Specified by:
    
    getSessionTimeout in interface IFormRequestContext
    
    Returns:
    
    The time it takes for an HTTP session on the server to timeout. This relates to the server which provided the form, the timeout may be different depending on the server.
  - setSessionTimeout
```
public void setSessionTimeout(Duration sessionTimeout)
```
    Specified by:
    
    setSessionTimeout in interface IFormRequestContext
    
    Parameters:
    
    sessionTimeout - The time it takes for an HTTP session on the server to timeout. This relates to the server which provided the form, the timeout may be different depending on the server.
  - loadUserData
```
public void loadUserData(FormUserRequestData userData)
```
    Specified by:
    
    loadUserData in interface IFormRequestContext
  - getDoubleOptInData
```
public ProjectDOIData getDoubleOptInData()
```
    Specified by:
    
    getDoubleOptInData in interface IFormRequestContext
    
    Returns:
    
    The double opt-in settings for the current form.
  - setDoubleOptInData
```
public void setDoubleOptInData(ProjectDOIData doubleOptInData)
```
    Specified by:
    
    setDoubleOptInData in interface IFormRequestContext
    
    Parameters:
    
    doubleOptInData - The double opt-in settings for the current form.
  - getIdentityCheckData
```
public ProjectIdentityCheckData getIdentityCheckData()
```
    Specified by:
    
    getIdentityCheckData in interface IFormRequestContext
    
    Returns:
    
    The identity check settings for the current form.
  - setIdentityCheckData
```
public void setIdentityCheckData(ProjectIdentityCheckData identityCheckData)
```
    Specified by:
    
    setIdentityCheckData in interface IFormRequestContext
    
    Parameters:
    
    identityCheckData - The identity check settings for the current form.
  - isRerenderAfterValidationFailed
```
public boolean isRerenderAfterValidationFailed()
```
    Specified by:
    
    isRerenderAfterValidationFailed in interface IFormRequestContext
  - setRerenderAfterValidationFailed
```
public void setRerenderAfterValidationFailed(boolean rerenderAfterValidationFailed)
```
    Specified by:
    
    setRerenderAfterValidationFailed in interface IFormRequestContext
  - setParameterWrapper
```
@Deprecated
public void setParameterWrapper(ParameterWrapper parameterWrapper)
```
    Deprecated.
    
    Specified by:
    
    setParameterWrapper in interface IFormRequestContext
  - getSessionAttributes
```
@Deprecated
public SessionAttributes getSessionAttributes()
```
    Deprecated.
    use getSessionAttributeMap()
    
    Specified by:
    
    getSessionAttributes in interface IFormRequestContext
  - setSessionAttributes
```
@Deprecated
public void setSessionAttributes(SessionAttributes sessionAttributes)
```
    Deprecated.
    use setSessionAttributeMap(Map)
    
    Specified by:
    
    setSessionAttributes in interface IFormRequestContext

Class FormRequestContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.xima.fc.interfaces.form.IFormRequestContext

Field Detail

LOG

xfcSession

frqSession

sessionId

baseUrl

fullRequestUrl

locale

mandant

formVersion

workflowVersion

vorgang

formRecordLockContext

projekt

doubleOptInData

identityCheckData

user

userProfile

userGroups

userInboxes

frontendServer

formData

uc

parameterWrapper

requestType

sessionAttributes

frqSessionAttributes

sessionTimeout

isSaveOnly

isResubmit

isPreview

isReview

isOldVersion

previewWithoutSave

rerenderAfterValidationFailed

isRunWorkflow

isCheckForm

isUseCurrentFv

isFrontendServerAllowed

isBenutzerZugriffAllowed

isContinueProcessing

skipSubmitButtonValidation

Constructor Detail

FormRequestContext

Method Detail

getFormData

setFormData

getFormVersion

getWorkflowVersion

setFrontendServer

getFrontendServer

getFRQSession

getLocale

getMandant

getParameterWrapper

getProjekt

getBaseUrl

setBaseUrl

getFullRequestUrl

setFullRequestUrl

getRequestType

getSession

getSessionID

getUseCurrentFv

getUserContext

setUserContext

getVorgang

getFormRecordLockContext

setFormRecordLockContext

isBenutzerZugriffAllowed

setBenutzerZugriffAllowed

isFrontendServerAllowed

setFrontenServerAllowed

getUserInboxes