Package com.avoka.fc.core.service

Interface FormPrefillService

All Known Implementing Classes:

FluentFormPrefillService, GroovyFormPrefillService

public interface FormPrefillService

Provides a service to get the form pre-population data for the given form and request.

Field Summary

Fields

Modifier and Type	Field	Description
static String	RUN_ON_SAVE_RESUME	The "Run On Save Resume" service parameter name.

Method Summary

Modifier and Type	Method	Description
IAuthenticationService	getAuthenticationService()	Return the authentication service for determining the authenticated user.
Object	getFormPrefillData(Form form, Document schemaSeed, HttpServletRequest request)	Return the form pre-population data for the given form, the schema seed and request.
void	setSubmission(Submission submission)	Optionally set the task submission record before the getFormPrefillData method is called.

Field Detail

RUN_ON_SAVE_RESUME

static final String RUN_ON_SAVE_RESUME

The "Run On Save Resume" service parameter name.

See Also:

Constant Field Values

Method Detail

getFormPrefillData

Object getFormPrefillData(Form form,
                          Document schemaSeed,
                          HttpServletRequest request)
                   throws RedirectException

Return the form pre-population data for the given form, the schema seed and request.

Parameters:

form - the get the pre-population data for

schemaSeed - the form schema seed XML

request - the form request

Returns:

the XML prefill data either a Document, String or null

Throws:

RedirectException - the redirect exception

setSubmission

void setSubmission(Submission submission)

Optionally set the task submission record before the getFormPrefillData method is called.

Parameters:

submission - the task submission record

Since:

4.0.0

getAuthenticationService

IAuthenticationService getAuthenticationService()

Return the authentication service for determining the authenticated user.

Returns:

the authentication service for determining the authenticated user