Package formflow.library

Class FormFlowController

java.lang.Object

formflow.library.FormFlowController

Direct Known Subclasses:

FileController, PdfController, ScreenController

public abstract class FormFlowController
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<FlowConfiguration>	flowConfigurations
static final String	SUBMISSION_MAP_NAME
protected final SubmissionRepositoryService	submissionRepositoryService
protected final UserFileRepositoryService	userFileRepositoryService

Method Summary

Modifier and Type	Method	Description
protected Boolean	doesFlowExist(String flow)
Submission	findOrCreateSubmission(jakarta.servlet.http.HttpSession httpSession, String flow)	If the submission information exists in the HttpSession, find it in the db.
protected FlowConfiguration	getFlowConfigurationByName(String flow)
protected Submission	getSubmissionFromSession(jakarta.servlet.http.HttpSession session, String flow)	This method will return a Submission that was referenced the HttpSession for a particular flow, if one exists.
static UUID	getSubmissionIdForFlow(jakarta.servlet.http.HttpSession session, String flow)	Returns the UUID of the Submission associated with the given flow.
protected Submission	saveToRepository(Submission submission)
protected Submission	saveToRepository(Submission submission, String subflowName)
protected void	setSubmissionInSession(jakarta.servlet.http.HttpSession session, Submission submission, String flow)
protected static void	throwNotFoundError(String flow, String screen, String message)

Methods inherited from class java.lang.Object

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

Field Details

submissionRepositoryService

protected final SubmissionRepositoryService submissionRepositoryService

userFileRepositoryService

protected final UserFileRepositoryService userFileRepositoryService

flowConfigurations

protected final List<FlowConfiguration> flowConfigurations

SUBMISSION_MAP_NAME

public static final String SUBMISSION_MAP_NAME

See Also:

• Constant Field Values

Method Details

saveToRepository

protected Submission saveToRepository(Submission submission)

saveToRepository

protected Submission saveToRepository(Submission submission,
 String subflowName)

getFlowConfigurationByName

protected FlowConfiguration getFlowConfigurationByName(String flow)

doesFlowExist

protected Boolean doesFlowExist(String flow)

throwNotFoundError

protected static void throwNotFoundError(String flow,
 String screen,
 String message)

findOrCreateSubmission

public Submission findOrCreateSubmission(jakarta.servlet.http.HttpSession httpSession,
 String flow)

If the submission information exists in the HttpSession, find it in the db. If a submission is not found, create a new one.

Parameters:

httpSession - The HttpSession to look in for information

flow - The name of the flow to retrieve data about

Returns:

Submission A Submission object from the database or a new one if one was not found

getSubmissionIdForFlow

public static UUID getSubmissionIdForFlow(jakarta.servlet.http.HttpSession session,
 String flow)

Returns the UUID of the Submission associated with the given flow.

Parameters:

session - The HttpSession the user is in

flow - The flow to look up the submission ID for

Returns:

The submission id if it exists for the given flow, else null

getSubmissionFromSession

protected Submission getSubmissionFromSession(jakarta.servlet.http.HttpSession session,
 String flow)

This method will return a Submission that was referenced the HttpSession for a particular flow, if one exists. If the session or now Submission exists, a null will be returned.

Parameters:

session - the HttpSession data will be looked for in

flow - the current flow to retrieve the Submission for

Returns:

Submission for the flow, if one exists, else null

setSubmissionInSession

protected void setSubmissionInSession(jakarta.servlet.http.HttpSession session,
 Submission submission,
 String flow)