Package com.avoka.fc.core.service.submission

Class GroovySubmissionDataValidator

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.AbstractGroovyService

com.avoka.fc.core.service.submission.GroovySubmissionDataValidator

All Implemented Interfaces:

IServiceDefinitionAware, ISubmissionDataValidator, IUnitTestableService

public class GroovySubmissionDataValidator
extends AbstractGroovyService
implements ISubmissionDataValidator

Provides a Groovy script submission data validation service.

Since:

4.2.0

Constructor Summary

Constructors

Constructor	Description
GroovySubmissionDataValidator()

Method Summary

Modifier and Type	Method	Description
String	getErrorType()
List<String>	validateSubmission(HttpServletRequest request, Submission submission, String submissionXml)	Validate the submission's XML data, returning empty list if no errors or a list of errors message if validation failures occur.

Methods inherited from class com.avoka.fc.core.service.AbstractGroovyService

createExceptionAndLog, executeGroovyScript, executeGroovyScript, getCause, getExecutionTimeout, getGroovyScript, getGroovyServiceLog, getServiceDefinition, getServiceName, getServiceNameAndVersion, getServiceTimeout, getTestLogOutput, isExceptionDebugLoggingEnabled, isGroovyDebugLogging, isGroovyLoggingEnabled, isGroovyTypeChecked, runUnitTest, setExceptionDebugLoggingEnabled, setExecutionTimeout, setGroovyDebugLogging, setGroovyLoggingEnabled, setGroovyScript, setGroovyTypeChecked, setServiceDefinition, setUseModuleClassLoader

Methods inherited from class com.avoka.fc.core.service.BaseService

getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovySubmissionDataValidator

public GroovySubmissionDataValidator()

Method Detail

getErrorType

public String getErrorType()

Specified by:

getErrorType in class AbstractGroovyService

Returns:

the service error type to be used to classify the error logging records

Since:

4.3.4

validateSubmission

public List<String> validateSubmission(HttpServletRequest request,
                                       Submission submission,
                                       String submissionXml)

Validate the submission's XML data, returning empty list if no errors or a list of errors message if validation failures occur.

Specified by:

validateSubmission in interface ISubmissionDataValidator

Parameters:

request - the servlet request (required)

submission - the reference submission (required)

submissionXml - the submission form XML data (required)

Returns:

a list of data validation errors or an empty or null list if no errors occur

See Also:

ISubmissionDataValidator.validateSubmission(HttpServletRequest, Submission, String)