de.xima.fc.interfaces.form

Interface IFormRenderContext

All Superinterfaces:

Serializable

All Known Subinterfaces:

IExtendedFormRenderContext

All Known Implementing Classes:

ExtendedFormRenderContext, FD2RenderContext, FormRenderContext

public interface IFormRenderContext
extends Serializable

Context for rendering an form

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
void	addCustomNode(com.hp.gagawa.java.Node node)
void	addHiddenInputParameter(String key, String value)
void	addPluginMeta(String key, com.alibaba.fastjson.JSONObject value)
void	addProzessParameter(String key, List<String> value)
void	addRenderParameter(String key, List<String> value)
void	addUrlParameter(String key, List<String> value)
IXForm	buildXForm() builds the IXForm from the context
IXFormRenderConfig	buildXFormConfig() builds the IXFormRenderConfig from the context
com.alibaba.fastjson.JSONObject	buildXFormJSON() builds the JSONObject from the render-context
com.alibaba.fastjson.JSONObject	createUserDataJSON()
String	encodeURL(String url)
String	getBaseUrl()
default Benutzer	getBenutzer() Deprecated. use getUser()
default List<BenutzerGruppe>	getBenutzerGruppen() Deprecated. use getUserGroups()
Map<EFormResourceType,List<IFormResource>>	getClientPluginResourceMap()
List<IFormResource>	getClientPluginResources(EFormResourceType type)
Map<EFormResourceType,List<MandantRessource>>	getClientResourceMap()
List<MandantRessource>	getClientResources(EFormResourceType type)
List<com.hp.gagawa.java.Node>	getCustomNodes()
Map<String,List<String[]>>	getCustomValuesMap()
IFormRequestContext	getFormRequestContext()
List<Attachment>	getFormUploadList()
FormVersion	getFormVersion()
FRQSession	getFRQSession()
Map<String,String>	getHiddenInputParameter()
com.alibaba.fastjson.JSONObject	getI18nJSON()
Locale	getLocale()
Mandant	getMandant()
List<MandantRessource>	getMandantCssResources() Deprecated. use getClientResources(EFormResourceType)
List<MandantRessource>	getMandantJsResources() Deprecated. use getClientResources(EFormResourceType)
List<IFormResource>	getMandantPluginCssResources() Deprecated. use getClientPluginResources(EFormResourceType)
List<IFormResource>	getMandantPluginJsResources() Deprecated. use getClientPluginResources(EFormResourceType)
ParameterWrapper	getParameterWrapper()
Map<String,com.alibaba.fastjson.JSONObject>	getPluginMetaMap()
Map<EFormResourceType,List<ProjektRessource>>	getProjectResourceMap()
List<ProjektRessource>	getProjectResources(EFormResourceType type)
Projekt	getProjekt()
List<ProjektRessource>	getProjektCssResources() Deprecated. use getProjectResources(EFormResourceType)
List<ProjektRessource>	getProjektJsResources() Deprecated. use getProjectResources(EFormResourceType)
Map<String,List<String>>	getProzessParameter()
Map<String,List<String>>	getRenderParameter()
default String	getRequestContext() Deprecated. use getBaseUrl()
ParameterWrapper	getRequestParameters() Deprecated. use getParameterWrapper()
EFormRequestType	getRequestType()
XfcSession	getSession()
Map<String,Serializable>	getSessionAttributeMap()
SessionAttributes	getSessionAttributes() Deprecated. use getSessionAttributeMap()
String	getSessionID()
Status	getStatus()
String	getSubmitURL()
List<IFormResource>	getSystemPluginCssResources() Deprecated. use getSystemPluginResources(EFormResourceType)
List<IFormResource>	getSystemPluginJsResources() Deprecated. use getSystemPluginResources(EFormResourceType)
Map<EFormResourceType,List<IFormResource>>	getSystemPluginResourceMap()
List<IFormResource>	getSystemPluginResources(EFormResourceType type)
Textbaustein	getThemeTextbaustein()
Map<String,List<String>>	getUrlParameter()
Map<String,List<String>>	getUrlParamMap() Deprecated. use getUrlParameter()
Benutzer	getUser()
UserContext	getUserContext()
List<BenutzerGruppe>	getUserGroups()
org.pac4j.core.profile.CommonProfile	getUserProfile()
Map<String,List<String[]>>	getValuesMap()
Vorgang	getVorgang()
IXFormRenderConfig	getXFormConfig()
boolean	isExternal()
String	render() renders the context and returns the result as String
void	render(javax.servlet.http.HttpServletResponse response) renders the context to the given HttpServletResponse
void	render(IExtendedFormRequestContext requestCtx) renders the context to the HttpServletResponse of the given IExtendedFormRequestContext
void	setBaseUrl(String baseUrl)
default void	setBenutzer(Benutzer benutzer) Deprecated. use setUser(Benutzer)
default void	setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen) Deprecated. use setUserGroups(List)
void	setClientPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)
void	setClientPluginResources(EFormResourceType type, List<IFormResource> resources)
void	setClientResourceMap(Map<EFormResourceType,List<MandantRessource>> resMap)
void	setClientResources(EFormResourceType type, List<MandantRessource> resources)
void	setCustomNodes(List<com.hp.gagawa.java.Node> customNodes)
void	setCustomValuesMap(Map<String,List<String[]>> customValuesMap)
void	setExternal(boolean isExternal)
void	setFormRequestContext(IFormRequestContext requestCtx)
void	setFormUploadList(List<Attachment> formUploadList)
void	setFormVersion(FormVersion formVersion)
void	setFRQSession(FRQSession frqSession)
void	setHiddenInputParameters(Map<String,String> hiddenInputParameters)
void	setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson)
void	setLocale(Locale locale)
void	setMandant(Mandant mandant)
void	setMandantCssResources(List<MandantRessource> cssMandantResources) Deprecated. use setClientResources(EFormResourceType, List)
void	setMandantJsResources(List<MandantRessource> jsMandantResources) Deprecated. use setClientResources(EFormResourceType, List)
void	setMandantPluginCssResources(List<IFormResource> cssMandantPluginResources) Deprecated. use setClientPluginResources(EFormResourceType, List)
void	setMandantPluginJsResources(List<IFormResource> jsMandantPluginResources) Deprecated. use setClientPluginResources(EFormResourceType, List)
void	setParameterWrapper(ParameterWrapper parameterWrapper)
void	setPluginMetaMap(Map<String,com.alibaba.fastjson.JSONObject> pluginMetaMap)
void	setProjectResourceMap(Map<EFormResourceType,List<ProjektRessource>> resMap)
void	setProjectResources(EFormResourceType type, List<ProjektRessource> resources)
void	setProjekt(Projekt projekt)
void	setProjektCssResources(List<ProjektRessource> cssProjektResources) Deprecated. use setProjectResources(EFormResourceType, List)
void	setProjektJsResources(List<ProjektRessource> jsProjektResources) Deprecated. use setProjectResources(EFormResourceType, List)
void	setProzessParameter(Map<String,List<String>> prozessParameters)
void	setRenderParameter(Map<String,List<String>> renderParameters)
default void	setRequestContext(String requestContext) Deprecated. use setBaseUrl(String)
void	setRequestParameters(ParameterWrapper requestParameters) Deprecated. use setParameterWrapper(ParameterWrapper)
void	setRequestType(EFormRequestType requestType)
void	setSession(XfcSession session)
void	setSessionAttributeMap(Map<String,Serializable> sessionAttributes)
void	setSessionAttributes(SessionAttributes sessionAttributes) Deprecated. use setSessionAttributeMap(Map)
void	setSessionID(String sessionID)
void	setStatus(Status status)
void	setSubmitURL(String submitUrl)
void	setSystemPluginCssResources(List<IFormResource> cssSystemPluginResources) Deprecated. use setSystemPluginResources(EFormResourceType, List)
void	setSystemPluginJsResources(List<IFormResource> jsSystemPluginResources) Deprecated. use setSystemPluginResources(EFormResourceType, List)
void	setSystemPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)
void	setSystemPluginResources(EFormResourceType type, List<IFormResource> resources)
void	setThemeTextbaustein(Textbaustein themeTextbaustein)
void	setUrlParameter(Map<String,List<String>> urlParameter)
void	setUser(Benutzer user)
void	setUserContext(UserContext userContext)
void	setUserGroups(List<BenutzerGruppe> userGroups)
void	setUserProfile(org.pac4j.core.profile.CommonProfile profile)
void	setValuesMap(Map<String,List<String[]>> valuesMap)
void	setVorgang(Vorgang vorgang)
void	setXFormConfig(IXFormRenderConfig xFormConfig)

