Package 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
-
-
-
Method Detail
-
getUserContext
UserContext getUserContext()
-
setUserContext
void setUserContext(UserContext userContext)
-
addPluginMeta
void addPluginMeta(String key, com.alibaba.fastjson.JSONObject value)
-
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)
-
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
@Deprecated Status getStatus()
Deprecated.UsegetWorkflowState()
and the new workflow engine.- Returns:
- A state of the form record to use for rendering the form.
-
getWorkflowState
WorkflowState getWorkflowState()
-
isUsesNewWorkflow
boolean isUsesNewWorkflow()
-
setStatus
@Deprecated void setStatus(Status status)
Deprecated.UsesetWorkflowState(WorkflowState)
and the new workflow engine.- Parameters:
A
- state of the form record to use for rendering the form.
-
setWorkflowState
void setWorkflowState(WorkflowState workflowState)
-
setUsesNewWorkflow
void setUsesNewWorkflow(boolean usesNewWorkflow)
-
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)
-
getDynContainerMap
Map<String,FormContainerMetaData> getDynContainerMap()
- Returns:
- A map between the name of a repeated container and its metadata. No mapping is present when the containeris not repeated.
-
setDynContainerMap
void setDynContainerMap(Map<String,FormContainerMetaData> fieldContainerMap)
- Parameters:
fieldContainerMap
- A map between the name of a form field and the (repetition) container that contains the form field. No mapping is present when the form field is not repeated.
-
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)
-
isHideRequiredHint
boolean isHideRequiredHint()
-
setHideRequiredHint
void setHideRequiredHint(boolean isHideRequiredHint)
-
getButtonDescriptor
XButtonDescriptor getButtonDescriptor()
-
setButtonDescriptor
void setButtonDescriptor(XButtonDescriptor buttonDescriptor)
-
buildXFormJSON
com.alibaba.fastjson.JSONObject buildXFormJSON() throws IOException, com.alibaba.fastjson.JSONException
builds theJSONObject
from the render-context- Returns:
- the created
JSONObject
- Throws:
IOException
- on errors while reading the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
buildXFormConfig
IXFormRenderConfig buildXFormConfig() throws IOException
builds theIXFormRenderConfig
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 theIXForm
from the context- Returns:
- the created
IXForm
- Throws:
IOException
- on errors while reading the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
render
String render() throws IOException, com.alibaba.fastjson.JSONException
renders the context and returns the result asString
- Returns:
- the rendered form as
String
- Throws:
IOException
- on errors while reading or rendering the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
render
void render(IExtendedFormRequestContext requestCtx) throws IOException, com.alibaba.fastjson.JSONException
renders the context to theHttpServletResponse
of the givenIExtendedFormRequestContext
- Parameters:
requestCtx
-IExtendedFormRequestContext
whichHttpServletResponse
should be used- Throws:
IOException
- on errors while reading or rendering the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
render
void render(javax.servlet.http.HttpServletResponse response) throws IOException, com.alibaba.fastjson.JSONException
renders the context to the givenHttpServletResponse
- Parameters:
response
-HttpServletResponse
which should be used- Throws:
IOException
- on errors while reading or rendering the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
getBenutzer
@Deprecated default Benutzer getBenutzer()
Deprecated.usegetUser()
-
setBenutzer
@Deprecated default void setBenutzer(Benutzer benutzer)
Deprecated.
-
getBenutzerGruppen
@Deprecated default List<BenutzerGruppe> getBenutzerGruppen()
Deprecated.usegetUserGroups()
-
setBenutzerGruppen
@Deprecated default void setBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen)
Deprecated.
-
getSessionAttributes
@Deprecated SessionAttributes getSessionAttributes()
Deprecated.
-
setSessionAttributes
@Deprecated void setSessionAttributes(SessionAttributes sessionAttributes)
Deprecated.
-
getRequestParameters
@Deprecated ParameterWrapper getRequestParameters()
Deprecated.
-
setRequestParameters
@Deprecated void setRequestParameters(ParameterWrapper requestParameters)
Deprecated.
-
getUrlParamMap
@Deprecated Map<String,List<String>> getUrlParamMap()
Deprecated.
-
getMandantJsResources
@Deprecated List<MandantRessource> getMandantJsResources()
Deprecated.
-
setMandantJsResources
@Deprecated void setMandantJsResources(List<MandantRessource> jsMandantResources)
Deprecated.
-
getMandantCssResources
@Deprecated List<MandantRessource> getMandantCssResources()
Deprecated.
-
setMandantCssResources
@Deprecated void setMandantCssResources(List<MandantRessource> cssMandantResources)
Deprecated.
-
getProjektJsResources
@Deprecated List<ProjektRessource> getProjektJsResources()
Deprecated.
-
setProjektJsResources
@Deprecated void setProjektJsResources(List<ProjektRessource> jsProjektResources)
Deprecated.
-
getProjektCssResources
@Deprecated List<ProjektRessource> getProjektCssResources()
Deprecated.
-
setProjektCssResources
@Deprecated void setProjektCssResources(List<ProjektRessource> cssProjektResources)
Deprecated.
-
getSystemPluginJsResources
@Deprecated List<IFormResource> getSystemPluginJsResources()
Deprecated.
-
setSystemPluginJsResources
@Deprecated void setSystemPluginJsResources(List<IFormResource> jsSystemPluginResources)
Deprecated.
-
getSystemPluginCssResources
@Deprecated List<IFormResource> getSystemPluginCssResources()
Deprecated.
-
setSystemPluginCssResources
@Deprecated void setSystemPluginCssResources(List<IFormResource> cssSystemPluginResources)
Deprecated.
-
getMandantPluginJsResources
@Deprecated List<IFormResource> getMandantPluginJsResources()
Deprecated.
-
setMandantPluginJsResources
@Deprecated void setMandantPluginJsResources(List<IFormResource> jsMandantPluginResources)
Deprecated.
-
getMandantPluginCssResources
@Deprecated List<IFormResource> getMandantPluginCssResources()
Deprecated.
-
setMandantPluginCssResources
@Deprecated void setMandantPluginCssResources(List<IFormResource> cssMandantPluginResources)
Deprecated.
-
getRequestContext
@Deprecated default String getRequestContext()
Deprecated.usegetBaseUrl()
-
setRequestContext
@Deprecated default void setRequestContext(String requestContext)
Deprecated.
-
-