Package com.avoka.fc.core.service.fluent

Class FluentDynamicDataService

java.lang.Object

com.avoka.fc.core.service.fluent.AbstractFluentService

com.avoka.fc.core.service.fluent.FluentDynamicDataService

All Implemented Interfaces:

IFluentService, IDynamicDataService, IServiceDefinitionAware, IUnitTestableService

public class FluentDynamicDataService
extends AbstractFluentService
implements IDynamicDataService

Provides a Fluent Groovy API Form Dynamic Data service.

Since:

5.0

Field Summary

Fields inherited from interface com.avoka.fc.core.service.fluent.IFluentService

PARAM_ACTION_PROPERTIES, PARAMS_FILEDATA, PARAMS_FILENAME, PARAMS_FORM, PARAMS_FORM_XML, PARAMS_FUNC_PARAM, PARAMS_JOB, PARAMS_JOB_ACTION, PARAMS_PARAMS, PARAMS_REQUEST, PARAMS_ROWS, PARAMS_SVC_DEF, PARAMS_TEST_PARAMS, PARAMS_TXN, PARAMS_USER

Constructor Summary

Constructors

Constructor	Description
FluentDynamicDataService()

Method Summary

Modifier and Type	Method	Description
String	getErrorType()
String	getEventLoggingLevel()	Return the Event Logging level [ "Info" | "Warning" | "Error" | "None" ].
String	getFormData(jakarta.servlet.http.HttpServletRequest request, Form form, Submission submission)	Return the dynamic form data for the request and form.
String	getResponseContentType()	Return the content type that shall be set on the response to the form.
boolean	isAllowCallsAfterSubmission()	Return whether dynamic data calls will be accepted after form submission
boolean	isInTestMode()	Return whether the service is currently in test mode.
void	setAllowCallsAfterSubmission(boolean allowCallsAfterSubmission)	Set whether dynamic data calls will be accepted after form submission
void	setResponseContentType(String responseContentType)	Set the desired content type of the response sent to the form.

Methods inherited from class com.avoka.fc.core.service.fluent.AbstractFluentService

createExceptionAndLog, getCause, getClient, getCommitChanges, getExecutionTimeout, getFunctionTrigger, getGroovyScript, getGroovyServiceLog, getLogger, getRequestUser, getServiceDefinition, getServiceNameAndVersion, getServiceTimeout, getSlf4jLogger, getTestLogOutput, invoke, isExceptionDebugLoggingEnabled, isGroovyDebugLogging, isGroovyLoggingEnabled, runUnitTest, setCommitChanges, setExceptionDebugLoggingEnabled, setExecutionTimeout, setGroovyDebugLogging, setGroovyLoggingEnabled, setGroovyScript, setLogger, setServiceDefinition

Methods inherited from class java.lang.Object

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

Constructor Details

FluentDynamicDataService

public FluentDynamicDataService()

Method Details

getFormData

public String getFormData(jakarta.servlet.http.HttpServletRequest request,
 Form form,
 Submission submission)

Return the dynamic form data for the request and form.

Specified by:

getFormData in interface IDynamicDataService

Parameters:

request - the AJAX form request (required)

form - the form which made the request (require)

submission - the form submission

Returns:

the dynamic form data (typically JSON)

See Also:

• IDynamicDataService.getFormData(HttpServletRequest, Form, com.avoka.fc.core.entity.Submission)

getErrorType

public String getErrorType()

Specified by:

getErrorType in interface IFluentService

Returns:

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

getResponseContentType

public String getResponseContentType()

Return the content type that shall be set on the response to the form.

Specified by:

getResponseContentType in interface IDynamicDataService

Returns:

the content type that shall be set on the response

See Also:

• IDynamicDataService.getResponseContentType()

setResponseContentType

public void setResponseContentType(String responseContentType)

Set the desired content type of the response sent to the form.

Parameters:

responseContentType - the content type

setAllowCallsAfterSubmission

public void setAllowCallsAfterSubmission(boolean allowCallsAfterSubmission)

Set whether dynamic data calls will be accepted after form submission

Parameters:

allowCallsAfterSubmission - a parameter determining whether dynamic data calls will be accepted after form submission

isAllowCallsAfterSubmission

public boolean isAllowCallsAfterSubmission()

Return whether dynamic data calls will be accepted after form submission

Specified by:

isAllowCallsAfterSubmission in interface IDynamicDataService

Returns:

true if dynamic data calls will be accepted after form submission

See Also:

• IDynamicDataService.isAllowCallsAfterSubmission()

isInTestMode

public boolean isInTestMode()

Description copied from interface: IDynamicDataService

Return whether the service is currently in test mode. This will cause certain security checks to be skipped.

Specified by:

isInTestMode in interface IDynamicDataService

Returns:

false

See Also:

• IDynamicDataService.isInTestMode()

getEventLoggingLevel

public String getEventLoggingLevel()

Description copied from interface: IDynamicDataService

Return the Event Logging level [ "Info" | "Warning" | "Error" | "None" ].

Specified by:

getEventLoggingLevel in interface IDynamicDataService

Returns:

"None"

See Also:

• IDynamicDataService.getEventLoggingLevel()