Method Detail

getUserContext

UserContext getUserContext()

setUserContext

void setUserContext(UserContext userContext)

getHiddenInputParameter

Map<String,String> getHiddenInputParameter()

addHiddenInputParameter

void addHiddenInputParameter(String key,
                             String value)

setHiddenInputParameters

void setHiddenInputParameters(Map<String,String> hiddenInputParameters)

getProzessParameter

Map<String,List<String>> getProzessParameter()

addProzessParameter

void addProzessParameter(String key,
                         List<String> value)

setProzessParameter

void setProzessParameter(Map<String,List<String>> prozessParameters)

getRenderParameter

Map<String,List<String>> getRenderParameter()

addRenderParameter

void addRenderParameter(String key,
                        List<String> value)

setRenderParameter

void setRenderParameter(Map<String,List<String>> renderParameters)

getUrlParameter

Map<String,List<String>> getUrlParameter()

addUrlParameter

void addUrlParameter(String key,
                     List<String> value)

setUrlParameter

void setUrlParameter(Map<String,List<String>> urlParameter)

getPluginMetaMap

Map<String,com.alibaba.fastjson.JSONObject> getPluginMetaMap()

addPluginMeta

void addPluginMeta(String key,
                   com.alibaba.fastjson.JSONObject value)

setPluginMetaMap

