Package com.avoka.fc.core.util

Class SubmissionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.avoka.fc.core.util.ApplicationException

com.avoka.fc.core.util.SubmissionException

All Implemented Interfaces:

Serializable

public class SubmissionException
extends ApplicationException

Provides a submission related exception storing the form and submitted data.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubmissionException(String name, String context, String userMessage, String solution, String formCode, Document formData, String helpText)	Create a SubmissionException object with the given parameters
SubmissionException(String name, Throwable cause, String context, String userMessage, String solution, String formCode, Document formData, String helpText)	Create a SubmissionException object with the given parameters

Method Summary

Modifier and Type	Method	Description
String	getFormCode()	Return the form code of the form used in submission.
Document	getFormData()	Return the submitted XML document
String	getHelpText()	Return additional help text related to the error
void	setFormCode(String newFormCode)	Set the form code of the form used in submission.
void	setFormData(Document newFormData)	Set the submitted XML document
void	setHelpText(String newHelpText)	Set additional help text related to the error
String	toString()	Return a String representation of the exception

Methods inherited from class com.avoka.fc.core.util.ApplicationException

getClient, getContext, getErrorLog, getFormXml, getGroovyServiceLog, getMessageKey, getName, getRequestKey, getSolution, getUserMessage, isLogToErrorLog, setClient, setContext, setErrorLog, setFormXml, setGroovyServiceLog, setLogToErrorLog, setMessageKey, setRequestKey, setSolution, setUserMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionException

public SubmissionException(String name,
                           Throwable cause,
                           String context,
                           String userMessage,
                           String solution,
                           String formCode,
                           Document formData,
                           String helpText)

Create a SubmissionException object with the given parameters

Parameters:

name - a name identifying the exception

cause - the Throwable causing the error

context - a message describing the context in which the error occurred

userMessage - a detail message about the error intended for the user

solution - an optional message outlining a solution to the problem

formCode - the form code of the form used during submission

formData - the XML data that was submitted

helpText - additional help text related to the error

SubmissionException

public SubmissionException(String name,
                           String context,
                           String userMessage,
                           String solution,
                           String formCode,
                           Document formData,
                           String helpText)

Create a SubmissionException object with the given parameters

Parameters:

name - a name identifying the exception

context - a message describing the context in which the error occurred

userMessage - a detail message about the error intended for the user

solution - an optional message outlining a solution to the problem

formCode - the form code of the form used during submission

formData - the XML data that was submitted

helpText - additional help text related to the error

Method Detail

getFormCode

public String getFormCode()

Return the form code of the form used in submission. If not set, the form code is retrieved from the submitted form data

Returns:

the form code

setFormCode

public void setFormCode(String newFormCode)

Set the form code of the form used in submission.

Parameters:

newFormCode - the new form code

getFormData

public Document getFormData()

Return the submitted XML document

Returns:

the XML document

setFormData

public void setFormData(Document newFormData)

Set the submitted XML document

Parameters:

newFormData - the XML document

getHelpText

public String getHelpText()

Return additional help text related to the error

Returns:

the help text

setHelpText

public void setHelpText(String newHelpText)

Set additional help text related to the error

Parameters:

newHelpText - the new help text

toString

public String toString()

Return a String representation of the exception

Overrides:

toString in class ApplicationException

Returns:

a String representation of the exception

See Also:

ApplicationException.toString()