de.xima.fc.form.request

Class FormRequestContext

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, Dresden - Michael Kohlsche - 17.03.2017

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Benutzer	benutzer
protected List<BenutzerGruppe>	benutzerGruppen
protected List<Postfach>	benutzerPostfaecher
protected ProjectDOIData	doubleOptInData
protected IFormDataAdapter	formData
protected FormVersion	formVersion
protected FrontendServer	frontendServer
protected FRQSession	frqSession
protected FrontendServer	fServer
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 Projekt	projekt
protected String	requestContext
protected EFormRequestType	requestType
protected Map<String,Serializable>	sessionAttributes
protected String	sessionId
protected UserContext	uc
protected Vorgang	vorgang
protected XfcSession	xfcSession

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormRequestContext(EFormRequestType requestType, UserContext uc)

Method Summary

Modifier and Type	Method and Description
List<BenutzerGruppe>	getBenutzerGruppen()
List<Postfach>	getBenutzerPostfaecher()
Benutzer	getCurrentBenutzer()
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 #getParsedSessionAttributes()
String	getSessionID()
UploadParameters	getUploadParameters()
Boolean	getUseCurrentFv()
UserContext	getUserContext()
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)
void	setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)
void	setBenutzerPostfaecher(List<Postfach> benutzerPostfaecher)
void	setBenutzerZugriffAllowed(boolean isBenutzerZugriffAllowed)
void	setCheckForm(boolean checkForm)
void	setContinueProcessing(boolean isContinueProcessing)
void	setCurrentBenutzer(Benutzer benutzer)
void	setDoubleOptInData(ProjectDOIData doubleOptInData)
void	setFormData(IFormDataAdapter formData)
void	setFormVersion(FormVersion formVersion)
void	setFrontendServer(FrontendServer frontendServer)
void	setFrontenServerAllowed(boolean isFrontendServerAllowed)
void	setFRQSession(FRQSession frqSession)
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 xfcSession)
void	setSessionAttributeMap(Map<String,Serializable> sessionAttributes)
void	setSessionAttributes(SessionAttributes sessionAttributes) Deprecated. use setSessionAttributeMap(Map)
void	setSessionID(String sessionID)
void	setUseCurrentFv(boolean isUseCurrentFv)
void	setUserContext(UserContext uc)
void	setVorgang(Vorgang vorgang)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

xfcSession

protected XfcSession xfcSession

frqSession

protected FRQSession frqSession

sessionId

protected String sessionId

requestContext

protected String requestContext

locale

protected Locale locale

mandant

protected Mandant mandant

formVersion

protected FormVersion formVersion

vorgang

protected Vorgang vorgang

projekt

protected Projekt projekt

doubleOptInData

protected ProjectDOIData doubleOptInData

benutzer

protected Benutzer benutzer

benutzerGruppen

protected List<BenutzerGruppe> benutzerGruppen

benutzerPostfaecher

protected List<Postfach> benutzerPostfaecher

frontendServer

protected FrontendServer frontendServer

formData

protected IFormDataAdapter formData

fServer

protected FrontendServer fServer

uc

protected UserContext uc

parameterWrapper

protected ParameterWrapper parameterWrapper

requestType

protected EFormRequestType requestType

sessionAttributes

protected Map<String,Serializable> sessionAttributes

isSaveOnly

protected boolean isSaveOnly

isResubmit

protected boolean isResubmit

isPreview

protected boolean isPreview

isReview

protected boolean isReview

isOldVersion

protected boolean isOldVersion

isRunWorkflow

protected boolean isRunWorkflow

See Also:

IFormRequestContext#isRunWorkflow()

isCheckForm

protected boolean isCheckForm

isUseCurrentFv

protected boolean isUseCurrentFv

isFrontendServerAllowed

protected boolean isFrontendServerAllowed

isBenutzerZugriffAllowed

protected boolean isBenutzerZugriffAllowed

isContinueProcessing

protected boolean isContinueProcessing

Constructor Detail

FormRequestContext