void setPluginMetaMap(Map<String,com.alibaba.fastjson.JSONObject> pluginMetaMap)

getCustomNodes

List<com.hp.gagawa.java.Node> getCustomNodes()

addCustomNode

void addCustomNode(com.hp.gagawa.java.Node node)

setCustomNodes

void setCustomNodes(List<com.hp.gagawa.java.Node> customNodes)

getFormUploadList

List<Attachment> getFormUploadList()

setFormUploadList

void setFormUploadList(List<Attachment> formUploadList)

getValuesMap

Map<String,List<String[]>> getValuesMap()

setValuesMap

void setValuesMap(Map<String,List<String[]>> valuesMap)

getCustomValuesMap

Map<String,List<String[]>> getCustomValuesMap()

setCustomValuesMap

void setCustomValuesMap(Map<String,List<String[]>> customValuesMap)

getFRQSession

FRQSession getFRQSession()

setFRQSession

void setFRQSession(FRQSession frqSession)

getSession

XfcSession getSession()

setSession

void setSession(XfcSession session)

getProjekt

Projekt getProjekt()

setProjekt

void setProjekt(Projekt projekt)

getFormVersion

FormVersion getFormVersion()

setFormVersion

void setFormVersion(FormVersion formVersion)

getUser

Benutzer getUser()

setUser

void setUser(Benutzer user)

getUserGroups

List<BenutzerGruppe> getUserGroups()

setUserGroups

void setUserGroups(List<BenutzerGruppe> userGroups)

getUserProfile

org.pac4j.core.profile.CommonProfile getUserProfile()

setUserProfile

void setUserProfile(org.pac4j.core.profile.CommonProfile profile)

createUserDataJSON

com.alibaba.fastjson.JSONObject createUserDataJSON()

getVorgang

Vorgang getVorgang()

setVorgang

void setVorgang(Vorgang vorgang)

getStatus

Status getStatus()

setStatus

void setStatus(Status status)

getMandant

Mandant getMandant()

setMandant

void setMandant(Mandant mandant)

getSessionAttributeMap

Map<String,Serializable> getSessionAttributeMap()

setSessionAttributeMap

void setSessionAttributeMap(Map<String,Serializable> sessionAttributes)

getLocale

Locale getLocale()

setLocale

void setLocale(Locale locale)

getBaseUrl

String getBaseUrl()

setBaseUrl

void setBaseUrl(String baseUrl)

getSessionID

String getSessionID()

setSessionID

void setSessionID(String sessionID)

getRequestType

