Package de.xima.fc.form.render
Class FormRenderContextBuilder
- java.lang.Object
-
- de.xima.fc.form.render.FormRenderContextBuilder
-
public class FormRenderContextBuilder extends Object
Builder for creating an form-render-context.- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description FormRenderContextBuilder(long projektId, int formVersionNumber, Locale locale)
FormRenderContextBuilder(long projektId, int formVersionNumber, Locale locale, Benutzer benutzer)
Deprecated.FormRenderContextBuilder(long projektId, Integer formVersionNumber, Locale locale, Benutzer benutzer, String processId)
Deprecated.FormRenderContextBuilder(long projektId, Integer formVersionNumber, Locale locale, IUser user, String processId)
FormRenderContextBuilder(long projektId, Locale locale)
FormRenderContextBuilder(long projektId, Locale locale, Benutzer benutzer)
Deprecated.FormRenderContextBuilder(long projektId, Locale locale, Benutzer benutzer, String processId)
Deprecated.FormRenderContextBuilder(IFormRequestContext requestCtx)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IExtendedFormRenderContext
build(IExtendedFormRequestContext requestCtx)
builds anIExtendedFormRenderContext
based on the data of the builder and theIExtendedFormRequestContext
.IFormRenderContext
build(IFormRenderContext renderCtx)
builds theIFormRenderContext
based on the given builder data by loading all needed data from the master-server and sets them into the givenIFormRenderContext
IFormRenderContext
build(IFormRequestContext requestCtx)
builds anIFormRenderContext
based on the givenIFormRequestContext
.IFormRenderContext
build(IFormRequestContext requestCtx, XButtonDescriptor buttonDescriptor)
builds anIFormRenderContext
based on the givenIFormRequestContext
.IFormRenderContext
build(EFormRequestType requestType)
Builds anIFormRenderContext
with the default values for the given request type.IExtendedFormRenderContext
build(EFormRequestType requestType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
builds anIExtendedFormRenderContext
based on the data of the builder and the given parameters.Benutzer
getBenutzer()
Deprecated.Useuser
instead.Boolean
getCountFormCall()
Integer
getFormVersionNumber()
Locale
getLocale()
String
getProcessId()
long
getProjektId()
IXFormRenderConfig
getXFormConfig()
boolean
isExecutePreRenderer()
void
setBenutzer(Benutzer benutzer)
Deprecated.Useuser
instead.void
setCountFormCall(Boolean countFormCall)
void
setExecutePreRenderer(boolean executePreRenderer)
void
setFormVersionNumber(Integer formVersionNumber)
void
setLocale(Locale locale)
void
setProcessId(String processId)
void
setProjektId(Integer projektId)
void
setXFormConfig(IXFormRenderConfig xFormConfig)
-
-
-
Constructor Detail
-
FormRenderContextBuilder
public FormRenderContextBuilder(long projektId, int formVersionNumber, Locale locale)
- Parameters:
projektId
-Integer
the id of theProjekt
which should be renderdformVersionNumber
-Integer
the version-number of theFormVersion
which should be renderdlocale
-Locale
which should be used
-
FormRenderContextBuilder
public FormRenderContextBuilder(long projektId, Locale locale)
-
FormRenderContextBuilder
public FormRenderContextBuilder(IFormRequestContext requestCtx)
- Parameters:
requestCtx
-IFormRequestContext
which should be used for creating the builder
-
FormRenderContextBuilder
public FormRenderContextBuilder(long projektId, Integer formVersionNumber, Locale locale, IUser user, String processId)
- Parameters:
projektId
-Integer
the id of theProjekt
which should be renderdformVersionNumber
-Integer
the version-number of theFormVersion
which should be renderdlocale
-Locale
which should be useduser
-IUser
which should be usedprocessId
-String
the process-id of theVorgang
which should be rendered
-
FormRenderContextBuilder
@Deprecated public FormRenderContextBuilder(long projektId, int formVersionNumber, Locale locale, Benutzer benutzer)
Deprecated.
-
FormRenderContextBuilder
@Deprecated public FormRenderContextBuilder(long projektId, Locale locale, Benutzer benutzer)
Deprecated.
-
FormRenderContextBuilder
@Deprecated public FormRenderContextBuilder(long projektId, Locale locale, Benutzer benutzer, String processId)
Deprecated.
-
FormRenderContextBuilder
@Deprecated public FormRenderContextBuilder(long projektId, Integer formVersionNumber, Locale locale, Benutzer benutzer, String processId)
Deprecated.
-
-
Method Detail
-
build
public IExtendedFormRenderContext build(IExtendedFormRequestContext requestCtx) throws ContextBuilderException
builds anIExtendedFormRenderContext
based on the data of the builder and theIExtendedFormRequestContext
. Usesbuild(IFormRenderContext)
for loading the requested data.- Parameters:
requestCtx
-IExtendedFormRequestContext
with theHttpServletResponse
andHttpServletRequest
to use for theIExtendedFormRequestContext
- Returns:
- the created
IExtendedFormRenderContext
- Throws:
ContextBuilderException
- on errors while creating the context
-
build
public IExtendedFormRenderContext build(EFormRequestType requestType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws ContextBuilderException
builds anIExtendedFormRenderContext
based on the data of the builder and the given parameters. Usesbuild(IFormRenderContext)
for loading the requested data.- Parameters:
requestType
-EFormRequestType
of the render-requestrequest
-HttpServletRequest
the request to useresponse
-HttpServletResponse
the response to use- Returns:
- the created
IExtendedFormRenderContext
- Throws:
ContextBuilderException
- on errors while creating the context
-
build
public IFormRenderContext build(IFormRequestContext requestCtx) throws ContextBuilderException
builds anIFormRenderContext
based on the givenIFormRequestContext
. Usesbuild(IFormRenderContext)
for loading the requested data.- Parameters:
requestCtx
- theIFormRequestContext
to use- Returns:
- The new render context with the configured data.
- Throws:
ContextBuilderException
- on errors while creating the context
-
build
public IFormRenderContext build(IFormRequestContext requestCtx, XButtonDescriptor buttonDescriptor) throws ContextBuilderException
builds anIFormRenderContext
based on the givenIFormRequestContext
. Usesbuild(IFormRenderContext)
for loading the requested data.- Parameters:
requestCtx
- theIFormRequestContext
to usebuttonDescriptor
- theXButtonDescriptor
to use- Returns:
- The new render context with the configured data.
- Throws:
ContextBuilderException
- on errors while creating the context
-
build
public IFormRenderContext build(EFormRequestType requestType) throws ContextBuilderException
Builds anIFormRenderContext
with the default values for the given request type.- Parameters:
requestType
- theEFormRequestType
to use- Returns:
- A new form render context for the given request type.
- Throws:
ContextBuilderException
- on errors while creating the context
-
build
public IFormRenderContext build(IFormRenderContext renderCtx) throws ContextBuilderException
builds theIFormRenderContext
based on the given builder data by loading all needed data from the master-server and sets them into the givenIFormRenderContext
- Parameters:
renderCtx
-IFormRenderContext
for which the data should be loaded- Returns:
- the
IFormRenderContext
extended by the loaded data - Throws:
ContextBuilderException
- on errors while creating the context
-
getProjektId
public long getProjektId()
-
setProjektId
public void setProjektId(Integer projektId)
-
getFormVersionNumber
public Integer getFormVersionNumber()
-
setFormVersionNumber
public void setFormVersionNumber(Integer formVersionNumber)
-
getProcessId
public String getProcessId()
-
setProcessId
public void setProcessId(String processId)
-
getXFormConfig
public IXFormRenderConfig getXFormConfig()
-
setXFormConfig
public void setXFormConfig(IXFormRenderConfig xFormConfig)
-
getLocale
public Locale getLocale()
-
setLocale
public void setLocale(Locale locale)
-
isExecutePreRenderer
public boolean isExecutePreRenderer()
-
setExecutePreRenderer
public void setExecutePreRenderer(boolean executePreRenderer)
-
getCountFormCall
public Boolean getCountFormCall()
-
setCountFormCall
public void setCountFormCall(Boolean countFormCall)
-
getBenutzer
@Deprecated public Benutzer getBenutzer()
Deprecated.Useuser
instead.
-
setBenutzer
@Deprecated public void setBenutzer(Benutzer benutzer)
Deprecated.Useuser
instead.
-
-