protected FormRequestContext(EFormRequestType requestType,
                             UserContext uc)
                      throws ContextBuilderException

Throws:

ContextBuilderException

Method Detail

getCurrentBenutzer

public Benutzer getCurrentBenutzer()

Specified by:

getCurrentBenutzer in interface IFormRequestContext

getFormData

public IFormDataAdapter getFormData()

Specified by:

getFormData in interface IFormRequestContext

setFormData

public void setFormData(IFormDataAdapter formData)

Specified by:

setFormData in interface IFormRequestContext

getFormVersion

public FormVersion getFormVersion()

Specified by:

getFormVersion in interface IFormRequestContext

getFrontendServer

public FrontendServer getFrontendServer()

Specified by:

getFrontendServer in interface IFormRequestContext

getFRQSession

public FRQSession getFRQSession()

Specified by:

getFRQSession in interface IFormRequestContext

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IFormRequestContext

getMandant

public Mandant getMandant()

Specified by:

getMandant in interface IFormRequestContext

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

getRequestContext

public String getRequestContext()

Specified by:

getRequestContext in interface IFormRequestContext

getRequestType

public EFormRequestType getRequestType()

Specified by:

getRequestType in interface IFormRequestContext

getSession

public XfcSession getSession()

Specified by:

getSession in interface IFormRequestContext

getSessionID

public String getSessionID()

Specified by:

getSessionID in interface IFormRequestContext

getUseCurrentFv

public Boolean getUseCurrentFv()

Specified by:

getUseCurrentFv in interface IFormRequestContext

getUserContext

public UserContext getUserContext()

Specified by:

getUserContext in interface IFormRequestContext

setUserContext

public void setUserContext(UserContext uc)

Specified by:

setUserContext in interface IFormRequestContext

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IFormRequestContext

isBenutzerZugriffAllowed

public boolean isBenutzerZugriffAllowed()

Specified by:

isBenutzerZugriffAllowed in interface IFormRequestContext

setBenutzerZugriffAllowed

public void setBenutzerZugriffAllowed(boolean isBenutzerZugriffAllowed)

Specified by:

setBenutzerZugriffAllowed in interface IFormRequestContext

isFrontendServerAllowed

public boolean isFrontendServerAllowed()

Specified by:

isFrontendServerAllowed in interface IFormRequestContext

setFrontenServerAllowed

public void setFrontenServerAllowed(boolean isFrontendServerAllowed)

Specified by:

setFrontenServerAllowed in interface IFormRequestContext

getBenutzerPostfaecher

public List<Postfach> getBenutzerPostfaecher()

Specified by:

getBenutzerPostfaecher in interface IFormRequestContext

setBenutzerPostfaecher

public void setBenutzerPostfaecher(List<Postfach> benutzerPostfaecher)

Specified by:

setBenutzerPostfaecher in interface IFormRequestContext

getBenutzerGruppen

public List<BenutzerGruppe> getBenutzerGruppen()

Specified by:

getBenutzerGruppen in interface IFormRequestContext

setBenutzerGruppen

public void setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)

Specified by:

setBenutzerGruppen 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

isCheckForm

public boolean isCheckForm()

Specified by:

isCheckForm in interface IFormRequestContext

isContinueProcessing

public boolean isContinueProcessing()

Specified by:

isContinueProcessing in interface IFormRequestContext

isOldVersion

public boolean isOldVersion()

Specified by:

isOldVersion in interface IFormRequestContext

isResubmit

public boolean isResubmit()

Specified by:

isResubmit in interface IFormRequestContext

isReview

public boolean isReview()

Specified by:

isReview in interface IFormRequestContext

isSaveOnly

public boolean isSaveOnly()

Specified by:

isSaveOnly in interface IFormRequestContext

setSaveOnly

public void setSaveOnly(boolean saveOnly)

Specified by:

setSaveOnly in interface IFormRequestContext

isUseCurrentFv

public boolean isUseCurrentFv()

Specified by:

isUseCurrentFv in interface IFormRequestContext

setAnonymize

public void setAnonymize(boolean anonymize)