EFormRequestType getRequestType()

setRequestType

void setRequestType(EFormRequestType requestType)

getSubmitURL

String getSubmitURL()

setSubmitURL

void setSubmitURL(String submitUrl)

isExternal

boolean isExternal()

setExternal

void setExternal(boolean isExternal)

getXFormConfig

IXFormRenderConfig getXFormConfig()

setXFormConfig

void setXFormConfig(IXFormRenderConfig xFormConfig)

getParameterWrapper

ParameterWrapper getParameterWrapper()

setParameterWrapper

void setParameterWrapper(ParameterWrapper parameterWrapper)

setI18nJSON

void setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson)

getI18nJSON

com.alibaba.fastjson.JSONObject getI18nJSON()

getThemeTextbaustein

Textbaustein getThemeTextbaustein()

setThemeTextbaustein

void setThemeTextbaustein(Textbaustein themeTextbaustein)

getFormRequestContext

IFormRequestContext getFormRequestContext()

setFormRequestContext

void setFormRequestContext(IFormRequestContext requestCtx)

getProjectResourceMap

Map<EFormResourceType,List<ProjektRessource>> getProjectResourceMap()

setProjectResourceMap

void setProjectResourceMap(Map<EFormResourceType,List<ProjektRessource>> resMap)

getProjectResources

List<ProjektRessource> getProjectResources(EFormResourceType type)

setProjectResources

void setProjectResources(EFormResourceType type,
                         List<ProjektRessource> resources)

getClientResourceMap

Map<EFormResourceType,List<MandantRessource>> getClientResourceMap()

setClientResourceMap

void setClientResourceMap(Map<EFormResourceType,List<MandantRessource>> resMap)

getClientResources

List<MandantRessource> getClientResources(EFormResourceType type)

setClientResources

void setClientResources(EFormResourceType type,
                        List<MandantRessource> resources)

getClientPluginResourceMap

Map<EFormResourceType,List<IFormResource>> getClientPluginResourceMap()

setClientPluginResourceMap

void setClientPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)

getClientPluginResources

List<IFormResource> getClientPluginResources(EFormResourceType type)

setClientPluginResources

void setClientPluginResources(EFormResourceType type,
                              List<IFormResource> resources)

getSystemPluginResourceMap

Map<EFormResourceType,List<IFormResource>> getSystemPluginResourceMap()

setSystemPluginResourceMap

void setSystemPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)

getSystemPluginResources

List<IFormResource> getSystemPluginResources(EFormResourceType type)

setSystemPluginResources

void setSystemPluginResources(EFormResourceType type,
                              List<IFormResource> resources)

encodeURL

String encodeURL(String url)

buildXFormJSON

com.alibaba.fastjson.JSONObject buildXFormJSON()
                                        throws IOException,
                                               com.alibaba.fastjson.JSONException

builds the JSONObject from the render-context

Returns:

the created JSONObject

Throws:

IOException - on errors while reading the form

com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject

buildXFormConfig

IXFormRenderConfig buildXFormConfig()
                             throws IOException

builds the IXFormRenderConfig from the context

Returns:

the created IXFormRenderConfig

Throws:

IOException - on errors while reading the form

buildXForm

IXForm buildXForm()
           throws IOException,
                  com.alibaba.fastjson.JSONException

builds the IXForm from the context

Returns:

the created IXForm

Throws:

IOException - on errors while reading the form

com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject

render

String render()
       throws IOException,
              com.alibaba.fastjson.JSONException

renders the context and returns the result as String

Returns:

the rendered form as String

Throws:

IOException - on errors while reading or rendering the form

com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject

render

void render(IExtendedFormRequestContext requestCtx)
     throws IOException,
            com.alibaba.fastjson.JSONException

renders the context to the HttpServletResponse of the given IExtendedFormRequestContext

Parameters:

requestCtx - IExtendedFormRequestContext which HttpServletResponse should be used

Throws:

IOException - on errors while reading or rendering the form

com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject

render

void render(javax.servlet.http.HttpServletResponse response)
     throws IOException,
            com.alibaba.fastjson.JSONException

renders the context to the given HttpServletResponse

Parameters:

response - HttpServletResponse which should be used

Throws:

