Package com.avoka.tm.func

Interface IFluentFunction

All Superinterfaces:

IServiceDefinitionAware

All Known Implementing Classes:

FluentFunctionService

public interface IFluentFunction
extends IServiceDefinitionAware

Provides a Fluent Function interface for executing server side Transact Application logic.

Since:

17.10.0

Method Summary

Modifier and Type	Method	Description
FuncResult	execute(String triggerType, HttpServletRequest request, Submission submission, Map<String,Object> params, Document formDoc, org.apache.commons.fileupload.FileItem fileAttachment, UserAccount userAccount)	Execute the Fluent function and return a func result object.
GroovyServiceLog	getGroovyServiceLog()
Integer	getMaxDeliveryAttempts()
Integer	getRetryDelayMins()
boolean	isDeliveryFunction()
boolean	isFunctionDisabled()

Methods inherited from interface com.avoka.fc.core.service.IServiceDefinitionAware

getServiceDefinition, setServiceDefinition

Method Detail

execute

FuncResult execute(String triggerType,
                   HttpServletRequest request,
                   Submission submission,
                   Map<String,Object> params,
                   Document formDoc,
                   org.apache.commons.fileupload.FileItem fileAttachment,
                   UserAccount userAccount)

Execute the Fluent function and return a func result object.

Parameters:

triggerType - the function trigger type

request - the servlet request

submission - the submission record

params - the request parameters

formDoc - the form XML data

fileAttachment - the uploaded file attachment

userAccount - the user account record

Returns:

the function result object

isDeliveryFunction

boolean isDeliveryFunction()

Returns:

true if the function is a Delivery Function

getGroovyServiceLog

GroovyServiceLog getGroovyServiceLog()

Returns:

the groovy service log generated when the function was executed or null otherwise.

isFunctionDisabled

boolean isFunctionDisabled()

Returns:

specify whether the function is disabled and should not be executed.

getMaxDeliveryAttempts

Integer getMaxDeliveryAttempts()

Returns:

the service definition maximum number of times a delivery function should be attempted if an error occurs.

getRetryDelayMins

Integer getRetryDelayMins()

Returns:

the service definition minimum retry delay in minutes