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

Class JobProcessMessageService

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.JobProcessMessageService

All Implemented Interfaces:

IServiceDefinitionAware, IJobActionService

public class JobProcessMessageService
extends AbstractJobActionService

Provides a 'Job Processing Message' Action Service.

This service will add a submission processing status messages to the specified Submission. These appear in the user's submission history. This action service can be used anywhere in the job but is especially useful in an endpoint steps.
It can also send a status update via email

Configuration

Below is a list of the Job Action Properties which can be use to configure this step action.

Name	Description	Examples
Process Message Text	The submission processing status message text	{ "name": "Process Message Text", "value": "${formDataMap.name} your application has been approved" }
Process Message Submission	Specify the submission to update the processing status message on.	{ "name": "Process Message Submission", "value": "$func.startSubmission()" } { "name": "Process Message Submission", "value": "$funct.previousSubmission()" }
Process Message Submission Step	Specify the step name of the submission to update the processing status message on.	{ "name": "Process Message Submission Step", "value": "Application Start" }
Process Message Send Email	Specify whether to send an processing message email.	{ "name": "Process Message Send Email", "value": "true" }
Process Message Email To	Specify whether to send an processing message email. If not specified then the submissions contact email address will be used.	{ "name": "Process Message Email To", "value": "${formDataMap.email}" }
Process Message Email Subject Template	Specify an alternative email subject template to the default Form and Organization email template: 'Email Submission Status Subject'	{ "name": "Process Message Email Subject Template", "value": "Welcome Email Subject" }
Process Message Email Message Template	Specify an alternative email subject template to the default Form and Organization property email template: 'Email Submission Status Message'	{ "name": "Process Message Email Message Template", "value": "Welcome Email Message" }

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
JobProcessMessageService()

Method Summary

Modifier and Type	Method	Description
ActionResult	execute(ActionContext actionContext)	Execute the action and return the result.
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

JobProcessMessageService

public JobProcessMessageService()

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)