IOException - on errors while reading or rendering the form

com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject

getBenutzer

@Deprecated
default Benutzer getBenutzer()

Deprecated. use getUser()

setBenutzer

@Deprecated
default void setBenutzer(Benutzer benutzer)

Deprecated. use setUser(Benutzer)

getBenutzerGruppen

@Deprecated
default List<BenutzerGruppe> getBenutzerGruppen()

Deprecated. use getUserGroups()

setBenutzerGruppen

@Deprecated
default void setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)

Deprecated. use setUserGroups(List)

getSessionAttributes

@Deprecated
SessionAttributes getSessionAttributes()

Deprecated. use getSessionAttributeMap()

setSessionAttributes

@Deprecated
void setSessionAttributes(SessionAttributes sessionAttributes)

Deprecated. use setSessionAttributeMap(Map)

getRequestParameters

@Deprecated
ParameterWrapper getRequestParameters()

Deprecated. use getParameterWrapper()

setRequestParameters

@Deprecated
void setRequestParameters(ParameterWrapper requestParameters)

Deprecated. use setParameterWrapper(ParameterWrapper)

getUrlParamMap

@Deprecated
Map<String,List<String>> getUrlParamMap()

Deprecated. use getUrlParameter()

getMandantJsResources

@Deprecated
List<MandantRessource> getMandantJsResources()

Deprecated. use getClientResources(EFormResourceType)

setMandantJsResources

@Deprecated
void setMandantJsResources(List<MandantRessource> jsMandantResources)

Deprecated. use setClientResources(EFormResourceType, List)

getMandantCssResources

@Deprecated
List<MandantRessource> getMandantCssResources()

Deprecated. use getClientResources(EFormResourceType)

setMandantCssResources

@Deprecated
void setMandantCssResources(List<MandantRessource> cssMandantResources)

Deprecated. use setClientResources(EFormResourceType, List)

getProjektJsResources

@Deprecated
List<ProjektRessource> getProjektJsResources()

Deprecated. use getProjectResources(EFormResourceType)

setProjektJsResources

@Deprecated
void setProjektJsResources(List<ProjektRessource> jsProjektResources)

Deprecated. use setProjectResources(EFormResourceType, List)

getProjektCssResources

@Deprecated
List<ProjektRessource> getProjektCssResources()

Deprecated. use getProjectResources(EFormResourceType)

setProjektCssResources

@Deprecated
void setProjektCssResources(List<ProjektRessource> cssProjektResources)

Deprecated. use setProjectResources(EFormResourceType, List)

getSystemPluginJsResources

@Deprecated
List<IFormResource> getSystemPluginJsResources()

Deprecated. use getSystemPluginResources(EFormResourceType)

setSystemPluginJsResources

@Deprecated
void setSystemPluginJsResources(List<IFormResource> jsSystemPluginResources)

Deprecated. use setSystemPluginResources(EFormResourceType, List)

getSystemPluginCssResources

@Deprecated
List<IFormResource> getSystemPluginCssResources()

Deprecated. use getSystemPluginResources(EFormResourceType)

setSystemPluginCssResources

@Deprecated
void setSystemPluginCssResources(List<IFormResource> cssSystemPluginResources)

Deprecated. use setSystemPluginResources(EFormResourceType, List)

getMandantPluginJsResources

@Deprecated
List<IFormResource> getMandantPluginJsResources()

Deprecated. use getClientPluginResources(EFormResourceType)

setMandantPluginJsResources

@Deprecated
void setMandantPluginJsResources(List<IFormResource> jsMandantPluginResources)

Deprecated. use setClientPluginResources(EFormResourceType, List)

getMandantPluginCssResources

@Deprecated
List<IFormResource> getMandantPluginCssResources()

Deprecated. use getClientPluginResources(EFormResourceType)

setMandantPluginCssResources

@Deprecated
void setMandantPluginCssResources(List<IFormResource> cssMandantPluginResources)

Deprecated. use setClientPluginResources(EFormResourceType, List)

getRequestContext

@Deprecated
default String getRequestContext()

Deprecated. use getBaseUrl()

setRequestContext

@Deprecated
default void setRequestContext(String requestContext)

Deprecated. use setBaseUrl(String)