- All Superinterfaces:
com.avoka.fc.core.service.IServiceDefinitionAware
public interface IFluentFunction
extends com.avoka.fc.core.service.IServiceDefinitionAware
Provides a Fluent Function interface for executing server side Transact
Application logic.
- Since:
- 17.10.0
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type |
Method |
Description |
FuncResult |
execute(java.lang.String triggerType,
javax.servlet.http.HttpServletRequest request,
com.avoka.fc.core.entity.Submission submission,
java.util.Map<java.lang.String,java.lang.Object> params,
org.w3c.dom.Document formDoc,
org.apache.commons.fileupload.FileItem fileAttachment,
com.avoka.fc.core.entity.UserAccount userAccount)
|
Execute the Fluent function and return a func result object.
|
com.avoka.fc.core.entity.GroovyServiceLog |
getGroovyServiceLog() |
|
java.lang.Integer |
getMaxDeliveryAttempts() |
|
java.lang.Integer |
getRetryDelayMins() |
|
boolean |
isDeliveryFunction() |
|
boolean |
isFunctionDisabled() |
|
Methods inherited from
interface com.avoka.fc.core.service.IServiceDefinitionAware
getServiceDefinition, setServiceDefinition
Method Detail
execute
FuncResult execute(java.lang.String triggerType,
javax.servlet.http.HttpServletRequest request,
com.avoka.fc.core.entity.Submission submission,
java.util.Map<java.lang.String,java.lang.Object> params,
org.w3c.dom.Document formDoc,
org.apache.commons.fileupload.FileItem fileAttachment,
com.avoka.fc.core.entity.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
com.avoka.fc.core.entity.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
java.lang.Integer getMaxDeliveryAttempts()
- Returns:
-
the service definition maximum number of times a delivery function should be
attempted if an error occurs.
getRetryDelayMins
java.lang.Integer getRetryDelayMins()
- Returns:
- the service definition minimum retry delay in minutes