Package com.avoka.fc.core.service.job.impl

Class JobDeliveryService

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.CayenneService

com.avoka.fc.core.service.job.impl.AbstractJobActionService

com.avoka.fc.core.service.job.impl.JobDeliveryService

All Implemented Interfaces:

IServiceDefinitionAware, IJobActionService

public class JobDeliveryService
extends AbstractJobActionService

Provides a 'Job Delivery' Action Service.

Configuration

Below is a list of the Job Step Custom Properties and Service Definition Parameters which can be use to configure this action step.

Name	Description	Examples
Delivery Channel Name	Specify delivery channel to use to delivery the form submission data	{ "name": "Delivery Channel Name", "value": "Customer Email Delivery" }
Delivery Mode	Specify which Job submissions to deliver [ 'Last Submission' | 'All Submissions' ]	{ "name": "Delivery Mode", "value": "Last Submission" }
Delivery Abandon Incomplete Forms	Specify whether to automatically abandon submission which are not completed [ 'true' | 'false']	{ "name": "Delivery Abandon Incomplete Forms", "value": "true" }

Since:

4.0.0

Field Summary

Fields inherited from class com.avoka.fc.core.service.job.impl.AbstractJobActionService

jobEventLogService, maxErrorRetryAttempts, retryDelayMins, serviceDefinition

Constructor Summary

Constructors

Constructor	Description
JobDeliveryService()

Method Summary

Modifier and Type	Method	Description
ActionResult	execute(ActionContext actionContext)	Execute the action and return the result.
protected DeliveryDetails	getDeliveryDetails(Submission submission, String deliveryDetailsName, JobAction jobAction)	Return the delivery details for the submission.
String	validateProperties(ActionStepProperties actionStepProperties, Client client)	Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.

Methods inherited from class com.avoka.fc.core.service.job.impl.AbstractJobActionService

getJobEventLogService, getMaxErrorRetryAttempts, getRetryDelayMins, getServiceDefinition, setMaxErrorRetryAttempts, setRetryDelayMins, setServiceDefinition

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

commitChanges, deleteObject, deleteObjects, findObject, getDataContext, getDataDomain, getObjectForPK, getObjectStore, newObject, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, refetchEntity, refetchObject, registerNewObject, rollbackChanges, toMap, toMap

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

JobDeliveryService

public JobDeliveryService()

Method Detail

execute

public ActionResult execute(ActionContext actionContext)

Description copied from interface: IJobActionService

Execute the action and return the result.

Parameters:

actionContext - the job action execution context (required)

Returns:

the action result

See Also:

IJobActionService.execute(ActionContext)

validateProperties

public String validateProperties(ActionStepProperties actionStepProperties,
                                 Client client)

Validate the action service using the given action step service properties, returning null if valid or an error string otherwise.

Specified by:

validateProperties in interface IJobActionService

Overrides:

validateProperties in class AbstractJobActionService

Parameters:

actionStepProperties - the action step properties (required)

client - the Job Controller client (optional)

Returns:

null if the properties are valid or null otherwise

See Also:

IJobActionService.validateProperties(ActionStepProperties, Client)

getDeliveryDetails

protected DeliveryDetails getDeliveryDetails(Submission submission,
                                             String deliveryDetailsName,
                                             JobAction jobAction)

Return the delivery details for the submission.

Parameters:

submission - the form submission (required)

deliveryDetailsName - the Job Action configured delivery details (optional)

jobAction - the job action (required)

Returns:

the resolved submission delivery details