Class FormRenderContextBuilder

java.lang.Object

de.xima.fc.form.render.FormRenderContextBuilder

public class FormRenderContextBuilder
extends Object

Builder for creating a 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

Modifier and Type	Method	Description
IExtendedFormRenderContext	build(IExtendedFormRequestContext requestCtx)	builds an IExtendedFormRenderContext based on the data of the builder and the IExtendedFormRequestContext.
IFormRenderContext	build(IFormRenderContext renderCtx)	Builds the IFormRenderContext based on the given builder data by loading all needed data from the master-server and sets them into the given IFormRenderContext
IFormRenderContext	build(IFormRequestContext requestCtx)	builds an IFormRenderContext based on the given IFormRequestContext.
IFormRenderContext	build(IFormRequestContext requestCtx, XButtonDescriptor buttonDescriptor)	builds an IFormRenderContext based on the given IFormRequestContext.
IFormRenderContext	build(EFormRequestType requestType)	Builds an IFormRenderContext with the default values for the given request type.
IExtendedFormRenderContext	build(EFormRequestType requestType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	builds an IExtendedFormRenderContext based on the data of the builder and the given parameters.
Benutzer	getBenutzer()	Deprecated. Use user instead.
Boolean	getCountFormCall()
Integer	getFormVersionNumber()
Locale	getLocale()
String	getProcessId()
long	getProjektId()
IXFormRenderConfig	getXFormConfig()
boolean	isExecutePreRenderer()
void	setBenutzer(Benutzer benutzer)	Deprecated. Use user 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	setXForm(IXForm xForm)	Sets the form descriptor, as configured in the form designer.
void	setXFormConfig(IXFormRenderConfig xFormConfig)

Methods inherited from class Object

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

Constructor Details

FormRenderContextBuilder

public FormRenderContextBuilder(long projektId,
 int formVersionNumber,
 Locale locale)

Parameters:

projektId - Integer the id of the Projekt which should be renderd

formVersionNumber - Integer the version-number of the FormVersion which should be renderd

locale - Locale which should be used

FormRenderContextBuilder

public FormRenderContextBuilder(long projektId,
 Locale locale)

Parameters:

projektId - Integer the id of the Projekt which should be renderd

locale - Locale which should be used

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 the Projekt which should be renderd

formVersionNumber - Integer the version-number of the FormVersion which should be renderd

locale - Locale which should be used

user - IUser which should be used

processId - String the process-id of the Vorgang 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 Details

build

public IExtendedFormRenderContext build(IExtendedFormRequestContext requestCtx)
                                 throws ContextBuilderException

builds an IExtendedFormRenderContext based on the data of the builder and the IExtendedFormRequestContext. Uses build(IFormRenderContext) for loading the requested data.

Parameters:

requestCtx - IExtendedFormRequestContext with the HttpServletResponse and HttpServletRequest to use for the IExtendedFormRequestContext

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 an IExtendedFormRenderContext based on the data of the builder and the given parameters. Uses build(IFormRenderContext) for loading the requested data.

Parameters:

requestType - EFormRequestType of the render-request

request - HttpServletRequest the request to use

response - 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 an IFormRenderContext based on the given IFormRequestContext. Uses build(IFormRenderContext) for loading the requested data.

Parameters:

requestCtx - the IFormRequestContext 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 an IFormRenderContext based on the given IFormRequestContext. Uses build(IFormRenderContext) for loading the requested data.

Parameters:

requestCtx - the IFormRequestContext to use

buttonDescriptor - the XButtonDescriptor 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 an IFormRenderContext with the default values for the given request type.

Parameters:

requestType - the EFormRequestType 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 the IFormRenderContext based on the given builder data by loading all needed data from the master-server and sets them into the given IFormRenderContext

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()

setXForm

public void setXForm(IXForm xForm)

Sets the form descriptor, as configured in the form designer. When not given, builds a form descriptor from the given parameters (the form version), loading data from the persistence layer. Can be used in case you wish to use a non-persisted form descriptor.

Parameters:

xForm - The form descriptor.

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.

Use user instead.

setBenutzer

@Deprecated
public void setBenutzer(Benutzer benutzer)

Deprecated.

Use user instead.