Package de.xima.fc.form.process

Class FormProcessContextBuilder

java.lang.Object

de.xima.fc.form.process.FormProcessContextBuilder

public class FormProcessContextBuilder
extends Object

Builder for creating an form-process-context.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormProcessContextBuilder(IFormRequestContext requestCtx)
FormProcessContextBuilder(IFormRequestContext requestCtx, boolean deleteVorgang)
FormProcessContextBuilder(IFormRequestContext requestCtx, boolean deleteVorgang, IFormRecordProvidingEvent providingEvent)
FormProcessContextBuilder(IFormRequestContext requestCtx, IFormRecordProvidingEvent providingEvent)

Method Summary

Modifier and Type	Method	Description
IFormProcessContext	build()	builds an IFormProcessContext based on the given IFormRequestContext of the builder
IExtendedFormProcessContext	build(IExtendedFormRequestContext requestCtx)	builds an IExtendedFormProcessContext based on the IFormRequestContext of the builder and the IExtendedFormRequestContext.
IFormProcessContext	build(IFormProcessContext processCtx)	Builds the IFormProcessContext based on the given builder data by loading all needed data from the master server and sets them into the given IFormProcessContext.
IExtendedFormProcessContext	build(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	builds an IExtendedFormProcessContext based on the IFormRequestContext of the builder and the given parameters.
IFormRequestContext	getRequestCtx()
boolean	isDeleteVorgang()
void	setDeleteVorgang(boolean deleteVorgang)
void	setFormRecordProvidingEvent(IFormRecordProvidingEvent providingEvent)
void	setRequestCtx(IFormRequestContext requestCtx)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormProcessContextBuilder

public FormProcessContextBuilder(IFormRequestContext requestCtx)

Parameters:

requestCtx - IFormRequestContext with the data to process

FormProcessContextBuilder

public FormProcessContextBuilder(IFormRequestContext requestCtx,
                                 boolean deleteVorgang)

Parameters:

requestCtx - IFormRequestContext with the data to process

deleteVorgang - Boolean if the Vorgang should be deleted after processing. (Default: false)

FormProcessContextBuilder

public FormProcessContextBuilder(IFormRequestContext requestCtx,
                                 IFormRecordProvidingEvent providingEvent)

Parameters:

requestCtx - IFormRequestContext with the data to process

providingEvent - a IFormRecordProvidingEvent or null

FormProcessContextBuilder

public FormProcessContextBuilder(IFormRequestContext requestCtx,
                                 boolean deleteVorgang,
                                 IFormRecordProvidingEvent providingEvent)

Parameters:

requestCtx - IFormRequestContext with the data to process

deleteVorgang - Boolean if the Vorgang should be deleted after processing. (Default: false)

providingEvent - a IFormRecordProvidingEvent or null

Method Detail

build

public IFormProcessContext build()
                          throws ContextBuilderException

builds an IFormProcessContext based on the given IFormRequestContext of the builder

Returns:

the created IFormProcessContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IExtendedFormProcessContext build(IExtendedFormRequestContext requestCtx)
                                  throws ContextBuilderException

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

Parameters:

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

Returns:

the created IExtendedFormRequestContext

Throws:

ContextBuilderException - on errors while creating the context

build

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

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

Parameters:

request - HttpServletRequest the request to use

response - HttpServletResponse the response to use

Returns:

the created IExtendedFormProcessContext

Throws:

ContextBuilderException - on errors while creating the context

build

public IFormProcessContext build(IFormProcessContext processCtx)
                          throws ContextBuilderException

Builds the IFormProcessContext based on the given builder data by loading all needed data from the master server and sets them into the given IFormProcessContext.

Parameters:

processCtx - IFormProcessContext for which the data should be loaded

Returns:

the IFormProcessContext extended by the loaded data

Throws:

ContextBuilderException - on errors while creating the context

getRequestCtx

public IFormRequestContext getRequestCtx()

setRequestCtx

public void setRequestCtx(IFormRequestContext requestCtx)

isDeleteVorgang

public boolean isDeleteVorgang()

setDeleteVorgang

public void setDeleteVorgang(boolean deleteVorgang)

setFormRecordProvidingEvent

public void setFormRecordProvidingEvent(IFormRecordProvidingEvent providingEvent)