Specified by:

setAnonymize in interface IFormRequestContext

setCheckForm

public void setCheckForm(boolean checkForm)

Specified by:

setCheckForm in interface IFormRequestContext

setContinueProcessing

public void setContinueProcessing(boolean isContinueProcessing)

Specified by:

setContinueProcessing in interface IFormRequestContext

setCurrentBenutzer

public void setCurrentBenutzer(Benutzer benutzer)

Specified by:

setCurrentBenutzer in interface IFormRequestContext

setFormVersion

public void setFormVersion(FormVersion formVersion)

Specified by:

setFormVersion in interface IFormRequestContext

setFrontendServer

public void setFrontendServer(FrontendServer frontendServer)

Specified by:

setFrontendServer in interface IFormRequestContext

setFRQSession

public void setFRQSession(FRQSession frqSession)

Specified by:

setFRQSession in interface IFormRequestContext

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface IFormRequestContext

setMandant

public void setMandant(Mandant mandant)

Specified by:

setMandant in interface IFormRequestContext

setOldVersion

public void setOldVersion(boolean isOldVersion)

Specified by:

setOldVersion in interface IFormRequestContext

setProjekt

public void setProjekt(Projekt projekt)

Specified by:

setProjekt in interface IFormRequestContext

setRequestContest

public void setRequestContest(String requestContext)

Specified by:

setRequestContest in interface IFormRequestContext

setRequestType

public void setRequestType(EFormRequestType requestType)

Specified by:

setRequestType in interface IFormRequestContext

setResubmit

public void setResubmit(boolean isResubmit)

Specified by:

setResubmit in interface IFormRequestContext

setReview

public void setReview(boolean isReview)

Specified by:

setReview in interface IFormRequestContext

isPreview

public boolean isPreview()

Specified by:

isPreview in interface IFormRequestContext

setPreview

public void setPreview(boolean isPreview)

Specified by:

setPreview in interface IFormRequestContext

setSessionID

public void setSessionID(String sessionID)

Specified by:

setSessionID in interface IFormRequestContext

setUseCurrentFv

public void setUseCurrentFv(boolean isUseCurrentFv)

Specified by:

setUseCurrentFv in interface IFormRequestContext

getValueParameters

public ValueParameters getValueParameters()

Specified by:

getValueParameters in interface IFormRequestContext

setVorgang

public void setVorgang(Vorgang vorgang)

Specified by:

setVorgang in interface IFormRequestContext

setSession

public void setSession(XfcSession xfcSession)

Specified by:

setSession in interface IFormRequestContext

setParameterWrapper

@Deprecated
public void setParameterWrapper(ParameterWrapper parameterWrapper)

Deprecated.

Specified by:

setParameterWrapper in interface IFormRequestContext

getUploadParameters

public UploadParameters getUploadParameters()

Specified by:

getUploadParameters in interface IFormRequestContext

toString

public String toString()

Overrides:

toString in class Object

getSessionAttributeMap

public Map<String,Serializable> getSessionAttributeMap()

Specified by:

getSessionAttributeMap in interface IFormRequestContext

setSessionAttributeMap

public void setSessionAttributeMap(Map<String,Serializable> sessionAttributes)

Specified by:

setSessionAttributeMap in interface IFormRequestContext

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated. use #getParsedSessionAttributes()

Specified by:

getSessionAttributes in interface IFormRequestContext

setSessionAttributes

@Deprecated
public void setSessionAttributes(SessionAttributes sessionAttributes)

Deprecated. use setSessionAttributeMap(Map)

Specified by:

setSessionAttributes in interface IFormRequestContext

loadUserData

public void loadUserData(FormUserRequestData userData)

Specified by:

loadUserData in interface IFormRequestContext

getDoubleOptInData

public ProjectDOIData getDoubleOptInData()

Specified by:

getDoubleOptInData in interface IFormRequestContext

setDoubleOptInData

public void setDoubleOptInData(ProjectDOIData doubleOptInData)

Specified by:

setDoubleOptInData in interface IFormRequestContext