IFormRequestContext (FORMCYCLE: BOM 6.5.0 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

IExtendedFormRequestContext

All Known Implementing Classes:

ExtendedFormRequestContext, FormRequestContext
```
public interface IFormRequestContext
extends Serializable
```
A class with the relevant data of a form request, such as the current form or the authenticated user. A form request is any HTTP request regarding a form, such as an HTTP request (usually GET) that is made to get a new, empty form that can be filled out; or an HTTP request (usually POST) to submit the data from the filled-out form.

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`com.alibaba.fastjson.JSONObject`	`createUserDataJSON()`
`default List<BenutzerGruppe>`	`getBenutzerGruppen()` Deprecated. user `getUserGroups()`
`default List<Postfach>`	`getBenutzerPostfaecher()` Deprecated. use `getUserInboxes()`
`default Benutzer`	`getCurrentBenutzer()` Deprecated. user `getUser()`
`ProjectDOIData`	`getDoubleOptInData()`
`IFormDataAdapter`	`getFormData()`
`FormVersion`	`getFormVersion()`
`FrontendServer`	`getFrontendServer()`
`FRQSession`	`getFRQSession()`
`Locale`	`getLocale()`
`Mandant`	`getMandant()`
`ParameterWrapper`	`getParameterWrapper()` !
`Projekt`	`getProjekt()`
`String`	`getRequestContext()`
`EFormRequestType`	`getRequestType()`
`XfcSession`	`getSession()`
`Map<String,Serializable>`	`getSessionAttributeMap()`
`SessionAttributes`	`getSessionAttributes()` Deprecated. use `getSessionAttributeMap()`
`String`	`getSessionID()`
`UploadParameters`	`getUploadParameters()`
`Boolean`	`getUseCurrentFv()` Deprecated. use `isUseCurrentFv()`
`Benutzer`	`getUser()`
`UserContext`	`getUserContext()`
`List<BenutzerGruppe>`	`getUserGroups()`
`List<Postfach>`	`getUserInboxes()`
`org.pac4j.core.profile.CommonProfile`	`getUserProfile()`
`ValueParameters`	`getValueParameters()`
`Vorgang`	`getVorgang()`
`void`	`initFormData(ParameterWrapper rp)`
`boolean`	`isAnonymize()`
`boolean`	`isBenutzerZugriffAllowed()`
`boolean`	`isCheckForm()`
`boolean`	`isContinueProcessing()`
`boolean`	`isFrontendServerAllowed()`
`boolean`	`isOldVersion()`
`boolean`	`isPreview()`
`boolean`	`isResubmit()`
`boolean`	`isReview()`
`boolean`	`isSaveOnly()`
`boolean`	`isUseCurrentFv()`
`void`	`loadUserData(FormUserRequestData userData)`
`void`	`setAnonymize(boolean anonymize)`
`default void`	`setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)` Deprecated. user `setUserGroups(List)`
`default void`	`setBenutzerPostfaecher(List<Postfach> benutzerPostfaecher)` Deprecated. use `setUserInboxes(List)`
`void`	`setBenutzerZugriffAllowed(boolean isBenutzerZugriffAllowed)`
`void`	`setCheckForm(boolean checkForm)`
`void`	`setContinueProcessing(boolean continueProcessing)`
`default void`	`setCurrentBenutzer(Benutzer benutzer)` Deprecated. use `setUser(Benutzer)`
`void`	`setDoubleOptInData(ProjectDOIData projekt)`
`void`	`setFormData(IFormDataAdapter formData)`
`void`	`setFormVersion(FormVersion formVersion)`
`void`	`setFrontendServer(FrontendServer frontendServer)`
`void`	`setFrontenServerAllowed(boolean isFrontendServerAllowed)`
`void`	`setFRQSession(FRQSession formRequestSession)`
`void`	`setLocale(Locale locale)`
`void`	`setMandant(Mandant mandant)`
`void`	`setOldVersion(boolean isOldVersion)`
`void`	`setParameterWrapper(ParameterWrapper parameterWrapper)` Deprecated.
`void`	`setPreview(boolean isPreview)`
`void`	`setProjekt(Projekt projekt)`
`void`	`setRequestContest(String requestContext)`
`void`	`setRequestType(EFormRequestType requestType)`
`void`	`setResubmit(boolean isResubmit)`
`void`	`setReview(boolean isReview)`
`void`	`setSaveOnly(boolean saveOnly)`
`void`	`setSession(XfcSession session)`
`void`	`setSessionAttributeMap(Map<String,Serializable> attributes)`
`void`	`setSessionAttributes(SessionAttributes sessionAttributes)` Deprecated. use `setSessionAttributeMap(Map)`
`void`	`setSessionID(String sessionID)`
`void`	`setUseCurrentFv(boolean useCurrentFv)`
`void`	`setUser(Benutzer benutzer)`
`void`	`setUserContext(UserContext uc)`
`void`	`setUserGroups(List<BenutzerGruppe> userGroups)`
`void`	`setUserInboxes(List<Postfach> benutzerPostfaecher)`
`void`	`setUserProfile(org.pac4j.core.profile.CommonProfile userData)`
`void`	`setVorgang(Vorgang vorgang)`

- Method Detail
  - getUserContext
```
UserContext getUserContext()
```
    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
```
void setUserContext(UserContext uc)
```
  - getUser
```
Benutzer getUser()
```
    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
```
void setUser(Benutzer benutzer)
```
  - getUserProfile
```
org.pac4j.core.profile.CommonProfile getUserProfile()
```
  - setUserProfile
```
void setUserProfile(org.pac4j.core.profile.CommonProfile userData)
```
  - getProjekt
```
Projekt getProjekt()
```
    Returns:
    
    The Projekt which contains the form that was requested.
  - setProjekt
```
void setProjekt(Projekt projekt)
```
  - getDoubleOptInData
```
ProjectDOIData getDoubleOptInData()
```
    Returns:
    
    The double opt-in settings for the current form.
  - setDoubleOptInData
```
void setDoubleOptInData(ProjectDOIData projekt)
```
  - getMandant
```
Mandant getMandant()
```
    Returns:
    
    The Mandant to which the current form belongs to.
  - setMandant
```
void setMandant(Mandant mandant)
```
  - getFormVersion
```
FormVersion getFormVersion()
```
    Returns:
    
    The current FormVersion that was requested.
  - setFormVersion
```
void setFormVersion(FormVersion formVersion)
```
  - getFrontendServer
```
FrontendServer getFrontendServer()
```
    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.
  - setFrontendServer
```
void setFrontendServer(FrontendServer frontendServer)
```
  - getVorgang
```
Vorgang getVorgang()
```
    Returns:
    
    The current Vorgang when the form was submitted; or null when a new empty form was just requested.
  - setVorgang
```
void setVorgang(Vorgang vorgang)
```
  - getLocale
```
Locale getLocale()
```
    Returns:
    
    The current locale that is to be used for locale-dependent operations.
  - setLocale
```
void setLocale(Locale locale)
```
  - isUseCurrentFv
```
boolean isUseCurrentFv()
```
    Returns:
    
    true if the latest version of the form is to be used, false if a specific form version was requested.
  - setUseCurrentFv
```
void setUseCurrentFv(boolean useCurrentFv)
```
  - getRequestType
```
EFormRequestType getRequestType()
```
    Returns:
    
    The type of request that was made, eg. whether a new form was requested or a form was submitted.
  - setRequestType
```
void setRequestType(EFormRequestType requestType)
```
  - getSessionID
```
String getSessionID()
```
    Returns:
    
    The current HttpSession ID.
  - setSessionID
```
void setSessionID(String sessionID)
```
  - getRequestContext
```
String getRequestContext()
```
    Returns:
    
    The current context path of the application.
    
    See Also:
    
    HttpServletRequest.getContextPath()
  - setRequestContest
```
void setRequestContest(String requestContext)
```
  - getSessionAttributeMap
```
Map<String,Serializable> getSessionAttributeMap()
```
    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
```
void setSessionAttributeMap(Map<String,Serializable> attributes)
```
  - getSession
```
XfcSession getSession()
```
    Returns:
    
    The current FORMCYCLE session that contains additional information not contained in the HttpSession.
  - setSession
```
void setSession(XfcSession session)
```
  - getFRQSession
```
FRQSession getFRQSession()
```
    Returns:
    
    The current form request session. A form request session is opened each time a form is requested. A single getSession() may contain multiple FRQSessions.
  - setFRQSession
```
void setFRQSession(FRQSession formRequestSession)
```
  - isSaveOnly
```
boolean isSaveOnly()
```
  - setSaveOnly
```
void setSaveOnly(boolean saveOnly)
```
  - isReview
```
boolean isReview()
```
    Returns:
    
    true if a review was requested (when opening a form in the inbox), or false otherwise.
  - setReview
```
void setReview(boolean isReview)
```
  - isOldVersion
```
boolean isOldVersion()
```
    Returns:
    
    true if an old version was requested, or false otherwise.
  - setOldVersion
```
void setOldVersion(boolean isOldVersion)
```
  - isContinueProcessing
```
boolean isContinueProcessing()
```
    Returns:
    
    true if this form request should be processed further, or false to indicate that processing should be aborted.
  - setContinueProcessing
```
void setContinueProcessing(boolean continueProcessing)
```
  - isCheckForm
```
boolean isCheckForm()
```
    Returns:
    
    true to indicate the form should be validated on the server, or false otherwise.
  - setCheckForm
```
void setCheckForm(boolean checkForm)
```
  - isAnonymize
```
boolean isAnonymize()
```
    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.
  - setAnonymize
```
void setAnonymize(boolean anonymize)
```
  - isResubmit
```
boolean isResubmit()
```
    Returns:
    
    true when the form was not submitted for the first time and a Vorgang exists already, false otherwise.
  - setResubmit
```
void setResubmit(boolean isResubmit)
```
  - isPreview
```
boolean isPreview()
```
    Returns:
    
    true if a preview was requested, false otherwise.
  - setPreview
```
void setPreview(boolean isPreview)
```
  - getFormData
```
IFormDataAdapter getFormData()
```
    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
```
void setFormData(IFormDataAdapter formData)
```
  - initFormData
```
void initFormData(ParameterWrapper rp)
```
  - getParameterWrapper
```
ParameterWrapper getParameterWrapper()
```
    !READ-ONLY model of the parsed request parameters. To initialize data user initFormData(ParameterWrapper) or getFormData() and IFormDataAdapter.init(Map) or setFormData(IFormDataAdapter)
    
    Returns:
    
    ParameterWrapper
  - isBenutzerZugriffAllowed
```
boolean isBenutzerZugriffAllowed()
```
    Returns:
    
    true to indicate that the current Benutzer is allowed access to the request form, or false otherwise.
  - setBenutzerZugriffAllowed
```
void setBenutzerZugriffAllowed(boolean isBenutzerZugriffAllowed)
```
  - isFrontendServerAllowed
```
boolean isFrontendServerAllowed()
```
    Returns:
    
    true if the requested form may be served by the getFrontendServer(), or false otherwise.
  - setFrontenServerAllowed
```
void setFrontenServerAllowed(boolean isFrontendServerAllowed)
```
  - getUserInboxes
```
List<Postfach> getUserInboxes()
```
    Returns:
    
    A List of Postfachs which the current Benutzer can access.
  - setUserInboxes
```
void setUserInboxes(List<Postfach> benutzerPostfaecher)
```
  - getUserGroups
```
List<BenutzerGruppe> getUserGroups()
```
    Returns:
    
    A List of BenutzerGruppes to which the current Benutzer belongs to.
  - setUserGroups
```
void setUserGroups(List<BenutzerGruppe> userGroups)
```
  - createUserDataJSON
```
com.alibaba.fastjson.JSONObject createUserDataJSON()
```
  - getValueParameters
```
ValueParameters getValueParameters()
```
    Returns:
    
    All values that were submitted with this form request, ie. the values of the individual form elements. This excludes uploaded files, see getUploadParameters().
  - getUploadParameters
```
UploadParameters getUploadParameters()
```
    Returns:
    
    All files that were uploaded with this form request, usually via upload form elements.
  - loadUserData
```
void loadUserData(FormUserRequestData userData)
```
  - getBenutzerPostfaecher
```
@Deprecated
default List<Postfach> getBenutzerPostfaecher()
```
    Deprecated. use getUserInboxes()
  - setBenutzerPostfaecher
```
@Deprecated
default void setBenutzerPostfaecher(List<Postfach> benutzerPostfaecher)
```
    Deprecated. use setUserInboxes(List)
  - getBenutzerGruppen
```
@Deprecated
default List<BenutzerGruppe> getBenutzerGruppen()
```
    Deprecated. user getUserGroups()
  - setBenutzerGruppen
```
@Deprecated
default void setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)
```
    Deprecated. user setUserGroups(List)
  - getSessionAttributes
```
@Deprecated
SessionAttributes getSessionAttributes()
```
    Deprecated. use getSessionAttributeMap()
  - setSessionAttributes
```
@Deprecated
void setSessionAttributes(SessionAttributes sessionAttributes)
```
    Deprecated. use setSessionAttributeMap(Map)
  - setParameterWrapper
```
@Deprecated
void setParameterWrapper(ParameterWrapper parameterWrapper)
```
    Deprecated.
  - getCurrentBenutzer
```
@Deprecated
default Benutzer getCurrentBenutzer()
```
    Deprecated. user getUser()
    
    Returns:
    
    the current user
  - setCurrentBenutzer
```
@Deprecated
default void setCurrentBenutzer(Benutzer benutzer)
```
    Deprecated. use setUser(Benutzer)
    
    Parameters:
    
    benutzer - the user to set
  - getUseCurrentFv
```
@Deprecated
Boolean getUseCurrentFv()
```
    Deprecated. use isUseCurrentFv()

Interface IFormRequestContext

Method Summary

Method Detail

getUserContext

setUserContext

getUser

setUser

getUserProfile

setUserProfile

getProjekt

setProjekt

getDoubleOptInData

setDoubleOptInData

getMandant

setMandant

getFormVersion

setFormVersion

getFrontendServer

setFrontendServer

getVorgang

setVorgang

getLocale

setLocale

isUseCurrentFv

setUseCurrentFv

getRequestType

setRequestType

getSessionID

setSessionID

getRequestContext

setRequestContest

getSessionAttributeMap

setSessionAttributeMap

getSession

setSession

getFRQSession

setFRQSession

isSaveOnly

setSaveOnly

isReview

setReview

isOldVersion

setOldVersion

isContinueProcessing

setContinueProcessing

isCheckForm

setCheckForm

isAnonymize

setAnonymize

isResubmit

setResubmit

isPreview

setPreview

getFormData

setFormData

initFormData

getParameterWrapper

isBenutzerZugriffAllowed

setBenutzerZugriffAllowed

isFrontendServerAllowed

setFrontenServerAllowed

getUserInboxes

setUserInboxes

getUserGroups

setUserGroups

createUserDataJSON

getValueParameters

getUploadParameters

loadUserData

getBenutzerPostfaecher

setBenutzerPostfaecher

getBenutzerGruppen

setBenutzerGruppen

getSessionAttributes

setSessionAttributes

setParameterWrapper

getCurrentBenutzer

setCurrentBenutzer

getUseCurrentFv