Package de.xima.fc.form.persist

Class FormPersistContextBuilder

java.lang.Object

de.xima.fc.form.persist.FormPersistContextBuilder

public class FormPersistContextBuilder
extends Object

Builder for creating a form-persist-context.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormPersistContextBuilder(IFormRequestContext requestCtx, IXForm xform)

Method Summary

Modifier and Type	Method	Description
IFormPersistContext	build()	builds an IFormPersistContext based on the IFormRequestContext and the IXForm of the builder.
IExtendedFormPersistContext	build(IExtendedFormRequestContext requestCtx)	builds an IExtendedFormPersistContext based on the IFormRequestContext and the IXForm of the builder and the IExtendedFormRequestContext.
IFormPersistContext	build(IFormPersistContext persistCtx)	builds the IFormPersistContext based on the given builder data by loading all needed data from the master-server and sets them into the given IFormPersistContext
IExtendedFormPersistContext	build(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	builds an IExtendedFormPersistContext based on the IFormRequestContext and the IXForm of the builder and the given parameters.
IFormRequestContext	getRequestCtx()
IXForm	getXform()
boolean	isCorrection()
void	setCorrection(boolean correction)
void	setRequestCtx(IFormRequestContext requestCtx)
void	setXform(IXForm xform)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormPersistContextBuilder

public FormPersistContextBuilder(IFormRequestContext requestCtx,
                                 IXForm xform)

Parameters:

requestCtx - IFormRequestContext with data to persist

xform - IXForm the form of the persist call

Method Detail

build

public IFormPersistContext build()
                          throws ContextBuilderException

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

Returns:

the created IExtendedFormPersistContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IExtendedFormPersistContext build(IExtendedFormRequestContext requestCtx)
                                  throws ContextBuilderException

builds an IExtendedFormPersistContext based on the IFormRequestContext and the IXForm of the builder and the IExtendedFormRequestContext. Uses build(IFormPersistContext) for loading the requested data.

Parameters:

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

Returns:

the created IExtendedFormPersistContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IExtendedFormPersistContext build(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws ContextBuilderException

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

Parameters:

request - HttpServletRequest the request to use

response - HttpServletResponse the response to use

Returns:

the created IExtendedFormPersistContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IFormPersistContext build(IFormPersistContext persistCtx)
                          throws ContextBuilderException

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

Parameters:

persistCtx - IFormPersistContext for which the data should be loaded

Returns:

the IFormPersistContext extended by the loaded data

Throws:

ContextBuilderException - on errors while creating the context

getRequestCtx

public IFormRequestContext getRequestCtx()

setRequestCtx

public void setRequestCtx(IFormRequestContext requestCtx)

getXform

public IXForm getXform()

setXform

public void setXform(IXForm xform)

setCorrection

public void setCorrection(boolean correction)

isCorrection

public boolean isCorrection()