Package de.xima.fc.form.request

Class FormRequestContextBuilder

java.lang.Object

de.xima.fc.form.request.FormRequestContextBuilder

public class FormRequestContextBuilder
extends Object

Builder for creating a form request context.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormRequestContextBuilder(long projektId, Integer formVersionNummer)
FormRequestContextBuilder(long projektId, Integer formVersionNummer, String prozessId)
FormRequestContextBuilder(long projektId, Integer formVersionNummer, String prozessId, Benutzer benutzer)	Deprecated. Use FormRequestContextBuilder(long, Integer, String, IUser) instead.
FormRequestContextBuilder(long projektId, Integer formVersionNummer, String prozessId, Benutzer benutzer, FrontendServer frontendServer)	Deprecated. Use FormRequestContextBuilder(long, Integer, String, IUser, FrontendServer) instead.
FormRequestContextBuilder(long projektId, Integer formVersionNummer, String prozessId, IUser user)
FormRequestContextBuilder(long projektId, Integer formVersionNummer, String prozessId, IUser user, FrontendServer frontendServer)

Method Summary

Modifier and Type	Method	Description
IFormRequestContext	build(IFormRequestContext requestCtx)	builds the IFormRequestContext based on the given builder data by loading all needed data from the master-server and sets them into the given IFormRequestContext
IFormRequestContext	build(EFormRequestType requestType)	builds an IFormRequestContext based on the data of the builder and the given parameters.
IExtendedFormRequestContext	build(EFormRequestType requestType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	builds an IExtendedFormRequestContext based on the data of the builder and the given parameters.
Benutzer	getBenutzer()	Deprecated. the current user will be determined from the web context (request, response)
Integer	getFormVersionNummer()
FrontendServer	getFrontendServer()
long	getProjektId()
String	getProzessId()
String	getVerifyId()
Boolean	isUseFormVersionByFormRecord()	Gets whether to use the form version of the form record.
boolean	isUseFormVersionByVorgang()	Deprecated.
void	setBenutzer(Benutzer benutzer)	Deprecated. Use setUser(IUser) instead.
void	setFormVersionNummer(Integer formVersionNummer)
void	setFrontendServer(FrontendServer frontendServer)
void	setProjektId(long projektId)
void	setProzessId(String prozessId)
void	setUseFormVersionByFormRecord(Boolean useFormVersionByFormRecord)	Sets whether to use the form version of the form record.
void	setUseFormVersionByVorgang(boolean useFormVersionByVorgang)	Deprecated.
void	setUser(IUser user)
void	setVerifyId(String verifyId)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormRequestContextBuilder

public FormRequestContextBuilder(long projektId,
                                 Integer formVersionNummer)

Parameters:

projektId - Integer id of the Projekt which should be loaded

formVersionNummer - Integer version-number of the FormVersion which should be loaded

FormRequestContextBuilder

public FormRequestContextBuilder(long projektId,
                                 Integer formVersionNummer,
                                 String prozessId)

Parameters:

projektId - Integer id of the Projekt which should be loaded

formVersionNummer - Integer version-number of the FormVersion which should be loaded

prozessId - String process-id of the Vorgang which should be loaded

FormRequestContextBuilder

public FormRequestContextBuilder(long projektId,
                                 Integer formVersionNummer,
                                 String prozessId,
                                 IUser user)

Parameters:

projektId - Integer id of the Projekt which should be loaded

formVersionNummer - Integer version-number of the FormVersion which should be loaded

prozessId - String process-id of the Vorgang which should be loaded

user - IUser which should be loaded

FormRequestContextBuilder

public FormRequestContextBuilder(long projektId,
                                 Integer formVersionNummer,
                                 String prozessId,
                                 IUser user,
                                 FrontendServer frontendServer)

Parameters:

projektId - Integer id of the Projekt which should be loaded

formVersionNummer - Integer version-number of the FormVersion which should be loaded

prozessId - String process-id of the Vorgang which should be loaded

user - IUser which should be loaded

frontendServer - FrontendServer on which the load-request is triggered

FormRequestContextBuilder

@Deprecated
public FormRequestContextBuilder(long projektId,
                                 Integer formVersionNummer,
                                 String prozessId,
                                 Benutzer benutzer)

Deprecated.

Use FormRequestContextBuilder(long, Integer, String, IUser) instead.

Parameters:

projektId - Integer id of the Projekt which should be loaded

formVersionNummer - Integer version-number of the FormVersion which should be loaded

prozessId - String process-id of the Vorgang which should be loaded

benutzer - Benutzer which should be loaded

FormRequestContextBuilder

@Deprecated
public FormRequestContextBuilder(long projektId,
                                 Integer formVersionNummer,
                                 String prozessId,
                                 Benutzer benutzer,
                                 FrontendServer frontendServer)

Deprecated.

Use FormRequestContextBuilder(long, Integer, String, IUser, FrontendServer) instead.

Parameters:

projektId - Integer id of the Projekt which should be loaded

formVersionNummer - Integer version-number of the FormVersion which should be loaded

prozessId - String process-id of the Vorgang which should be loaded

benutzer - Benutzer which should be loaded

frontendServer - FrontendServer on which the load-request is triggered

Method Detail

build

public IExtendedFormRequestContext build(EFormRequestType requestType,
                                         javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws ContextBuilderException

builds an IExtendedFormRequestContext based on the data of the builder and the given parameters. Uses build(IFormRequestContext) for loading the requested data.

Parameters:

requestType - EFormRequestType of the form-request

request - HttpServletRequest which should be used

response - HttpServletResponse which should be used

Returns:

the created IExtendedFormRequestContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IFormRequestContext build(EFormRequestType requestType)
                          throws ContextBuilderException

builds an IFormRequestContext based on the data of the builder and the given parameters. Uses build(IFormRequestContext) for loading the requested data.

Parameters:

requestType - EFormRequestType of the form-request

Returns:

the created IFormRequestContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IFormRequestContext build(IFormRequestContext requestCtx)
                          throws ContextBuilderException

builds the IFormRequestContext based on the given builder data by loading all needed data from the master-server and sets them into the given IFormRequestContext

Parameters:

requestCtx - IFormRequestContext for which the data should be loaded

Returns:

the IFormRequestContext extended by the loaded data

Throws:

ContextBuilderException - on errors while creating the context

getProjektId

public long getProjektId()

setProjektId

public void setProjektId(long projektId)

getFormVersionNummer

public Integer getFormVersionNummer()

setFormVersionNummer

public void setFormVersionNummer(Integer formVersionNummer)

getProzessId

public String getProzessId()

setProzessId

public void setProzessId(String prozessId)

getVerifyId

public String getVerifyId()

setVerifyId

public void setVerifyId(String verifyId)

isUseFormVersionByVorgang

@Deprecated(since="8.6.0")
public boolean isUseFormVersionByVorgang()

Deprecated.

setUseFormVersionByVorgang

@Deprecated(since="8.6.0")
public void setUseFormVersionByVorgang(boolean useFormVersionByVorgang)

Deprecated.

isUseFormVersionByFormRecord

public Boolean isUseFormVersionByFormRecord()

Gets whether to use the form version of the form record. When false, use either the configured form version, or the active form version of the project.

Returns:

Whether to use the form version of the form record.

Since:

8.6.0

setUseFormVersionByFormRecord

public void setUseFormVersionByFormRecord(Boolean useFormVersionByFormRecord)

Sets whether to use the form version of the form record. When false, use either the configured form version, or the active form version of the project.

Parameters:

useFormVersionByFormRecord - Whether to use the form version of the form record.

Since:

8.6.0

getFrontendServer

public FrontendServer getFrontendServer()

setFrontendServer

public void setFrontendServer(FrontendServer frontendServer)

setUser

public void setUser(IUser user)

getBenutzer

@Deprecated
public Benutzer getBenutzer()

Deprecated.

the current user will be determined from the web context (request, response)

setBenutzer

@Deprecated
public void setBenutzer(Benutzer benutzer)

Deprecated.

Use setUser(IUser) instead. Otherwise the current user will be determined from the web context (request, response)